#!perl

# Note: This script is a CLI for Riap function /Perinci/CmdLine/POD/gen_pod_for_pericmd_script
# and generated automatically using Perinci::CmdLine::Gen version 0.498

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2021-05-25'; # DATE
our $DIST = 'App-PericmdUtils'; # DIST
our $VERSION = '0.050'; # VERSION

use 5.010001;
use strict;
use warnings;

use Perinci::CmdLine::Any;

my $cmdline = Perinci::CmdLine::Any->new(
    url => "/Perinci/CmdLine/POD/gen_pod_for_pericmd_script",
    program_name => "gen-pod-for-pericmd-script",
);

$cmdline->run;

# ABSTRACT: Generate POD for Perinci::CmdLine-based CLI script
# PODNAME: gen-pod-for-pericmd-script

__END__

=pod

=encoding UTF-8

=head1 NAME

gen-pod-for-pericmd-script - Generate POD for Perinci::CmdLine-based CLI script

=head1 VERSION

This document describes version 0.050 of gen-pod-for-pericmd-script (from Perl distribution App-PericmdUtils), released on 2021-05-25.

=head1 SYNOPSIS

Usage:

 % gen-pod-for-pericmd-script [--common-opts-json=s] [--common-opts=s]
     [--completer-script=s] [--config-dirs-json=s] [--config-dirs=s+]
     [--config-filename-json=s] [--config-filename=s] [--config-path=path |
     -c] [--config-profile=profile | -P] [--default-subcommand=s]
     [--env-name=s] [--format=name] [--gen-subcommand=s]
     [--gen-subcommands] [--json] [--libs-json=s] [--libs=s+]
     [--(no)naked-res] [--no-config | -C] [--no-env] [--no-gen-subcommands]
     [--nogen-subcommands] [--page-result[=program]] [--per-arg-json]
     [--per-arg-yaml] [--program-name=s] [--read-config] [--read-env]
     [--script=s] [--subcommands-json=s] [--subcommands=s] [--summary=s]
     [--url=s] [--view-result[=program]]

=head1 DESCRIPTION

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

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

=item B<--libs-json>=I<s>

Extra libraries to pass to perl via -I (JSON-encoded).

See C<--libs>.

=item B<--libs>=I<s@>

Extra libraries to pass to perl via -I.

Can be specified multiple times.

=back

=head2 Completion specification options

=over

=item B<--completer-script>=I<s>

Script name for shell completion.

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

Without specifying this option, the COMPLETION POD section will not be
generated.


=back

=head2 Configuration options

=over

=item B<--config-path>=I<s>, B<-c>

Set path to configuration file.

=item B<--config-profile>=I<s>, B<-P>

Set configuration profile to use.

=item B<--no-config>, B<-C>

Do not use any configuration file.

=back

=head2 Environment options

=over

=item B<--no-env>

Do not read environment for default options.

=back

=head2 Output options

=over

=item B<--format>=I<s>

Choose output format, e.g. json, text.

Default value:

 undef

=item B<--gen-subcommand>=I<s>

Only generate POD for this subcommand.

See `--gen-subcommands`.


=item B<--json>

Set output format to json.

=item B<--naked-res>

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]


=item B<--no-gen-subcommands>

Do not generate POD for subcommands.

If you want to generate separate POD/manpage for each subcommand, you can use
this option for the main CLI POD, then generate each subcommand's POD with the
`--gen-subcommand=SUBCOMMAND_NAME` option.


=item B<--page-result>

Filter output through a pager.

=item B<--view-result>

View output using a viewer.

=back

=head2 Script source options

=over

=item B<--script>=I<s>

Path to script.

=back

=head2 Script specification options

=over

=item B<--common-opts-json>=I<s>

Set `common_opts` attribute, see Perinci::CmdLine::Base (JSON-encoded).

See C<--common-opts>.

=item B<--common-opts>=I<s>

Set `common_opts` attribute, see Perinci::CmdLine::Base.

=item B<--config-dirs-json>=I<s>

Set `config_dirs` attribute, see Perinci::CmdLine::Base (JSON-encoded).

See C<--config-dirs>.

=item B<--config-dirs>=I<s@>

Set `config_dirs` attribute, see Perinci::CmdLine::Base.

Can be specified multiple times.

=item B<--config-filename-json>=I<s>

Set `config_filename` attribute, see Perinci::CmdLine::Base (JSON-encoded).

See C<--config-filename>.

=item B<--config-filename>=I<s>

Set `config_filename` attribute, see Perinci::CmdLine::Base.

=item B<--default-subcommand>=I<s>

