Penguin
Recent Changes
Annotated edit history of pod2html(1) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 POD2HTML
2 !!!POD2HTML
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 ARGUMENTS
7 AUTHOR
8 BUGS
9 SEE ALSO
10 COPYRIGHT
11 ----
12 !!NAME
13
14
15 pod2html - convert .pod files to .html files
16 !!SYNOPSIS
17
18
19 pod2html --help --htmlroot=
20 !!DESCRIPTION
21
22
23 Converts files from pod format (see perlpod) to
24 HTML format.
25 !!ARGUMENTS
26
27
28 pod2html takes the following arguments:
29
30
31 help
32
33
34 --help
35 Displays the usage message.
36
37
38 htmlroot
39
40
41 --htmlroot=name
42 Sets the base URL for the HTML files. When cross-references are made, the HTML root is prepended to the URL .
43
44
45 infile
46
47
48 --infile=name
49 Specify the pod file to convert. Input is taken from STDIN if no infile is specified.
50
51
52 outfile
53
54
55 --outfile=name
56 Specify the HTML file to create. Output goes to STDOUT if no outfile is specified.
57
58
59 podroot
60
61
62 --podroot=name
63 Specify the base directory for finding library pods.
64
65
66 podpath
67
68
69 --podpath=name:...:name
70 Specify which subdirectories of the podroot contain pod files whose HTML converted forms can be linked-to in cross-references.
71
72
73 libpods
74
75
76 --libpods=name:...:name
77 List of page names (eg, ``perlfunc'') which contain linkable =items.
78
79
80 netscape
81
82
83 --netscape
84 Use Netscape HTML directives when applicable.
85
86
87 nonetscape
88
89
90 --nonetscape
91 Do not use Netscape HTML directives (default).
92
93
94 index
95
96
97 --index
98 Generate an index at the top of the HTML file (default behaviour).
99
100
101 noindex
102
103
104 --noindex
105 Do not generate an index at the top of the HTML file.
106
107
108 recurse
109
110
111 --recurse
112 Recurse into subdirectories specified in podpath (default behaviour).
113
114
115 norecurse
116
117
118 --norecurse
119 Do not recurse into subdirectories specified in podpath.
120
121
122 title
123
124
125 --title=title
126 Specify the title of the resulting HTML file.
127
128
129 verbose
130
131
132 --verbose
133 Display progress messages.
134 !!AUTHOR
135
136
137 Tom Christiansen,
138 !!BUGS
139
140
141 See Pod::Html for a list of known bugs in the
142 translator.
143 !!SEE ALSO
144
145
146 perlpod, Pod::Html
147 !!COPYRIGHT
148
149
150 This program is distributed under the Artistic
151 License.
152 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.