GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Getopt::Compact::PodMunger(3) User Contributed Perl Documentation Getopt::Compact::PodMunger(3)

Getopt::Compact::PodMunger - script POD munging

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

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.

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.

$Revision: 15 $

Andrew Stewart Williams

Getopt::Compact, Pod::Parser
2006-09-04 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.