1POD2HTML(1)            Perl Programmers Reference Guide            POD2HTML(1)
2
3
4

NAME

6       pod2html - convert .pod files to .html files
7

SYNOPSIS

9           pod2html --help --htmldir=<name> --htmlroot=<URL>
10                    --infile=<name> --outfile=<name>
11                    --podpath=<name>:...:<name> --podroot=<name>
12                    --cachedir=<name> --flush --recurse --norecurse
13                    --quiet --noquiet --verbose --noverbose
14                    --index --noindex --backlink --nobacklink
15                    --header --noheader --poderrors --nopoderrors
16                    --css=<URL> --title=<name>
17

DESCRIPTION

19       Converts files from pod format (see perlpod) to HTML format.
20

ARGUMENTS

22       pod2html takes the following arguments:
23
24       backlink
25             --backlink
26             --nobacklink
27
28           Turn =head1 directives into links pointing to the top of the HTML
29           file.  --nobacklink (which is the default behavior) does not create
30           these backlinks.
31
32       cachedir
33             --cachedir=name
34
35           Specify which directory is used for storing cache. Default
36           directory is the current working directory.
37
38       css
39             --css=URL
40
41           Specify the URL of cascading style sheet to link from resulting
42           HTML file.  Default is none style sheet.
43
44       flush
45             --flush
46
47           Flush the cache.
48
49       header
50             --header
51             --noheader
52
53           Create header and footer blocks containing the text of the "NAME"
54           section.  --noheader -- which is the default behavior -- does not
55           create header or footer blocks.
56
57       help
58             --help
59
60           Displays the usage message.
61
62       htmldir
63             --htmldir=name
64
65           Sets the directory to which all cross references in the resulting
66           HTML file will be relative. Not passing this causes all links to be
67           absolute since this is the value that tells Pod::Html the root of
68           the documentation tree.
69
70           Do not use this and --htmlroot in the same call to pod2html; they
71           are mutually exclusive.
72
73       htmlroot
74             --htmlroot=URL
75
76           Sets the base URL for the HTML files.  When cross-references are
77           made, the HTML root is prepended to the URL.
78
79           Do not use this if relative links are desired: use --htmldir
80           instead.
81
82           Do not pass both this and --htmldir to pod2html; they are mutually
83           exclusive.
84
85       index
86             --index
87
88           Generate an index at the top of the HTML file (default behaviour).
89
90           noindex
91                 --noindex
92
93               Do not generate an index at the top of the HTML file.
94
95       infile
96             --infile=name
97
98           Specify the pod file to convert.  Input is taken from STDIN if no
99           infile is specified.
100
101       outfile
102             --outfile=name
103
104           Specify the HTML file to create.  Output goes to STDOUT if no
105           outfile is specified.
106
107       poderrors
108             --poderrors
109             --nopoderrors
110
111           Include a "POD ERRORS" section in the outfile if there were any POD
112           errors in the infile (default behaviour).  --nopoderrors does not
113           create this "POD ERRORS" section.
114
115       podpath
116             --podpath=name:...:name
117
118           Specify which subdirectories of the podroot contain pod files whose
119           HTML converted forms can be linked-to in cross-references.
120
121       podroot
122             --podroot=name
123
124           Specify the base directory for finding library pods.
125
126       quiet
127             --quiet
128             --noquiet
129
130           Don't display mostly harmless warning messages.  --noquiet -- which
131           is the default behavior -- does display these mostly harmless
132           warning messages (but this is not the same as "verbose" mode).
133
134       recurse
135             --recurse
136             --norecurse
137
138           Recurse into subdirectories specified in podpath (default
139           behaviour).  --norecurse does not recurse into these
140           subdirectories.
141
142       title
143             --title=title
144
145           Specify the title of the resulting HTML file.
146
147       verbose
148             --verbose
149             --noverbose
150
151           Display progress messages. --noverbose -- which is the default
152           behavior -- does not display these progress messages.
153

AUTHOR

155       Tom Christiansen, <tchrist@perl.com>.
156

BUGS

158       See Pod::Html for a list of known bugs in the translator.
159

SEE ALSO

161       perlpod, Pod::Html
162

164       This program is distributed under the Artistic License.
165
166
167
168perl v5.38.2                      2023-11-30                       POD2HTML(1)
Impressum