{
    "mode": "perldoc",
    "parameter": "pod2usage",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/pod2usage/json",
    "generated": "2026-06-03T02:31:55Z",
    "synopsis": "pod2usage   [-help] [-man] [-exit *exitval*] [-output *outfile*] [-verbose *level*] [-pathlist\n*dirlist*] [-formatter *module*] [-utf8] *file*",
    "sections": {
        "NAME": {
            "content": "pod2usage - print usage messages from embedded pod docs in files\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "pod2usage   [-help] [-man] [-exit *exitval*] [-output *outfile*] [-verbose *level*] [-pathlist\n*dirlist*] [-formatter *module*] [-utf8] *file*\n",
            "subsections": []
        },
        "OPTIONS AND ARGUMENTS": {
            "content": "-help   Print a brief help message and exit.\n\n-man    Print this command's manual page and exit.\n\n-exit *exitval*\nThe exit status value to return.\n\n-output *outfile*\nThe output file to print to. If the special names \"-\" or \">&1\" or \">&STDOUT\" are used\nthen standard output is used. If \">&2\" or \">&STDERR\" is used then standard error is\nused.\n\n-verbose *level*\nThe desired level of verbosity to use:\n\n1 : print SYNOPSIS only\n2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections\n3 : print the entire manpage (similar to running pod2text)\n\n-pathlist *dirlist*\nSpecifies one or more directories to search for the input file if it was not supplied\nwith an absolute path. Each directory path in the given list should be separated by a\n':' on Unix (';' on MSWin32 and DOS).\n\n-formatter *module*\nWhich text formatter to use. Default is Pod::Text, or for very old Perl versions\nPod::PlainText. An alternative would be e.g. Pod::Text::Termcap.\n\n-utf8   This option assumes that the formatter (see above) understands the option \"utf8\". It\nturns on generation of utf8 output.\n\n*file*  The pathname of a file containing pod documentation to be output in usage message\nformat. If omitted, standard input is read - but the output is then formatted with\nPod::Text only - unless a specific formatter has been specified with -formatter.\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "pod2usage will read the given input file looking for pod documentation and will print the\ncorresponding usage message. If no input file is specified then standard input is read.\n\npod2usage invokes the pod2usage() function in the Pod::Usage module. Please see \"pod2usage()\" in\nPod::Usage.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "Pod::Usage, pod2text, Pod::Text, Pod::Text::Termcap, perldoc\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "Please report bugs using <http://rt.cpan.org>.\n\nBrad Appleton <bradapp@enteract.com>\n\nBased on code for pod2text(1) written by Tom Christiansen <tchrist@mox.perl.com>\n",
            "subsections": []
        }
    },
    "summary": "pod2usage - print usage messages from embedded pod docs in files",
    "flags": [],
    "examples": [],
    "see_also": []
}