Set `default_subcommand` attribute, see Perinci::CmdLine::Base.

=item B<--env-name>=I<s>

Set `env_name` attribute, see Perinci::CmdLine::Base.

=item B<--per-arg-json>

Set `per_arg_json` attribute, see Perinci::CmdLine::Base.

=item B<--per-arg-yaml>

Set `per_arg_yaml` attribute, see Perinci::CmdLine::Base.

=item B<--program-name>=I<s>

Set `program_name` attribute, see Perinci::CmdLine::Base.

=item B<--read-config>

Set `read_config` attribute, see Perinci::CmdLine::Base.

=item B<--read-env>

Set `read_env` attribute, see Perinci::CmdLine::Base.

=item B<--subcommands-json>=I<s>

Set `subcommands` attribute, see Perinci::CmdLine::Base (JSON-encoded).

See C<--subcommands>.

=item B<--subcommands>=I<s>

Set `subcommands` attribute, see Perinci::CmdLine::Base.

=item B<--summary>=I<s>

Set `summary` attribute, see Perinci::CmdLine::Base.

=item B<--url>=I<s>

Set `url` attribute, see Perinci::CmdLine::Base for more details.

=back

=head2 Other options

=over

=item B<--help>, B<-h>, B<-?>

Display help message and exit.

=item B<--version>, B<-v>

Display program's version and exit.

=back

=head1 COMPLETION

This script has shell tab completion capability with support for several
shells.

=head2 bash

To activate bash completion for this script, put:

 complete -C gen-pod-for-pericmd-script gen-pod-for-pericmd-script

in your bash startup (e.g. F<~/.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 modules using L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete gen-pod-for-pericmd-script 'p/*/`gen-pod-for-pericmd-script`/'

in your tcsh startup (e.g. F<~/.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 L<shcompgen> (see above).

=head2 other shells

For fish and zsh, install L<shcompgen> as described above.

=head1 CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of L<IOD>, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using C<--config-path>): F<~/.config/gen-pod-for-pericmd-script.conf>, F<~/gen-pod-for-pericmd-script.conf>, or F</etc/gen-pod-for-pericmd-script.conf>.

All found files will be read and merged.

To disable searching for configuration files, pass C<--no-config>.

You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]>. Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.

You can also put configuration for multiple programs inside a single file, and use filter C<program=NAME> in section names, e.g. C<[program=NAME ...]> or C<[SOMESECTION program=NAME]>. The section will then only be used when the reading program matches.

You can also filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...]>. If you only want a section to be read when the value of an environment variable equals some string: C<[env=HOSTNAME=blink ...]> or C<[SOMESECTION env=HOSTNAME=blink ...]>. If you only want a section to be read when the value of an environment variable does not equal some string: C<[env=HOSTNAME!=blink ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when the value of an environment variable includes some string: C<[env=HOSTNAME*=server ...]> or C<[SOMESECTION env=HOSTNAME*=server ...]>. If you only want a section to be read when the value of an environment variable does not include some string: C<[env=HOSTNAME!*=server ...]> or C<[SOMESECTION env=HOSTNAME!*=server ...]>. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

To load and configure plugins, you can use either the C<-plugins> parameter (e.g. C<< -plugins=DumpArgs >> or C<< -plugins=DumpArgs@before_validate_args >>), or use the C<[plugin=NAME ...]> sections, for example:

 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
 
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2

 

which is equivalent to setting C<< -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2 >>.

List of available configuration parameters:

 common_opts (see --common-opts)
 completer_script (see --completer-script)
 config_dirs (see --config-dirs)
 config_filename (see --config-filename)
 default_subcommand (see --default-subcommand)
 env_name (see --env-name)
 format (see --format)
 gen_subcommand (see --gen-subcommand)
 gen_subcommands (see --no-gen-subcommands)
 libs (see --libs)
 naked_res (see --naked-res)
 per_arg_json (see --per-arg-json)
 per_arg_yaml (see --per-arg-yaml)
 program_name (see --program-name)
 read_config (see --read-config)
 read_env (see --read-env)
 script (see --script)
 subcommands (see --subcommands)
 summary (see --summary)
 url (see --url)

=head1 ENVIRONMENT

=head2 GEN_POD_FOR_PERICMD_SCRIPT_OPT => str

Specify additional command-line options.

=head1 FILES

F<~/.config/gen-pod-for-pericmd-script.conf>

F<~/gen-pod-for-pericmd-script.conf>

F</etc/gen-pod-for-pericmd-script.conf>

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/App-PericmdUtils>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-PericmdUtils>.

=head1 BUGS

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

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.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

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

=cut
