/ 
Perinci-CmdLine-POD-0.004
River stage one • 4 direct dependents • 7 total dependents
/ Perinci::CmdLine::POD

NAME

Perinci::CmdLine::POD - Generate POD for Perinci::CmdLine-based CLI script

VERSION

This document describes version 0.004 of Perinci::CmdLine::POD (from Perl distribution Perinci-CmdLine-POD), released on 2017-01-12.

SYNOPSIS

Please see the included CLI script gen-pod-for-pericmd-script.

FUNCTIONS

gen_pod_for_pericmd_script(%args) -> [status, msg, result, meta]

Generate POD for Perinci::CmdLine-based CLI script.

This utility can accept either a path to a Perinci::CmdLine-based CLI script, upon which the arguments to Perinci::CmdLine constructor will be extracted using a script dumper (Perinci::CmdLine::Dump), or a set of arguments to specify Perinci::CmdLine constructor arguments directly (e.g. url, summary, subcommands, etc).

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

  • common_opts => hash

  • completer_script => str

    Script name for shell completion.

    A special value of :self means this script can complete itself.

  • config_dirs => array[dirname]

  • config_filename => str|array[str]|array[hash]

  • default_subcommand => str

  • env_name => str

  • per_arg_json => bool (default: 1)

  • per_arg_yaml => bool (default: 1)

  • program_name => str

  • read_config => bool (default: 1)

  • read_env => bool (default: 1)

  • script => filename

    Path to script.

  • subcommands => hash

  • summary => str

  • url => str

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)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Perinci-CmdLine-POD.

SOURCE

Source repository is at https://github.com/perlancar/perl-Perinci-CmdLine-POD.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-CmdLine-POD

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.

SEE ALSO

Perinci::CmdLine

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 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.