1POD2USAGE(1)           Perl Programmers Reference Guide           POD2USAGE(1)
2
3
4

NAME

6       pod2usage - print usage messages from embedded pod docs in files
7

SYNOPSIS

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

OPTIONS AND ARGUMENTS

13       -help   Print a brief help message and exit.
14
15       -man    Print this command's manual page and exit.
16
17       -exit exitval
18               The exit status value to return.
19
20       -output outfile
21               The output file to print to. If the special names "-" or ">&1"
22               or ">&STDOUT" are used then standard output is used. If ">&2"
23               or ">&STDERR" is used then standard error is used.
24
25       -verbose level
26               The desired level of verbosity to use:
27
28                   1 : print SYNOPSIS only
29                   2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections
30                   3 : print the entire manpage (similar to running pod2text)
31
32       -pathlist dirlist
33               Specifies one or more directories to search for the input file
34               if it was not supplied with an absolute path. Each directory
35               path in the given list should be separated by a ':' on Unix
36               (';' on MSWin32 and DOS).
37
38       file    The pathname of a file containing pod documentation to be out‐
39               put in usage mesage format (defaults to standard input).
40

DESCRIPTION

42       pod2usage will read the given input file looking for pod documentation
43       and will print the corresponding usage message.  If no input file is
44       specifed than standard input is read.
45
46       pod2usage invokes the pod2usage() function in the Pod::Usage module.
47       Please see "pod2usage()" in Pod::Usage.
48

SEE ALSO

50       Pod::Usage, pod2text(1)
51

AUTHOR

53       Please report bugs using <http://rt.cpan.org>.
54
55       Brad Appleton <bradapp@enteract.com>
56
57       Based on code for pod2text(1) written by Tom Christiansen
58       <tchrist@mox.perl.com>
59
60
61
62perl v5.8.8                       2008-05-05                      POD2USAGE(1)