1N/A###### begin =include pod2usage.PL #####
1N/ANAME
1N/A pod2usage - print usage messages from embedded pod docs in files
1N/A
1N/ASYNOPSIS
1N/A pod2usage [-help] [-man] [-exit *exitval*] [-output *outfile*]
1N/A [-verbose *level*] [-pathlist *dirlist*] *file*
1N/A
1N/AOPTIONS AND ARGUMENTS
1N/A -help Print a brief help message and exit.
1N/A
1N/A -man Print this command's manual page and exit.
1N/A
1N/A -exit *exitval*
1N/A The exit status value to return.
1N/A
1N/A -output *outfile*
1N/A The output file to print to. If the special names "-" or ">&1"
1N/A or ">&STDOUT" are used then standard output is used. If ">&2" or
1N/A ">&STDERR" is used then standard error is used.
1N/A
1N/A -verbose *level*
1N/A The desired level of verbosity to use:
1N/A
1N/A 1 : print SYNOPSIS only
1N/A 2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections
1N/A 3 : print the entire manpage (similar to running pod2text)
1N/A
1N/A -pathlist *dirlist*
1N/A Specifies one or more directories to search for the input file
1N/A if it was not supplied with an absolute path. Each directory
1N/A path in the given list should be separated by a ':' on Unix (';'
1N/A on MSWin32 and DOS).
1N/A
1N/A *file* The pathname of a file containing pod documentation to be output
1N/A in usage mesage format (defaults to standard input).
1N/A
1N/ADESCRIPTION
1N/A pod2usage will read the given input file looking for pod documentation
1N/A and will print the corresponding usage message. If no input file is
1N/A specifed than standard input is read.
1N/A
1N/A pod2usage invokes the pod2usage() function in the Pod::Usage module.
1N/A Please see the pod2usage() entry in the Pod::Usage manpage.
1N/A
1N/ASEE ALSO
1N/A the Pod::Usage manpage, the pod2text(1) manpage
1N/A
1N/AAUTHOR
1N/A Please report bugs using http://rt.cpan.org.
1N/A
1N/A Brad Appleton <bradapp@enteract.com>
1N/A
1N/A Based on code for pod2text(1) written by Tom Christiansen
1N/A <tchrist@mox.perl.com>
1N/A
1N/A###### end =include pod2usage.PL #####