Module::Install::PodFromEuclid - Module::Install extension to make POD from Getopt::Euclid-based scripts
# In Makefile.PL: use inc::Module::Install; author 'John Doe'; license 'perl'; pod_from 'scripts/my_script.pl';
Module::Install::PodFromEuclid is a Module::Install extension that generates a POD file automatically from an indicated script containing Getopt::Euclid command-line specifications.
POD
The POD file is generated using the --podfile option of Getopt::Euclid, but only whenever authors run Makefile.PL. While this extension will be bundled in your distribution, the pod_from command does nothing on the user-side.
Makefile.PL
Note: Authors should make sure that Module::Install::PodFromEuclid is installed before running Makefile.PL.
Module::Install::PodFromEuclid
This module was inspired and borrows a lot from Module::Install::ReadmeFromPod.
Module::Install::ReadmeFromPod
This plugin adds the following Module::Install command:
pod_from
Does nothing on the user-side. On the author-side it will generate a POD file that has the same base name as the Perl file, using Getopt::Euclid's --podfile feature:
pod_from 'scripts/my_script.pl'; # generate scripts/my_script.pod
If you use the all_from command, pod_from will default to this value.
all_from
all_from 'scripts/my_script.pl'; pod_from; # create scripts/my_script.pod
Florent Angly <florent.angly@gmail.com>
Copyright Florent Angly
This module may be used, modified, and distributed under the same terms as Perl itself. Please see the license that came with your Perl distribution for details.
Getopt::Euclid
Module::Install
To install Module::Install::PodFromEuclid, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Module::Install::PodFromEuclid
CPAN shell
perl -MCPAN -e shell install Module::Install::PodFromEuclid
For more information on module installation, please visit the detailed CPAN module installation guide.