NAME

Pandoc::Filter::Usage - print filter documentation from embedded Pod

DESCRIPTION

This module provides the function pod2usage as replacement for pod2usage to get and print documentation of a filter script. The function is called automatically by "pandoc_filter" in Pandoc::Filter. If your filter does not use this function, execute pod2usage like this:

  my %opt;
  Getopt::Long::GetOptions(\%opt, 'help|?');
  Pandoc::Filter::Usage::pod2usage( to => $ARGV[0] ) if $opt{help};

FUNCTIONS

pod2usage [ %options | { %options } ]

Print filter documentation parsed with Pod::Simple::Pandoc from its script and exit.

to

Output format (json, markdown, html...) to print documentation with pandoc. By default the documentation is printed with Pod::Text instead.

exitval

The desired exit status to pass to the exit function or the string "NOEXIT" to let the function return without calling exit.

SEE ALSO

Pod::Usage