Perinci::CmdLine::Help - Generate help message for Perinci::CmdLine-based app
This document describes version 0.11 of Perinci::CmdLine::Help (from Perl distribution Perinci-CmdLine-Help), released on 2016-09-28.
Currently used by Perinci::CmdLine::Lite and App::riap. Eventually I want Perinci::CmdLine to use this also (needs prettier and more sophisticated formatting options first though).
Generate help message for Perinci::CmdLine-based app.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
common_opts => hash (default: {})
meta* => hash
Function metadata, must be normalized.
per_arg_json => bool
per_arg_yaml => bool
program_name* => str
program_summary => str
subcommands => hash
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
Please visit the project's homepage at https://metacpan.org/release/Perinci-CmdLine-Help.
Source repository is at https://github.com/perlancar/perl-Perinci-CmdLine-Help.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-CmdLine-Help
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.
perlancar <perlancar@cpan.org>
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.
To install Perinci::CmdLine::Help, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perinci::CmdLine::Help
CPAN shell
perl -MCPAN -e shell install Perinci::CmdLine::Help
For more information on module installation, please visit the detailed CPAN module installation guide.