App::pod2pandoc(3pm)

Usage

  use App::pod2pandoc;
  # pod2pandoc command line script
  my ($input, $opt, @args) = parse_arguments(@ARGV);
  pod2pandoc($input, $opt, @args);
  # parse a Perl/Pod file and print its JSON serialization
  pod2pandoc( ['example.pl'], {} );
  # parse a Perl/Pod file and convert to HTML with a template
  pod2pandoc( ['example.pl'], {}, '--template', 'template.html' );
  # process directory of Perl modules
  pod2pandoc( [ lib => 'doc'], { ext => 'html' }, '--standalone' );

Overview

This module implements the command line script pod2pandoc.

Functions

pod2pandoc( \@input, [ \%options, ] \@arguments )

Processed input files with given pod2pandoc options ("data-sections", "podurl", "ext", "wiki", "meta", "update", and "quiet") . Additional arguments are passed to "pandoc" executable via module Pandoc.

Input can be either files and/or module names or directories to recursively search for ".pm" and ".pod" files. If no input is specified, Pod is read from STDIN. When processing directories, the last input directory is used as output directory.

This function is exported by default.

parse_arguments( @argv )

Parses options and input arguments from given command line arguments. May terminate the program with message, for instance with argument "--help".

Releases

Unchanged in 2 releases since Debian 12 (Bookworm).

12–13