1###### begin =include pod2usage.PL #####
2NAME
3    pod2usage - print usage messages from embedded pod docs in files
4
5SYNOPSIS
6    pod2usage   [-help] [-man] [-exit *exitval*] [-output *outfile*]
7                [-verbose *level*] [-pathlist *dirlist*] [-formatter
8                *module*] [-utf8] *file*
9
10OPTIONS AND ARGUMENTS
11    -help   Print a brief help message and exit.
12
13    -man    Print this command's manual page and exit.
14
15    -exit *exitval*
16            The exit status value to return.
17
18    -output *outfile*
19            The output file to print to. If the special names "-" or ">&1"
20            or ">&STDOUT" are used then standard output is used. If ">&2" or
21            ">&STDERR" is used then standard error is used.
22
23    -verbose *level*
24            The desired level of verbosity to use:
25
26                1 : print SYNOPSIS only
27                2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections
28                3 : print the entire manpage (similar to running pod2text)
29
30    -pathlist *dirlist*
31            Specifies one or more directories to search for the input file
32            if it was not supplied with an absolute path. Each directory
33            path in the given list should be separated by a ':' on Unix (';'
34            on MSWin32 and DOS).
35
36    -formatter *module*
37            Which text formatter to use. Default is the Pod::Text manpage,
38            or for very old Perl versions the Pod::PlainText manpage. An
39            alternative would be e.g. the Pod::Text::Termcap manpage.
40
41    -utf8   This option assumes that the formatter (see above) understands
42            the option "utf8". It turns on generation of utf8 output.
43
44    *file*  The pathname of a file containing pod documentation to be output
45            in usage message format. If omitted, standard input is read -
46            but the output is then formatted with the Pod::Text manpage only
47            - unless a specific formatter has been specified with
48            -formatter.
49
50DESCRIPTION
51    pod2usage will read the given input file looking for pod documentation
52    and will print the corresponding usage message. If no input file is
53    specified then standard input is read.
54
55    pod2usage invokes the pod2usage() function in the Pod::Usage module.
56    Please see the pod2usage() entry in the Pod::Usage manpage.
57
58SEE ALSO
59    the Pod::Usage manpage, the pod2text manpage, the Pod::Text manpage, the
60    Pod::Text::Termcap manpage, the perldoc manpage
61
62AUTHOR
63    Please report bugs using http://rt.cpan.org.
64
65    Brad Appleton <bradapp@enteract.com>
66
67    Based on code for pod2text(1) written by Tom Christiansen
68    <tchrist@mox.perl.com>
69
70###### end =include pod2usage.PL #####
71