From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

#!perl
# Note: This script is a CLI for Riap function /App/CPANModulesUtils/gen_acme_cpanmodules_module_from_acme_cpanlists_list
# and generated automatically using Perinci::CmdLine::Gen version 0.500
use 5.010001;
use strict;
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2021-11-26'; # DATE
our $DIST = 'App-CPANModulesUtils'; # DIST
our $VERSION = '0.007'; # VERSION
my $cmdline = Perinci::CmdLine::Any->new(
url => "/App/CPANModulesUtils/gen_acme_cpanmodules_module_from_acme_cpanlists_list",
program_name => "gen-acme-cpanmodules-module-from-acme-cpanlists-list",
log => 1,
read_config => 0,
read_env => 0,
);
$cmdline->run;
# ABSTRACT: Generate an Acme::CPANModules module file from an Acme::CPANLists module list
# PODNAME: gen-acme-cpanmodules-module-from-acme-cpanlists-list
__END__
=pod
=encoding UTF-8
=head1 NAME
gen-acme-cpanmodules-module-from-acme-cpanlists-list - Generate an Acme::CPANModules module file from an Acme::CPANLists module list
=head1 VERSION
This document describes version 0.007 of gen-acme-cpanmodules-module-from-acme-cpanlists-list (from Perl distribution App-CPANModulesUtils), released on 2021-11-26.
=head1 SYNOPSIS
Usage:
% B<gen-acme-cpanmodules-module-from-acme-cpanlists-list> [B<--debug>|B<--log-level>=I<level>|B<--quiet>|B<--trace>|B<--verbose>] [B<--format>=I<name>|B<--json>] [B<--input-list-index>=I<nonnegint>] [B<--(no)naked-res>] [B<--output-file>=I<filename>] [B<--output-module>=I<perl::modname>] [B<--overwrite>|B<-O>] [B<--page-result>[=I<program>]|B<--view-result>[=I<program>]] [B<-n>=I<nonnegint>] -- E<lt>I<input_module>E<gt>
=head1 OPTIONS
C<*> marks required options.
=head2 Main options
=over
=item B<--input-list-index>=I<s>, B<-n>
Required if the Acme::CPANLists module contains more than one module list.
=item B<--input-module>=I<s>*
"Acme::CPANLists::" will be prepended if module name does not begin with it.
Can also be specified as the 1st command-line argument.
=item B<--output-file>=I<s>
will default to "lib/Acme/CPANModules/<YourModuleName>.pm
=item B<--output-module>=I<s>
"Acme::CPANModules::" will be prepended if module name does not begin with it.
Will default to the Acme::CPANLists module name, with CPANLists replaced by
CPANModules.
=item B<--overwrite>, B<-O>
=back
=head2 Logging options
=over
=item B<--debug>
Shortcut for --log-level=debug.
=item B<--log-level>=I<s>
Set log level.
=item B<--quiet>
Shortcut for --log-level=error.
=item B<--trace>
Shortcut for --log-level=trace.
=item B<--verbose>
Shortcut for --log-level=info.
=back
=head2 Output options
=over
=item B<--format>=I<s>
Choose output format, e.g. json, text.
Default value:
undef
=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<--page-result>
Filter output through a pager.
=item B<--view-result>
View output using a viewer.
=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-acme-cpanmodules-module-from-acme-cpanlists-list gen-acme-cpanmodules-module-from-acme-cpanlists-list
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-acme-cpanmodules-module-from-acme-cpanlists-list 'p/*/`gen-acme-cpanmodules-module-from-acme-cpanlists-list`/'
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 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-CPANModulesUtils>.
=head1 SOURCE
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull requests on
GitHub.
Most of the time, you don't need to build the distribution yourself. You can
simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your
system), you can install L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>, and sometimes one or two other
Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required
beyond that are considered a bug and can be reported to me.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 2020, 2019, 2018 by perlancar <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.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-CPANModulesUtils>
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.
=cut