1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
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<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
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.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
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
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
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'
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 \
129 .\" ========================================================================
131 .IX Title "Pod::Simple::HTML 3"
132 .TH Pod::Simple::HTML 3 "2009-10-26" "perl v5.8.7" "User Contributed Perl Documentation"
134 Pod::Simple::HTML \- convert Pod to HTML
136 .IX Header "SYNOPSIS"
138 \& perl \-MPod::Simple::HTML \-e Pod::Simple::HTML::go thingy.pod
141 .IX Header "DESCRIPTION"
142 This class is for making an \s-1HTML\s0 rendering of a Pod document.
144 This is a subclass of Pod::Simple::PullParser and inherits all its
145 methods (and options).
147 Note that if you want to do a batch conversion of a lot of Pod
148 documents to \s-1HTML\s0, you should see the module Pod::Simple::HTMLBatch.
149 .SH "CALLING FROM THE COMMAND LINE"
150 .IX Header "CALLING FROM THE COMMAND LINE"
154 \& perl \-MPod::Simple::HTML \-e Pod::Simple::HTML::go Thing.pod Thing.html
156 .SH "CALLING FROM PERL"
157 .IX Header "CALLING FROM PERL"
158 \&\s-1TODO\s0 make a new object, set any options, and use parse_from_file
162 all (most?) accessorized methods
164 .IX Header "SUBCLASSING"
168 \& can just set any of: html_css html_javascript title_prefix
169 \& 'html_header_before_title',
170 \& 'html_header_after_title',
174 maybe override do_pod_link
176 maybe override do_beginning do_end
178 .IX Header "SEE ALSO"
179 Pod::Simple, Pod::Simple::HTMLBatch
181 \&\s-1TODO:\s0 a corpus of sample Pod input and \s-1HTML\s0 output? Or common
183 .SH "COPYRIGHT AND DISCLAIMERS"
184 .IX Header "COPYRIGHT AND DISCLAIMERS"
185 Copyright (c) 2002\-2004 Sean M. Burke. All rights reserved.
187 This library is free software; you can redistribute it and/or modify it
188 under the same terms as Perl itself.
190 This program is distributed in the hope that it will be useful, but
191 without any warranty; without even the implied warranty of
192 merchantability or fitness for a particular purpose.
195 Sean M. Burke \f(CW\*(C`sburke@cpan.org\*(C'\fR