{
    "mode": "perldoc",
    "parameter": "Pod::Html",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3AHtml/json",
    "generated": "2026-06-03T01:36:13Z",
    "synopsis": "use Pod::Html;\npod2html([options]);",
    "sections": {
        "NAME": {
            "content": "Pod::Html - module to convert pod files to HTML\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "use Pod::Html;\npod2html([options]);\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "Converts files from pod format (see perlpod) to HTML format. It can automatically generate\nindexes and cross-references, and it keeps a cache of things it knows how to cross-reference.\n",
            "subsections": []
        },
        "FUNCTIONS": {
            "content": "pod2html\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. By default, no\nbacklinks 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 HTML/CSS \"style\" attributes\nthat are output by default (to avoid conflicts).\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\" section. By default, no\nheaders 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 html file will be\nrelative. Not passing this causes all links to be absolute since this is the value that\ntells Pod::Html the root of the documentation tree.\n\nDo not use this and --htmlroot in the same call to pod2html; they are mutually exclusive.\n\nhtmlroot\n--htmlroot=name\n\nSets the base URL for the HTML files. When cross-references are made, the HTML root is\nprepended to the URL.\n\nDo not use this if relative links are desired: use --htmldir instead.\n\nDo not pass both this and --htmldir to pod2html; they are mutually exclusive.\n\nindex\n--index\n--noindex\n\nGenerate an index at the top of the HTML file. This is the default behaviour.\n\ninfile\n--infile=name\n\nSpecify the pod file to convert. Input is taken from STDIN if no infile is specified.\n\noutfile\n--outfile=name\n\nSpecify the HTML file to create. Output goes to STDOUT if no outfile is specified.\n\npoderrors\n--poderrors\n--nopoderrors\n\nInclude a \"POD ERRORS\" section in the outfile if there were any POD errors in the infile.\nThis section is included by default.\n\npodpath\n--podpath=name:...:name\n\nSpecify which subdirectories of the podroot contain pod files whose HTML converted forms can\nbe linked to in cross references.\n\npodroot\n--podroot=name\n\nSpecify the base directory for finding library pods. Default is the current working\ndirectory.\n\nquiet\n--quiet\n--noquiet\n\nDon't display *mostly harmless* warning messages. These messages will be displayed by\ndefault. But this is not the same as \"verbose\" mode.\n\nrecurse\n--recurse\n--norecurse\n\nRecurse into subdirectories specified in podpath (default behaviour).\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 for HTML. Note that we\nkeep spaces and special characters except \"\", ?\" (Netscape problem) and the hyphen (writer's\nproblem...).\n\nanchorify\nanchorify(@heading);\n\nSimilar to \"htmlify()\", but turns non-alphanumerics into underscores. Note that \"anchorify()\" is\nnot exported by default.\n",
            "subsections": []
        },
        "ENVIRONMENT": {
            "content": "Uses $Config{pod2html} to setup default options.\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "Marc Green, <marcgreen@cpan.org>.\n\nOriginal version by Tom Christiansen, <tchrist@perl.com>.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "perlpod\n",
            "subsections": []
        },
        "COPYRIGHT": {
            "content": "This program is distributed under the Artistic License.\n",
            "subsections": []
        }
    },
    "summary": "Pod::Html - module to convert pod files to HTML",
    "flags": [],
    "examples": [],
    "see_also": []
}