1Pod::Html(3pm) Perl Programmers Reference Guide Pod::Html(3pm)
2
3
4
6 Pod::Html - module to convert pod files to HTML
7
9 use Pod::Html;
10 pod2html([options]);
11
13 Converts files from pod format (see perlpod) to HTML format. It can
14 automatically generate indexes and cross-references, and it keeps a
15 cache of things it knows how to cross-reference.
16
18 pod2html
19 pod2html("pod2html",
20 "--podpath=lib:ext:pod:vms",
21 "--podroot=/usr/src/perl",
22 "--htmlroot=/perl/nmanual",
23 "--libpods=perlfunc:perlguts:perlvar:perlrun:perlop",
24 "--recurse",
25 "--infile=foo.pod",
26 "--outfile=/perl/nmanual/foo.html");
27
28 pod2html takes the following arguments:
29
30 backlink
31 --backlink="Back to Top"
32
33 Adds "Back to Top" links in front of every "head1" heading (except
34 for the first). By default, no backlinks are generated.
35
36 cachedir
37 --cachedir=name
38
39 Creates the item and directory caches in the given directory.
40
41 css
42 --css=stylesheet
43
44 Specify the URL of a cascading style sheet. Also disables all
45 HTML/CSS "style" attributes that are output by default (to avoid
46 conflicts).
47
48 flush
49 --flush
50
51 Flushes the item and directory caches.
52
53 header
54 --header
55 --noheader
56
57 Creates header and footer blocks containing the text of the "NAME"
58 section. By default, no headers are generated.
59
60 help
61 --help
62
63 Displays the usage message.
64
65 hiddendirs
66 --hiddendirs
67 --nohiddendirs
68
69 Include hidden directories in the search for POD's in podpath if
70 recurse is set. The default is not to traverse any directory whose
71 name begins with ".". See "podpath" and "recurse".
72
73 [This option is for backward compatibility only. It's hard to
74 imagine that one would usefully create a module with a name
75 component beginning with ".".]
76
77 htmldir
78 --htmldir=name
79
80 Sets the directory in which the resulting HTML file is placed.
81 This is used to generate relative links to other files. Not passing
82 this causes all links to be absolute, since this is the value that
83 tells Pod::Html the root of the documentation tree.
84
85 htmlroot
86 --htmlroot=name
87
88 Sets the base URL for the HTML files. When cross-references are
89 made, the HTML root is prepended to the URL.
90
91 index
92 --index
93 --noindex
94
95 Generate an index at the top of the HTML file. This is the default
96 behaviour.
97
98 infile
99 --infile=name
100
101 Specify the pod file to convert. Input is taken from STDIN if no
102 infile is specified.
103
104 libpods
105 --libpods=name:...:name
106
107 List of page names (eg, "perlfunc") which contain linkable
108 "=item"s.
109
110 netscape
111 --netscape
112 --nonetscape
113
114 Deprecated, has no effect. For backwards compatibility only.
115
116 outfile
117 --outfile=name
118
119 Specify the HTML file to create. Output goes to STDOUT if no
120 outfile is specified.
121
122 podpath
123 --podpath=name:...:name
124
125 Specify which subdirectories of the podroot contain pod files whose
126 HTML converted forms can be linked to in cross references.
127
128 podroot
129 --podroot=name
130
131 Specify the base directory for finding library pods.
132
133 quiet
134 --quiet
135 --noquiet
136
137 Don't display mostly harmless warning messages. These messages
138 will be displayed by default. But this is not the same as
139 "verbose" mode.
140
141 recurse
142 --recurse
143 --norecurse
144
145 Recurse into subdirectories specified in podpath (default
146 behaviour).
147
148 title
149 --title=title
150
151 Specify the title of the resulting HTML file.
152
153 verbose
154 --verbose
155 --noverbose
156
157 Display progress messages. By default, they won't be displayed.
158
159 htmlify
160 htmlify($heading);
161
162 Converts a pod section specification to a suitable section
163 specification for HTML. Note that we keep spaces and special characters
164 except "", ?" (Netscape problem) and the hyphen (writer's problem...).
165
166 anchorify
167 anchorify(@heading);
168
169 Similar to "htmlify()", but turns non-alphanumerics into underscores.
170 Note that "anchorify()" is not exported by default.
171
173 Uses $Config{pod2html} to setup default options.
174
176 Tom Christiansen, <tchrist@perl.com>.
177
179 perlpod
180
182 This program is distributed under the Artistic License.
183
184
185
186perl v5.10.1 2009-02-12 Pod::Html(3pm)