{
    "mode": "perldoc",
    "parameter": "podchecker",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/podchecker/json",
    "generated": "2026-06-15T13:21:52Z",
    "synopsis": "podchecker [-help] [-man] [-(no)warnings] [*file* ...]",
    "sections": {
        "NAME": {
            "content": "podchecker - check the syntax of POD format documentation files\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "podchecker [-help] [-man] [-(no)warnings] [*file* ...]\n",
            "subsections": []
        },
        "OPTIONS AND ARGUMENTS": {
            "content": "-help   Print a brief help message and exit.\n\n-man    Print the manual page and exit.\n\n-warnings -nowarnings\nTurn on/off printing of warnings. Repeating -warnings increases the warning level, i.e.\nmore warnings are printed. Currently increasing to level two causes flagging of\nunescaped \"<,>\" characters.\n\n*file*  The pathname of a POD file to syntax-check (defaults to standard input).\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "podchecker will read the given input files looking for POD syntax errors in the POD\ndocumentation and will print any errors it find to STDERR. At the end, it will print a status\nmessage indicating the number of errors found.\n\nDirectories are ignored, an appropriate warning message is printed.\n\npodchecker invokes the podchecker() function exported by Pod::Checker Please see \"podchecker()\"\nin Pod::Checker for more details.\n",
            "subsections": []
        },
        "RETURN VALUE": {
            "content": "podchecker returns a 0 (zero) exit status if all specified POD files are ok.\n",
            "subsections": []
        },
        "ERRORS": {
            "content": "podchecker returns the exit status 1 if at least one of the given POD files has syntax errors.\n\nThe status 2 indicates that at least one of the specified files does not contain *any* POD\ncommands.\n\nStatus 1 overrides status 2. If you want unambiguous results, call podchecker with one single\nargument only.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "Pod::Simple and Pod::Checker\n",
            "subsections": []
        },
        "AUTHORS": {
            "content": "Please report bugs using <http://rt.cpan.org>.\n\nBrad Appleton <bradapp@enteract.com>, Marek Rouchal <marekr@cpan.org>\n\nBased on code for Pod::Text::pod2text(1) written by Tom Christiansen <tchrist@mox.perl.com>\n",
            "subsections": []
        }
    },
    "summary": "podchecker - check the syntax of POD format documentation files",
    "flags": [],
    "examples": [],
    "see_also": []
}