OS Manuals

/usr/bin/pod2html

Larry Wall's Practical Extraction and Report Language

From perl 5.44.0-r4 (os), captured 2026-11-05 by running pod2html --help (exit 255). permalink

Usage:  /usr/bin/pod2html --help --htmldir=<name> --htmlroot=<URL>
           --infile=<name> --outfile=<name>
           --podpath=<name>:...:<name> --podroot=<name>
           --cachedir=<name> --flush --recurse --norecurse
           --quiet --noquiet --verbose --noverbose
           --index --noindex --backlink --nobacklink
           --header --noheader --poderrors --nopoderrors
           --css=<URL> --title=<name>

  --[no]backlink  - turn =head1 directives into links pointing to the top of
                      the page (off by default).
  --cachedir      - directory for the directory cache files.
  --css           - stylesheet URL
  --flush         - flushes the directory cache.
  --[no]header    - produce block header/footer (default is no headers).
  --help          - prints this message.
  --htmldir       - directory for resulting HTML files.
  --htmlroot      - http-server base directory from which all relative paths
                      in podpath stem (default is /).
  --[no]index     - generate an index at the top of the resulting html
                      (default behaviour).
  --infile        - filename for the pod to convert (input taken from stdin
                      by default).
  --outfile       - filename for the resulting html file (output sent to
                      stdout by default).
  --[no]poderrors - include a POD ERRORS section in the output if there were
                      any POD errors in the input (default behavior).
  --podpath       - colon-separated list of directories containing library
                      pods (empty by default).
  --podroot       - filesystem base directory from which all relative paths
                      in podpath stem (default is .).
  --[no]quiet     - suppress some benign warning messages (default is off).
  --[no]recurse   - recurse on those subdirectories listed in podpath
                      (default behaviour).
  --title         - title that will appear in resulting html file.
  --[no]verbose   - self-explanatory (off by default).
Options (11)
OptionDescriptionSource
--infile namehelp
--podpath name>:...:<namehelp
--css URLhelp
--cachedir- directory for the directory cache files.help
--flush- flushes the directory cache.help
--help- prints this message.help
--htmldir- directory for resulting HTML files.help
--htmlroot- http-server base directory from which all relative paths in podpath stem (default is /).help
--outfile- filename for the resulting html file (output sent to stdout by default).help
--podroot- filesystem base directory from which all relative paths in podpath stem (default is .).help
--title- title that will appear in resulting html file.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.