GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CHECK-MODULE-VERSION (1)

.ds Aq ’

NAME

check-module-version - Check module (e.g. check latest version) with CPAN (or equivalent repo)

CONTENTS

VERSION

This document describes version 0.07 of main (from Perl distribution Module-CheckVersion), released on 2016-03-16.

SYNOPSIS

Usage:



 % check-module-version [options] <module>



DESCRIPTION

Designed to be more general and able to provide more information in the future in addition to mere checking of latest version, but checking latest version is currently the only implemented feature.

Can handle non-CPAN modules, as long as you put the appropriate $AUTHORITY in your modules and create the Module::CheckVersion::<scheme> to handle your authority scheme.

OPTIONS

* marks required options.

    Output options

<B>--formatB>=s Choose output format, e.g. json, text.

Default value:



 undef



<B>--jsonB> Set output format to json.
<B>--naked-resB> When outputing as JSON, strip result envelope.

Default value:



 0



By default, when outputing as JSON, the full enveloped result is returned, e.g.:



    [200,"OK",[1,2,3],{"func.extra"=>4}]



The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use ‘--naked-res‘ so you just get:



    [1,2,3]



    Other options

<B>--default-authority-schemeB>=s Default value:



 "cpan"



If a module does not set ‘$AUTHORITY‘ (which contains string like ‘<scheme>:<extra>‘ like ‘cpan:PERLANCAR‘), the default authority scheme will be determined from this setting. The module ‘Module::CheckVersion::<scheme>‘ module is used to implement actual checking.

Can also be set to undef, in which case when module’s ‘$AUTHORITY‘ is not available, will return 412 status.

<B>--helpB>, <B>-hB>, <B>-?B> Display help message and exit.
<B>--moduleB>=s* This routine will try to load the module, and retrieve its ‘$VERSION‘. If loading fails will assume module’s installed version is undef.
<B>--no-check-latest-versionB>
<B>--versionB>, <B>-vB> Display program’s version and exit.

COMPLETION

The distribution comes with a shell completer script (_check-module-version) for this script.

    bash

To activate bash completion for this script, put:



 complete -C _check-module-version check-module-version



in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.

    tcsh

To activate tcsh completion for this script, put:



 complete _check-module-version p/*/`check-module-version`/



in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

    other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

Please visit the project’s homepage at <https://metacpan.org/release/Module-CheckVersion>.

SOURCE

Source repository is at <https://github.com/perlancar/perl-Module-CheckVersion>.

BUGS

Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Module-CheckVersion>

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Search for    or go to Top of page |  Section 1 |  Main Index


perl v5.20.3 CHECK-MODULE-VERSION (1) 2016-03-15

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.