Pandoc::Filter::Usage - get filter documentation from Pod
Called automatically in "pandoc_filter" in Pandoc::Filter. If a filter does not directly use this function, use like this:
my %opt; Getopt::Long::GetOptions(\%opt, 'help|?', 'to|write:s'); Pandoc::Filter::Usage::frompod(\%opt);
This module provides the function frompod as replacement for pod2usage to get and print documentation of a filter.
frompod
pod2usage
Prints filter documentation from its Pod and exits if option help is true. If no options are passed, options are read from @ARGV with GetOpt::Long to check whether command line option --help, -h, -?, or --about was specified.
help
@ARGV
--help
-h
-?
--about
If option to or write is given, Pod::Simple::Pandoc is used to parse the Pod and Pandoc is used to create output in the selected format. Documentation is printed with Pod::Text otherwise.
to
write
Pod::Usage
To install Pandoc::Elements, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pandoc::Elements
CPAN shell
perl -MCPAN -e shell install Pandoc::Elements
For more information on module installation, please visit the detailed CPAN module installation guide.