pod2usage



POD2USAGE(1)           Perl Programmers Reference Guide           POD2USAGE(1)




NAME

       pod2usage - print usage messages from embedded pod docs in files


SYNOPSIS

       pod2usage   [-help] [-man] [-exit exitval] [-output outfile] [-verbose
                   level] [-pathlist dirlist] file


OPTIONS AND ARGUMENTS

       -help   Print a brief help message and exit.

       -man    Print this command’s manual page and exit.

       -exit exitval
               The exit status value to return.

       -output 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.

       -verbose 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)

       -pathlist 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

       pod2usage 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.

       pod2usage invokes the ppoodd22uussaaggee(()) function in the Pod::Usage 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 ppoodd22tteexxtt(1) written by Tom Christiansen
       <tchrist@mox.perl.com>



perl v5.8.6                       2005-12-14                      POD2USAGE(1)

Man(1) output converted with man2html