Pod::Html(3pm)

1Pod::Html(3pm)         Perl Programmers Reference Guide         Pod::Html(3pm)
2
3
4

NAME

6       Pod::Html - module to convert pod files to HTML
7

SYNOPSIS

9           use Pod::Html;
10           pod2html([options]);
11

DESCRIPTION

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

ARGUMENTS

18       Pod::Html takes the following arguments:
19
20       backlink
21               --backlink="Back to Top"
22
23           Adds "Back to Top" links in front of every "head1" heading (except
24           for the first).  By default, no backlinks are generated.
25
26       cachedir
27               --cachedir=name
28
29           Creates the item and directory caches in the given directory.
30
31       css
32               --css=stylesheet
33
34           Specify the URL of a cascading style sheet.  Also disables all
35           HTML/CSS "style" attributes that are output by default (to avoid
36           conflicts).
37
38       flush
39               --flush
40
41           Flushes the item and directory caches.
42
43       header
44               --header
45               --noheader
46
47           Creates header and footer blocks containing the text of the "NAME"
48           section.  By default, no headers are generated.
49
50       help
51               --help
52
53           Displays the usage message.
54
55       hiddendirs
56               --hiddendirs
57               --nohiddendirs
58
59           Include hidden directories in the search for POD's in podpath if
60           recurse is set.  The default is not to traverse any directory whose
61           name begins with ".".  See "podpath" and "recurse".
62
63           [This option is for backward compatibility only.  It's hard to
64           imagine that one would usefully create a module with a name compo‐
65           nent beginning with ".".]
66
67       htmldir
68               --htmldir=name
69
70           Sets the directory in which the resulting HTML file is placed.
71           This is used to generate relative links to other files. Not passing
72           this causes all links to be absolute, since this is the value that
73           tells Pod::Html the root of the documentation tree.
74
75       htmlroot
76               --htmlroot=name
77
78           Sets the base URL for the HTML files.  When cross-references are
79           made, the HTML root is prepended to the URL.
80
81       index
82               --index
83               --noindex
84
85           Generate an index at the top of the HTML file.  This is the default
86           behaviour.
87
88       infile
89               --infile=name
90
91           Specify the pod file to convert.  Input is taken from STDIN if no
92           infile is specified.
93
94       libpods
95               --libpods=name:...:name
96
97           List of page names (eg, "perlfunc") which contain linkable
98           "=item"s.
99
100       netscape
101               --netscape
102               --nonetscape
103
104           Deprecated, has no effect. For backwards compatibility only.
105
106       outfile
107               --outfile=name
108
109           Specify the HTML file to create.  Output goes to STDOUT if no out‐
110           file is specified.
111
112       podpath
113               --podpath=name:...:name
114
115           Specify which subdirectories of the podroot contain pod files whose
116           HTML converted forms can be linked to in cross references.
117
118       podroot
119               --podroot=name
120
121           Specify the base directory for finding library pods.
122
123       quiet
124               --quiet
125               --noquiet
126
127           Don't display mostly harmless warning messages.  These messages
128           will be displayed by default.  But this is not the same as "ver‐
129           bose" mode.
130
131       recurse
132               --recurse
133               --norecurse
134
135           Recurse into subdirectories specified in podpath (default behav‐
136           iour).
137
138       title
139               --title=title
140
141           Specify the title of the resulting HTML file.
142
143       verbose
144               --verbose
145               --noverbose
146
147           Display progress messages.  By default, they won't be displayed.
148

EXAMPLE

150           pod2html("pod2html",
151                    "--podpath=lib:ext:pod:vms",
152                    "--podroot=/usr/src/perl",
153                    "--htmlroot=/perl/nmanual",
154                    "--libpods=perlfunc:perlguts:perlvar:perlrun:perlop",
155                    "--recurse",
156                    "--infile=foo.pod",
157                    "--outfile=/perl/nmanual/foo.html");
158

ENVIRONMENT

160       Uses $Config{pod2html} to setup default options.
161

AUTHOR

163       Tom Christiansen, <tchrist@perl.com>.
164

COPYRIGHT

169       This program is distributed under the Artistic License.
170
171
172
173perl v5.8.8                       2001-09-21                    Pod::Html(3pm)