OS Manuals

/usr/bin/pod2usage

Larry Wall's Practical Extraction and Report Language

From perl 5.44.0-r4 (os), captured 2026-11-05 by running pod2usage --help (exit 1). permalink

Usage:
    pod2usage   [-help] [-man] [-exit exitval] [-output outfile] [-verbose
                level] [-pathlist dirlist] [-formatter module] [-utf8] file

Options and Arguments:
    -help   Prints a brief help message and exit.

    -man    Prints 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).

    -formatter module
            Which text formatter to use. Default is Pod::Text. An
            alternative would be e.g. Pod::Text::Termcap.

    -utf8   This option assumes that the formatter (see above) understands
            the option "utf8". It turns on generation of utf8 output.

    file    The pathname of a file containing pod documentation to be output
            in usage message format. If omitted, standard input is read -
            but the output is then formatted with Pod::Text only - unless a
            specific formatter has been specified with -formatter.
Options (8)
OptionDescriptionSource
-helpPrints a brief help message and exit.help + man
-manPrints this command's manual page and exit.help + man
-exit exitvalThe exit status value to return.help + man
-output outfileThe output file to print to.help + man
-verbose levelThe desired level of verbosity to use:help + man
-pathlist dirlistSpecifies one or more directories to search for the input file if it was not supplied with an absolute path.help + man
-formatter moduleWhich text formatter to use.help + man
-utf8This option assumes that the formatter (see above) understands the option "utf8".help + man

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.