NAME
pod2usage - print usage messages from embedded pod docs in files
SYNOPSIS
ppoodd22uussaaggee [-hheellpp] [-mmaann] [-eexxiitt exitval] [-oouuttppuutt outfile] [-vveerrbboossee
level] [-ppaatthhlliisstt dirlist] file
OOPPTTIIOONNSS AANNDD AARRGGUUMMEENNTTSS
-hheellpp Print a brief help message and exit.
-mmaann Print this command's manual page and exit.
-eexxiitt exitval
The exit status value to return.
-oouuttppuutt 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.
-vveerrbboossee 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)
-ppaatthhlliisstt 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).
file The pathname of a file containing pod documentation to be out-
put in usage mesage format (defaults to standard input).
DESCRIPTION
ppoodd22uussaaggee will read the given input file looking for pod documentation
and will print the corresponding usage message. If no input file is
specifed than standard input is read.
ppoodd22uussaaggee invokes the ppoodd22uussaaggee(()) function in the PPoodd::::UUssaaggee module.
Please see "pod2usage()" in Pod::Usage.
SEE ALSO
Pod::Usage, pod2text(1)
AUTHOR Please report bugs using .
Brad Appleton
Based on code for ppoodd22tteexxtt((11)) written by Tom Christiansen
perl v5.8.6 2009-01-12 POD2USAGE(1)