NAME

Getopt::Compact::PodMunger - script POD munging

SYNOPSIS

    my $p = new Getopt::Compact::PodMunger();
    $p->parse_from_file('foo.pl');
    $p->insert('USAGE', $usage_string);
    print $p->as_string;

DESCRIPTION

Getopt::Compact::PodMunger is used internally by Getopt::Compact to parse POD in command line scripts. The parsed POD is then munged via the "insert" method. This is only required when the --man option is used.

METHODS

new(), command(), verbatim(), textblock(), begin_input(), end_input()

These methods are inherited from Pod::Parser. Refer to Pod::Parser for more information.

$p->insert($section, $content, $is_verbatim)

Modifies the parsed pod by inserting a new section as a "head1" with $content under it. Correct ordering of sections (eg. "NAME", "SYNOPSIS", "DESCRIPTION") is attempted. If $is_verbatim is true, the content will be indented by four spaces.

$pod = $p->as_string()

Returns the parsed POD as a string.

$p->print_manpage()

Prints the parsed POD as a manpage, using Pod::Simple::Text::Termcap.

VERSION

$Revision: 15 $

AUTHOR

Andrew Stewart Williams

SEE ALSO

Getopt::Compact, Pod::Parser