{
    "mode": "man",
    "parameter": "pod2usage",
    "section": "1",
    "url": "https://www.chedong.com/phpMan.php/man/pod2usage/1/json",
    "generated": "2026-06-13T20:00:34Z",
    "synopsis": "pod2usage   [-help] [-man] [-exit exitval] [-output outfile] [-verbose level] [-pathlist\ndirlist] [-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\ndirlist] [-formatter module] [-utf8] file\n",
            "subsections": []
        },
        "OPTIONS AND ARGUMENTS": {
            "content": "",
            "subsections": [
                {
                    "name": "-help",
                    "content": ""
                },
                {
                    "name": "-man",
                    "content": ""
                },
                {
                    "name": "-exit",
                    "content": "The exit status value to return.\n"
                },
                {
                    "name": "-output",
                    "content": "The 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"
                },
                {
                    "name": "-verbose",
                    "content": "The 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"
                },
                {
                    "name": "-pathlist",
                    "content": "Specifies 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"
                },
                {
                    "name": "-formatter",
                    "content": "Which 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"
                },
                {
                    "name": "-utf8",
                    "content": "turns on generation of utf8 output.\n\nfile    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"
                }
            ]
        },
        "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()\"\nin Pod::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\n\n\nperl v5.34.0                                 2025-07-25                                 POD2USAGE(1)",
            "subsections": []
        }
    },
    "summary": "pod2usage - print usage messages from embedded pod docs in files",
    "flags": [],
    "examples": [],
    "see_also": []
}