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


Manual Reference Pages  -  POD2USAGE (1)

.ds Aq ’

NAME

pod2usage - print usage messages from embedded pod docs in files

CONTENTS

SYNOPSIS

<B>pod2usageB> [<B>-helpB>] [<B>-manB>] [<B>-exitB> exitval] [<B>-outputB> outfile] [<B>-verboseB> level] [<B>-pathlistB> dirlist] [<B>-formatterB> module] file

OPTIONS AND ARGUMENTS

<B>-helpB> Print a brief help message and exit.
<B>-manB> Print this command’s manual page and exit.
<B>-exitB> exitval The exit status value to return.
<B>-outputB> outfile The output file to print to. If the special names - or >&1 or >&STDOUT are used then standard output is used. If >&2 or >&STDERR is used then standard error is used.
<B>-verboseB> level The desired level of verbosity to use:



    1 : print SYNOPSIS only
    2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections
    3 : print the entire manpage (similar to running pod2text)



<B>-pathlistB> dirlist Specifies one or more directories to search for the input file if it was not supplied with an absolute path. Each directory path in the given list should be separated by a ’:’ on Unix (’;’ on MSWin32 and DOS).
<B>-formatterB> module Which text formatter to use. Default is Pod::Text, or for very old Perl versions Pod::PlainText. An alternative would be e.g. Pod::Text::Termcap.
file The pathname of a file containing pod documentation to be output in usage message format (defaults to standard input).

DESCRIPTION

<B>pod2usageB> will read the given input file looking for pod documentation and will print the corresponding usage message. If no input file is specified then standard input is read.

<B>pod2usageB> invokes the <B>B>pod2usage()<B>B> function in the <B>Pod::UsageB> module. Please see pod2usage() in Pod::Usage.

SEE ALSO

Pod::Usage, pod2text(1)

AUTHOR

Please report bugs using <http://rt.cpan.org>.

Brad Appleton <bradapp@enteract.com>

Based on code for <B>B>pod2text<B>(1)B> written by Tom Christiansen <tchrist@mox.perl.com>

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


perl v5.22.1 POD2USAGE (1) 2016-03-18

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