{
    "content": [
        {
            "type": "text",
            "text": "# Pod::Html (perldoc)\n\n**Summary:** Pod::Html - module to convert pod files to HTML\n\n**Synopsis:** use Pod::Html;\npod2html([options]);\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (3 lines)\n- **DESCRIPTION** (4 lines)\n- **FUNCTIONS** (146 lines)\n- **ENVIRONMENT** (2 lines)\n- **AUTHOR** (4 lines)\n- **SEE ALSO** (2 lines)\n- **COPYRIGHT** (2 lines)\n\n## Full Content\n\n### NAME\n\nPod::Html - module to convert pod files to HTML\n\n### SYNOPSIS\n\nuse Pod::Html;\npod2html([options]);\n\n### DESCRIPTION\n\nConverts files from pod format (see perlpod) to HTML format. It can\nautomatically generate indexes and cross-references, and it keeps a\ncache of things it knows how to cross-reference.\n\n### FUNCTIONS\n\npod2html\npod2html(\"pod2html\",\n\"--podpath=lib:ext:pod:vms\",\n\"--podroot=/usr/src/perl\",\n\"--htmlroot=/perl/nmanual\",\n\"--recurse\",\n\"--infile=foo.pod\",\n\"--outfile=/perl/nmanual/foo.html\");\n\npod2html takes the following arguments:\n\nbacklink\n--backlink\n\nTurns every \"head1\" heading into a link back to the top of the page.\nBy default, no backlinks are generated.\n\ncachedir\n--cachedir=name\n\nCreates the directory cache in the given directory.\n\ncss\n--css=stylesheet\n\nSpecify the URL of a cascading style sheet. Also disables all\nHTML/CSS \"style\" attributes that are output by default (to avoid\nconflicts).\n\nflush\n--flush\n\nFlushes the directory cache.\n\nheader\n--header\n--noheader\n\nCreates header and footer blocks containing the text of the \"NAME\"\nsection. By default, no headers are generated.\n\nhelp\n--help\n\nDisplays the usage message.\n\nhtmldir\n--htmldir=name\n\nSets the directory to which all cross references in the resulting\nhtml file will be relative. Not passing this causes all links to be\nabsolute since this is the value that tells Pod::Html the root of\nthe documentation tree.\n\nDo not use this and --htmlroot in the same call to pod2html; they\nare mutually exclusive.\n\nhtmlroot\n--htmlroot=name\n\nSets the base URL for the HTML files. When cross-references are\nmade, the HTML root is prepended to the URL.\n\nDo not use this if relative links are desired: use --htmldir\ninstead.\n\nDo not pass both this and --htmldir to pod2html; they are mutually\nexclusive.\n\nindex\n--index\n--noindex\n\nGenerate an index at the top of the HTML file. This is the default\nbehaviour.\n\ninfile\n--infile=name\n\nSpecify the pod file to convert. Input is taken from STDIN if no\ninfile is specified.\n\noutfile\n--outfile=name\n\nSpecify the HTML file to create. Output goes to STDOUT if no outfile\nis specified.\n\npoderrors\n--poderrors\n--nopoderrors\n\nInclude a \"POD ERRORS\" section in the outfile if there were any POD\nerrors in the infile. This section is included by default.\n\npodpath\n--podpath=name:...:name\n\nSpecify which subdirectories of the podroot contain pod files whose\nHTML converted forms can be linked to in cross references.\n\npodroot\n--podroot=name\n\nSpecify the base directory for finding library pods. Default is the\ncurrent working directory.\n\nquiet\n--quiet\n--noquiet\n\nDon't display *mostly harmless* warning messages. These messages\nwill be displayed by default. But this is not the same as \"verbose\"\nmode.\n\nrecurse\n--recurse\n--norecurse\n\nRecurse into subdirectories specified in podpath (default\nbehaviour).\n\ntitle\n--title=title\n\nSpecify the title of the resulting HTML file.\n\nverbose\n--verbose\n--noverbose\n\nDisplay progress messages. By default, they won't be displayed.\n\nhtmlify\nhtmlify($heading);\n\nConverts a pod section specification to a suitable section specification\nfor HTML. Note that we keep spaces and special characters except \"\", ?\"\n(Netscape problem) and the hyphen (writer's problem...).\n\nanchorify\nanchorify(@heading);\n\nSimilar to \"htmlify()\", but turns non-alphanumerics into underscores.\nNote that \"anchorify()\" is not exported by default.\n\n### ENVIRONMENT\n\nUses $Config{pod2html} to setup default options.\n\n### AUTHOR\n\nMarc Green, <marcgreen@cpan.org>.\n\nOriginal version by Tom Christiansen, <tchrist@perl.com>.\n\n### SEE ALSO\n\nperlpod\n\n### COPYRIGHT\n\nThis program is distributed under the Artistic License.\n\n"
        }
    ],
    "structuredContent": {
        "command": "Pod::Html",
        "section": "",
        "mode": "perldoc",
        "summary": "Pod::Html - module to convert pod files to HTML",
        "synopsis": "use Pod::Html;\npod2html([options]);",
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "FUNCTIONS",
                "lines": 146,
                "subsections": []
            },
            {
                "name": "ENVIRONMENT",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "COPYRIGHT",
                "lines": 2,
                "subsections": []
            }
        ]
    }
}