{ "content": [ { "type": "text", "text": "# POD2HTML(1) (man)\n\n**Summary:** pod2html - convert .pod files to .html files\n\n**Synopsis:** pod2html --help --htmldir= --htmlroot=\n--infile= --outfile=\n--podpath=:...: --podroot=\n--cachedir= --flush --recurse --norecurse\n--quiet --noquiet --verbose --noverbose\n--index --noindex --backlink --nobacklink\n--header --noheader --poderrors --nopoderrors\n--css= --title=\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (9 lines)\n- **DESCRIPTION** (2 lines)\n- **ARGUMENTS** (144 lines)\n- **AUTHOR** (2 lines)\n- **BUGS** (2 lines)\n- **SEE ALSO** (2 lines)\n- **COPYRIGHT** (5 lines)\n\n## Full Content\n\n### NAME\n\npod2html - convert .pod files to .html files\n\n### SYNOPSIS\n\npod2html --help --htmldir= --htmlroot=\n--infile= --outfile=\n--podpath=:...: --podroot=\n--cachedir= --flush --recurse --norecurse\n--quiet --noquiet --verbose --noverbose\n--index --noindex --backlink --nobacklink\n--header --noheader --poderrors --nopoderrors\n--css= --title=\n\n### DESCRIPTION\n\nConverts files from pod format (see perlpod) to HTML format.\n\n### ARGUMENTS\n\npod2html takes the following arguments:\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=URL\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\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\npodroot\n--podroot=name\n\nSpecify the base directory for finding library pods.\n\npodpath\n--podpath=name:...:name\n\nSpecify which subdirectories of the podroot contain pod files whose HTML converted forms\ncan be linked-to in cross-references.\n\ncachedir\n--cachedir=name\n\nSpecify which directory is used for storing cache. Default directory is the current\nworking directory.\n\nflush\n--flush\n\nFlush the cache.\n\nbacklink\n--backlink\n\nTurn =head1 directives into links pointing to the top of the HTML file.\n\nnobacklink\n--nobacklink\n\nDo not turn =head1 directives into links pointing to the top of the HTML file (default\nbehaviour).\n\nheader\n--header\n\nCreate header and footer blocks containing the text of the \"NAME\" section.\n\nnoheader\n--noheader\n\nDo not create header and footer blocks containing the text of the \"NAME\" section (default\nbehaviour).\n\npoderrors\n--poderrors\n\nInclude a \"POD ERRORS\" section in the outfile if there were any POD errors in the infile\n(default behaviour).\n\nnopoderrors\n--nopoderrors\n\nDo not include a \"POD ERRORS\" section in the outfile if there were any POD errors in the\ninfile.\n\nindex\n--index\n\nGenerate an index at the top of the HTML file (default behaviour).\n\nnoindex\n--noindex\n\nDo not generate an index at the top of the HTML file.\n\nrecurse\n--recurse\n\nRecurse into subdirectories specified in podpath (default behaviour).\n\nnorecurse\n--norecurse\n\nDo not recurse into subdirectories specified in podpath.\n\ncss\n--css=URL\n\nSpecify the URL of cascading style sheet to link from resulting HTML file. Default is\nnone style sheet.\n\ntitle\n--title=title\n\nSpecify the title of the resulting HTML file.\n\nquiet\n--quiet\n\nDon't display mostly harmless warning messages.\n\nnoquiet\n--noquiet\n\nDisplay mostly harmless warning messages (default behaviour). But this is not the same as\n\"verbose\" mode.\n\nverbose\n--verbose\n\nDisplay progress messages.\n\nnoverbose\n--noverbose\n\nDo not display progress messages (default behaviour).\n\n### AUTHOR\n\nTom Christiansen, .\n\n### BUGS\n\nSee Pod::Html for a list of known bugs in the translator.\n\n### SEE ALSO\n\nperlpod, Pod::Html\n\n### COPYRIGHT\n\nThis program is distributed under the Artistic License.\n\n\n\nperl v5.34.0 2025-07-25 POD2HTML(1)\n\n" } ], "structuredContent": { "command": "POD2HTML", "section": "1", "mode": "man", "summary": "pod2html - convert .pod files to .html files", "synopsis": "pod2html --help --htmldir= --htmlroot=\n--infile= --outfile=\n--podpath=:...: --podroot=\n--cachedir= --flush --recurse --norecurse\n--quiet --noquiet --verbose --noverbose\n--index --noindex --backlink --nobacklink\n--header --noheader --poderrors --nopoderrors\n--css= --title=", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 9, "subsections": [] }, { "name": "DESCRIPTION", "lines": 2, "subsections": [] }, { "name": "ARGUMENTS", "lines": 144, "subsections": [] }, { "name": "AUTHOR", "lines": 2, "subsections": [] }, { "name": "BUGS", "lines": 2, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "COPYRIGHT", "lines": 5, "subsections": [] } ] } }