Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 |
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::LaTeX 3" | |
132 | .TH Pod::LaTeX 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide" | |
133 | .SH "NAME" | |
134 | Pod::LaTeX \- Convert Pod data to formatted Latex | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | .Vb 2 | |
138 | \& use Pod::LaTeX; | |
139 | \& my $parser = Pod::LaTeX->new ( ); | |
140 | .Ve | |
141 | .PP | |
142 | .Vb 1 | |
143 | \& $parser->parse_from_filehandle; | |
144 | .Ve | |
145 | .PP | |
146 | .Vb 1 | |
147 | \& $parser->parse_from_file ('file.pod', 'file.tex'); | |
148 | .Ve | |
149 | .SH "DESCRIPTION" | |
150 | .IX Header "DESCRIPTION" | |
151 | \&\f(CW\*(C`Pod::LaTeX\*(C'\fR is a module to convert documentation in the Pod format | |
152 | into Latex. The \fBpod2latex\fR command uses | |
153 | this module for translation. | |
154 | .IX Xref "pod2latex" | |
155 | .PP | |
156 | \&\f(CW\*(C`Pod::LaTeX\*(C'\fR is a derived class from Pod::Select. | |
157 | .SH "OBJECT METHODS" | |
158 | .IX Header "OBJECT METHODS" | |
159 | The following methods are provided in this module. Methods inherited | |
160 | from \f(CW\*(C`Pod::Select\*(C'\fR are not described in the public interface. | |
161 | .Sh "Data Accessors" | |
162 | .IX Subsection "Data Accessors" | |
163 | The following methods are provided for accessing instance data. These | |
164 | methods should be used for accessing configuration parameters rather | |
165 | than assuming the object is a hash. | |
166 | .PP | |
167 | Default values can be supplied by using these names as keys to a hash | |
168 | of arguments when using the \f(CW\*(C`new()\*(C'\fR constructor. | |
169 | .IP "\fBAddPreamble\fR" 4 | |
170 | .IX Item "AddPreamble" | |
171 | Logical to control whether a \f(CW\*(C`latex\*(C'\fR preamble is to be written. | |
172 | If true, a valid \f(CW\*(C`latex\*(C'\fR preamble is written before the pod data | |
173 | is written. This is similar to: | |
174 | .Sp | |
175 | .Vb 2 | |
176 | \& \edocumentclass{article} | |
177 | \& \ebegin{document} | |
178 | .Ve | |
179 | .Sp | |
180 | but will be more complicated if table of contents and indexing are required. | |
181 | Can be used to set or retrieve the current value. | |
182 | .Sp | |
183 | .Vb 2 | |
184 | \& $add = $parser->AddPreamble(); | |
185 | \& $parser->AddPreamble(1); | |
186 | .Ve | |
187 | .Sp | |
188 | If used in conjunction with \f(CW\*(C`AddPostamble\*(C'\fR a full latex document will | |
189 | be written that could be immediately processed by \f(CW\*(C`latex\*(C'\fR. | |
190 | .IP "\fBAddPostamble\fR" 4 | |
191 | .IX Item "AddPostamble" | |
192 | Logical to control whether a standard \f(CW\*(C`latex\*(C'\fR ending is written to | |
193 | the output file after the document has been processed. In its | |
194 | simplest form this is simply: | |
195 | .Sp | |
196 | .Vb 1 | |
197 | \& \eend{document} | |
198 | .Ve | |
199 | .Sp | |
200 | but can be more complicated if an index is required. | |
201 | Can be used to set or retrieve the current value. | |
202 | .Sp | |
203 | .Vb 2 | |
204 | \& $add = $parser->AddPostamble(); | |
205 | \& $parser->AddPostamble(1); | |
206 | .Ve | |
207 | .Sp | |
208 | If used in conjunction with \f(CW\*(C`AddPreaamble\*(C'\fR a full latex document will | |
209 | be written that could be immediately processed by \f(CW\*(C`latex\*(C'\fR. | |
210 | .IP "\fBHead1Level\fR" 4 | |
211 | .IX Item "Head1Level" | |
212 | The \f(CW\*(C`latex\*(C'\fR sectioning level that should be used to correspond to | |
213 | a pod \f(CW\*(C`=head1\*(C'\fR directive. This can be used, for example, to turn | |
214 | a \f(CW\*(C`=head1\*(C'\fR into a \f(CW\*(C`latex\*(C'\fR \f(CW\*(C`subsection\*(C'\fR. This should hold a number | |
215 | corresponding to the required position in an array containing the | |
216 | following elements: | |
217 | .Sp | |
218 | .Vb 6 | |
219 | \& [0] chapter | |
220 | \& [1] section | |
221 | \& [2] subsection | |
222 | \& [3] subsubsection | |
223 | \& [4] paragraph | |
224 | \& [5] subparagraph | |
225 | .Ve | |
226 | .Sp | |
227 | Can be used to set or retrieve the current value: | |
228 | .Sp | |
229 | .Vb 2 | |
230 | \& $parser->Head1Level(2); | |
231 | \& $sect = $parser->Head1Level; | |
232 | .Ve | |
233 | .Sp | |
234 | Setting this number too high can result in sections that may not be | |
235 | reproducible in the expected way. For example, setting this to 4 would | |
236 | imply that \f(CW\*(C`=head3\*(C'\fR do not have a corresponding \f(CW\*(C`latex\*(C'\fR section | |
237 | (\f(CW\*(C`=head1\*(C'\fR would correspond to a \f(CW\*(C`paragraph\*(C'\fR). | |
238 | .Sp | |
239 | A check is made to ensure that the supplied value is an integer in the | |
240 | range 0 to 5. | |
241 | .Sp | |
242 | Default is for a value of 1 (i.e. a \f(CW\*(C`section\*(C'\fR). | |
243 | .IP "\fBLabel\fR" 4 | |
244 | .IX Item "Label" | |
245 | This is the label that is prefixed to all \f(CW\*(C`latex\*(C'\fR label and index | |
246 | entries to make them unique. In general, pods have similarly titled | |
247 | sections (\s-1NAME\s0, \s-1DESCRIPTION\s0 etc) and a \f(CW\*(C`latex\*(C'\fR label will be multiply | |
248 | defined if more than one pod document is to be included in a single | |
249 | \&\f(CW\*(C`latex\*(C'\fR file. To overcome this, this label is prefixed to a label | |
250 | whenever a label is required (joined with an underscore) or to an | |
251 | index entry (joined by an exclamation mark which is the normal index | |
252 | separator). For example, \f(CW\*(C`\elabel{text}\*(C'\fR becomes \f(CW\*(C`\elabel{Label_text}\*(C'\fR. | |
253 | .Sp | |
254 | Can be used to set or retrieve the current value: | |
255 | .Sp | |
256 | .Vb 2 | |
257 | \& $label = $parser->Label; | |
258 | \& $parser->Label($label); | |
259 | .Ve | |
260 | .Sp | |
261 | This label is only used if \f(CW\*(C`UniqueLabels\*(C'\fR is true. | |
262 | Its value is set automatically from the \f(CW\*(C`NAME\*(C'\fR field | |
263 | if \f(CW\*(C`ReplaceNAMEwithSection\*(C'\fR is true. If this is not the case | |
264 | it must be set manually before starting the parse. | |
265 | .Sp | |
266 | Default value is \f(CW\*(C`undef\*(C'\fR. | |
267 | .IP "\fBLevelNoNum\fR" 4 | |
268 | .IX Item "LevelNoNum" | |
269 | Control the point at which \f(CW\*(C`latex\*(C'\fR section numbering is turned off. | |
270 | For example, this can be used to make sure that \f(CW\*(C`latex\*(C'\fR sections | |
271 | are numbered but subsections are not. | |
272 | .Sp | |
273 | Can be used to set or retrieve the current value: | |
274 | .Sp | |
275 | .Vb 2 | |
276 | \& $lev = $parser->LevelNoNum; | |
277 | \& $parser->LevelNoNum(2); | |
278 | .Ve | |
279 | .Sp | |
280 | The argument must be an integer between 0 and 5 and is the same as the | |
281 | number described in \f(CW\*(C`Head1Level\*(C'\fR method description. The number has | |
282 | nothing to do with the pod heading number, only the \f(CW\*(C`latex\*(C'\fR sectioning. | |
283 | .Sp | |
284 | Default is 2. (i.e. \f(CW\*(C`latex\*(C'\fR subsections are written as \f(CW\*(C`subsection*\*(C'\fR | |
285 | but sections are numbered). | |
286 | .IP "\fBMakeIndex\fR" 4 | |
287 | .IX Item "MakeIndex" | |
288 | Controls whether \f(CW\*(C`latex\*(C'\fR commands for creating an index are to be inserted | |
289 | into the preamble and postamble | |
290 | .Sp | |
291 | .Vb 2 | |
292 | \& $makeindex = $parser->MakeIndex; | |
293 | \& $parser->MakeIndex(0); | |
294 | .Ve | |
295 | .Sp | |
296 | Irrelevant if both \f(CW\*(C`AddPreamble\*(C'\fR and \f(CW\*(C`AddPostamble\*(C'\fR are false | |
297 | (or equivalently, \f(CW\*(C`UserPreamble\*(C'\fR and \f(CW\*(C`UserPostamble\*(C'\fR are set). | |
298 | .Sp | |
299 | Default is for an index to be created. | |
300 | .IP "\fBReplaceNAMEwithSection\fR" 4 | |
301 | .IX Item "ReplaceNAMEwithSection" | |
302 | This controls whether the \f(CW\*(C`NAME\*(C'\fR section in the pod is to be translated | |
303 | literally or converted to a slightly modified output where the section | |
304 | name is the pod name rather than \*(L"\s-1NAME\s0\*(R". | |
305 | .Sp | |
306 | If true, the pod segment | |
307 | .Sp | |
308 | .Vb 1 | |
309 | \& =head1 NAME | |
310 | .Ve | |
311 | .Sp | |
312 | .Vb 1 | |
313 | \& pod::name - purpose | |
314 | .Ve | |
315 | .Sp | |
316 | .Vb 1 | |
317 | \& =head1 SYNOPSIS | |
318 | .Ve | |
319 | .Sp | |
320 | is converted to the \f(CW\*(C`latex\*(C'\fR | |
321 | .Sp | |
322 | .Vb 1 | |
323 | \& \esection{pod::name\elabel{pod_name}\eindex{pod::name}} | |
324 | .Ve | |
325 | .Sp | |
326 | .Vb 1 | |
327 | \& Purpose | |
328 | .Ve | |
329 | .Sp | |
330 | .Vb 2 | |
331 | \& \esubsection*{SYNOPSIS\elabel{pod_name_SYNOPSIS}% | |
332 | \& \eindex{pod::name!SYNOPSIS}} | |
333 | .Ve | |
334 | .Sp | |
335 | (dependent on the value of \f(CW\*(C`Head1Level\*(C'\fR and \f(CW\*(C`LevelNoNum\*(C'\fR). Note that | |
336 | subsequent \f(CW\*(C`head1\*(C'\fR directives translate to subsections rather than | |
337 | sections and that the labels and index now include the pod name (dependent | |
338 | on the value of \f(CW\*(C`UniqueLabels\*(C'\fR). | |
339 | .Sp | |
340 | The \f(CW\*(C`Label\*(C'\fR is set from the pod name regardless of any current value | |
341 | of \f(CW\*(C`Label\*(C'\fR. | |
342 | .Sp | |
343 | .Vb 2 | |
344 | \& $mod = $parser->ReplaceNAMEwithSection; | |
345 | \& $parser->ReplaceNAMEwithSection(0); | |
346 | .Ve | |
347 | .Sp | |
348 | Default is to translate the pod literally. | |
349 | .IP "\fBStartWithNewPage\fR" 4 | |
350 | .IX Item "StartWithNewPage" | |
351 | If true, each pod translation will begin with a \f(CW\*(C`latex\*(C'\fR | |
352 | \&\f(CW\*(C`\eclearpage\*(C'\fR. | |
353 | .Sp | |
354 | .Vb 2 | |
355 | \& $parser->StartWithNewPage(1); | |
356 | \& $newpage = $parser->StartWithNewPage; | |
357 | .Ve | |
358 | .Sp | |
359 | Default is false. | |
360 | .IP "\fBTableOfContents\fR" 4 | |
361 | .IX Item "TableOfContents" | |
362 | If true, a table of contents will be created. | |
363 | Irrelevant if \f(CW\*(C`AddPreamble\*(C'\fR is false or \f(CW\*(C`UserPreamble\*(C'\fR | |
364 | is set. | |
365 | .Sp | |
366 | .Vb 2 | |
367 | \& $toc = $parser->TableOfContents; | |
368 | \& $parser->TableOfContents(1); | |
369 | .Ve | |
370 | .Sp | |
371 | Default is false. | |
372 | .IP "\fBUniqueLabels\fR" 4 | |
373 | .IX Item "UniqueLabels" | |
374 | If true, the translator will attempt to make sure that | |
375 | each \f(CW\*(C`latex\*(C'\fR label or index entry will be uniquely identified | |
376 | by prefixing the contents of \f(CW\*(C`Label\*(C'\fR. This allows | |
377 | multiple documents to be combined without clashing | |
378 | common labels such as \f(CW\*(C`DESCRIPTION\*(C'\fR and \f(CW\*(C`SYNOPSIS\*(C'\fR | |
379 | .Sp | |
380 | .Vb 2 | |
381 | \& $parser->UniqueLabels(1); | |
382 | \& $unq = $parser->UniqueLabels; | |
383 | .Ve | |
384 | .Sp | |
385 | Default is true. | |
386 | .IP "\fBUserPreamble\fR" 4 | |
387 | .IX Item "UserPreamble" | |
388 | User supplied \f(CW\*(C`latex\*(C'\fR preamble. Added before the pod translation | |
389 | data. | |
390 | .Sp | |
391 | If set, the contents will be prepended to the output file before | |
392 | the translated data regardless of the value of \f(CW\*(C`AddPreamble\*(C'\fR. | |
393 | \&\f(CW\*(C`MakeIndex\*(C'\fR and \f(CW\*(C`TableOfContents\*(C'\fR will also be ignored. | |
394 | .IP "\fBUserPostamble\fR" 4 | |
395 | .IX Item "UserPostamble" | |
396 | User supplied \f(CW\*(C`latex\*(C'\fR postamble. Added after the pod translation | |
397 | data. | |
398 | .Sp | |
399 | If set, the contents will be prepended to the output file after | |
400 | the translated data regardless of the value of \f(CW\*(C`AddPostamble\*(C'\fR. | |
401 | \&\f(CW\*(C`MakeIndex\*(C'\fR will also be ignored. | |
402 | .SH "NOTES" | |
403 | .IX Header "NOTES" | |
404 | Compatible with \f(CW\*(C`latex2e\*(C'\fR only. Can not be used with \f(CW\*(C`latex\*(C'\fR v2.09 | |
405 | or earlier. | |
406 | .PP | |
407 | A subclass of \f(CW\*(C`Pod::Select\*(C'\fR so that specific pod sections can be | |
408 | converted to \f(CW\*(C`latex\*(C'\fR by using the \f(CW\*(C`select\*(C'\fR method. | |
409 | .PP | |
410 | Some \s-1HTML\s0 escapes are missing and many have not been tested. | |
411 | .SH "SEE ALSO" | |
412 | .IX Header "SEE ALSO" | |
413 | Pod::Parser, Pod::Select, pod2latex | |
414 | .SH "AUTHORS" | |
415 | .IX Header "AUTHORS" | |
416 | Tim Jenness <t.jenness@jach.hawaii.edu> | |
417 | .PP | |
418 | Bug fixes have been received from: Simon Cozens | |
419 | <simon@cozens.net>, Mark A. Hershberger | |
420 | <mah@everybody.org>, Marcel Grunauer | |
421 | <marcel@codewerk.com> and Hugh S Myers | |
422 | <hsmyers@sdragons.com>. | |
423 | .SH "COPYRIGHT" | |
424 | .IX Header "COPYRIGHT" | |
425 | Copyright (C) 2000\-2001 Tim Jenness. All Rights Reserved. | |
426 | .PP | |
427 | This program is free software; you can redistribute it and/or modify | |
428 | it under the same terms as Perl itself. |