NAME
Dist::Zilla::Plugin::InsertExecsList - Insert a POD containing a list of
scripts/executables in the distribution
VERSION
This document describes version 0.031 of
Dist::Zilla::Plugin::InsertExecsList (from Perl distribution
Dist-Zilla-Plugin-InsertExecsList), released on 2023-02-18.
SYNOPSIS
In dist.ini:
[InsertExecsList]
In lib/Foo.pm:
...
=head1 DESCRIPTION
This distribution contains the following utilities:
#INSERT_EXECS_LIST
...
After build, lib/Foo.pm will contain:
...
=head1 DESCRIPTION
This distribution contains the following utilities:
=over
=item 1. L<script1>
=item 2. L<script2>
=item 3. L<script3>
=back
...
DESCRIPTION
This plugin finds "# INSERT_EXECS_LIST" directive in your POD/code and
replace it with a POD containing list of scripts/executables in the
distribution.
CONFIGURATION
ordered
Bool. Default true. Can be set to false to generate an unordered list
instead of ordered one.
HOMEPAGE
Please visit the project's homepage at
<https://metacpan.org/release/Dist-Zilla-Plugin-InsertExecsList>.
SOURCE
Source repository is at
<https://github.com/perlancar/perl-Dist-Zilla-Plugin-InsertExecsList>.
SEE ALSO
Dist::Zilla::Plugin::InsertModulesList
AUTHOR
perlancar <perlancar@cpan.org>
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 Dist::Zilla,
Dist::Zilla::PluginBundle::Author::PERLANCAR,
Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two
other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps
required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 2023, 2015 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.
BUGS
Please report any bugs or feature requests on the bugtracker website
<https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Ins
ertExecsList>
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.