{
    "content": [
        {
            "type": "text",
            "text": "# podchecker (perldoc)\n\n## NAME\n\npodchecker - check the syntax of POD format documentation files\n\n## SYNOPSIS\n\npodchecker [-help] [-man] [-(no)warnings] [*file* ...]\n\n## DESCRIPTION\n\npodchecker 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\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **OPTIONS AND ARGUMENTS**\n- **DESCRIPTION**\n- **RETURN VALUE**\n- **ERRORS**\n- **SEE ALSO**\n- **AUTHORS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "podchecker",
        "section": "",
        "mode": "perldoc",
        "summary": "podchecker - check the syntax of POD format documentation files",
        "synopsis": "podchecker [-help] [-man] [-(no)warnings] [*file* ...]",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "OPTIONS AND ARGUMENTS",
                "lines": 11,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "RETURN VALUE",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "ERRORS",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "AUTHORS",
                "lines": 6,
                "subsections": []
            }
        ],
        "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": []
            }
        }
    }
}