1POD2USAGE(1)          User Contributed Perl Documentation         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] [-formatter module] [-utf8] 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       -formatter module
39               Which text formatter to use. Default is Pod::Text, or for very
40               old Perl versions Pod::PlainText. An alternative would be e.g.
41               Pod::Text::Termcap.
42
43       -utf8   This option assumes that the formatter (see above) understands
44               the option "utf8". It turns on generation of utf8 output.
45
46       file    The pathname of a file containing pod documentation to be
47               output in usage message format. If omitted, standard input is
48               read - but the output is then formatted with Pod::Text only -
49               unless a specific formatter has been specified with -formatter.
50

DESCRIPTION

52       pod2usage will read the given input file looking for pod documentation
53       and will print the corresponding usage message.  If no input file is
54       specified then standard input is read.
55
56       pod2usage invokes the pod2usage() function in the Pod::Usage module.
57       Please see "pod2usage()" in Pod::Usage.
58

SEE ALSO

60       Pod::Usage, pod2text, Pod::Text, Pod::Text::Termcap, perldoc
61

AUTHOR

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
71
72perl v5.38.0                      2023-07-21                      POD2USAGE(1)