projects / OpenSPARC-T2-SAM / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / man / man3 / Pod::Html.3
CommitLineData
920dae64
AT		 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "Pod::Html 3"
132.TH Pod::Html 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
133.SH "NAME"
134Pod::Html \- module to convert pod files to HTML
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 2
138\& use Pod::Html;
139\& pod2html([options]);
140.Ve
141.SH "DESCRIPTION"
142.IX Header "DESCRIPTION"
143Converts files from pod format (see perlpod) to \s-1HTML\s0 format. It
144can automatically generate indexes and cross\-references, and it keeps
145a cache of things it knows how to cross\-reference.
146.SH "ARGUMENTS"
147.IX Header "ARGUMENTS"
148Pod::Html takes the following arguments:
149.IP "backlink" 4
150.IX Item "backlink"
151.Vb 1
152\& --backlink="Back to Top"
153.Ve
154.Sp
155Adds \*(L"Back to Top\*(R" links in front of every \f(CW\*(C`head1\*(C'\fR heading (except for
156the first). By default, no backlinks are generated.
157.IP "cachedir" 4
158.IX Item "cachedir"
159.Vb 1
160\& --cachedir=name
161.Ve
162.Sp
163Creates the item and directory caches in the given directory.
164.IP "css" 4
165.IX Item "css"
166.Vb 1
167\& --css=stylesheet
168.Ve
169.Sp
170Specify the \s-1URL\s0 of a cascading style sheet. Also disables all \s-1HTML/CSS\s0
171\&\f(CW\*(C`style\*(C'\fR attributes that are output by default (to avoid conflicts).
172.IP "flush" 4
173.IX Item "flush"
174.Vb 1
175\& --flush
176.Ve
177.Sp
178Flushes the item and directory caches.
179.IP "header" 4
180.IX Item "header"
181.Vb 2
182\& --header
183\& --noheader
184.Ve
185.Sp
186Creates header and footer blocks containing the text of the \f(CW\*(C`NAME\*(C'\fR
187section. By default, no headers are generated.
188.IP "help" 4
189.IX Item "help"
190.Vb 1
191\& --help
192.Ve
193.Sp
194Displays the usage message.
195.IP "hiddendirs" 4
196.IX Item "hiddendirs"
197.Vb 2
198\& --hiddendirs
199\& --nohiddendirs
200.Ve
201.Sp
202Include hidden directories in the search for \s-1POD\s0's in podpath if recurse
203is set.
204The default is not to traverse any directory whose name begins with \f(CW\*(C`.\*(C'\fR.
205See \*(L"podpath\*(R" and \*(L"recurse\*(R".
206.Sp
207[This option is for backward compatibility only.
208It's hard to imagine that one would usefully create a module with a
209name component beginning with \f(CW\*(C`.\*(C'\fR.]
210.IP "htmldir" 4
211.IX Item "htmldir"
212.Vb 1
213\& --htmldir=name
214.Ve
215.Sp
216Sets the directory in which the resulting \s-1HTML\s0 file is placed. This
217is used to generate relative links to other files. Not passing this
218causes all links to be absolute, since this is the value that tells
219Pod::Html the root of the documentation tree.
220.IP "htmlroot" 4
221.IX Item "htmlroot"
222.Vb 1
223\& --htmlroot=name
224.Ve
225.Sp
226Sets the base \s-1URL\s0 for the \s-1HTML\s0 files. When cross-references are made,
227the \s-1HTML\s0 root is prepended to the \s-1URL\s0.
228.IP "index" 4
229.IX Item "index"
230.Vb 2
231\& --index
232\& --noindex
233.Ve
234.Sp
235Generate an index at the top of the \s-1HTML\s0 file. This is the default
236behaviour.
237.IP "infile" 4
238.IX Item "infile"
239.Vb 1
240\& --infile=name
241.Ve
242.Sp
243Specify the pod file to convert. Input is taken from \s-1STDIN\s0 if no
244infile is specified.
245.IP "libpods" 4
246.IX Item "libpods"
247.Vb 1
248\& --libpods=name:...:name
249.Ve
250.Sp
251List of page names (eg, \*(L"perlfunc\*(R") which contain linkable \f(CW\*(C`=item\*(C'\fRs.
252.IP "netscape" 4
253.IX Item "netscape"
254.Vb 2
255\& --netscape
256\& --nonetscape
257.Ve
258.Sp
259\&\fBDeprecated\fR, has no effect. For backwards compatibility only.
260.IP "outfile" 4
261.IX Item "outfile"
262.Vb 1
263\& --outfile=name
264.Ve
265.Sp
266Specify the \s-1HTML\s0 file to create. Output goes to \s-1STDOUT\s0 if no outfile
267is specified.
268.IP "podpath" 4
269.IX Item "podpath"
270.Vb 1
271\& --podpath=name:...:name
272.Ve
273.Sp
274Specify which subdirectories of the podroot contain pod files whose
275\&\s-1HTML\s0 converted forms can be linked to in cross references.
276.IP "podroot" 4
277.IX Item "podroot"
278.Vb 1
279\& --podroot=name
280.Ve
281.Sp
282Specify the base directory for finding library pods.
283.IP "quiet" 4
284.IX Item "quiet"
285.Vb 2
286\& --quiet
287\& --noquiet
288.Ve
289.Sp
290Don't display \fImostly harmless\fR warning messages. These messages
291will be displayed by default. But this is not the same as \f(CW\*(C`verbose\*(C'\fR
292mode.
293.IP "recurse" 4
294.IX Item "recurse"
295.Vb 2
296\& --recurse
297\& --norecurse
298.Ve
299.Sp
300Recurse into subdirectories specified in podpath (default behaviour).
301.IP "title" 4
302.IX Item "title"
303.Vb 1
304\& --title=title
305.Ve
306.Sp
307Specify the title of the resulting \s-1HTML\s0 file.
308.IP "verbose" 4
309.IX Item "verbose"
310.Vb 2
311\& --verbose
312\& --noverbose
313.Ve
314.Sp
315Display progress messages. By default, they won't be displayed.
316.SH "EXAMPLE"
317.IX Header "EXAMPLE"
318.Vb 8
319\& pod2html("pod2html",
320\& "--podpath=lib:ext:pod:vms",
321\& "--podroot=/usr/src/perl",
322\& "--htmlroot=/perl/nmanual",
323\& "--libpods=perlfunc:perlguts:perlvar:perlrun:perlop",
324\& "--recurse",
325\& "--infile=foo.pod",
326\& "--outfile=/perl/nmanual/foo.html");
327.Ve
328.SH "ENVIRONMENT"
329.IX Header "ENVIRONMENT"
330Uses \f(CW$Config{pod2html}\fR to setup default options.
331.SH "AUTHOR"
332.IX Header "AUTHOR"
333Tom Christiansen, <tchrist@perl.com>.
334.SH "SEE ALSO"
335.IX Header "SEE ALSO"
336perlpod
337.SH "COPYRIGHT"
338.IX Header "COPYRIGHT"
339This program is distributed under the Artistic License.
Full OpenSPARC architecture tarball including simulator, hypervisor, and OBP.