version 2 showing authors affecting page license.
.
Rev |
Author |
# |
Line |
1 |
perry |
1 |
POD2LATEX |
|
|
2 |
!!!POD2LATEX |
|
|
3 |
NAME |
|
|
4 |
SYNOPSIS |
|
|
5 |
DESCRIPTION |
|
|
6 |
OPTIONS AND ARGUMENTS |
|
|
7 |
BUGS |
|
|
8 |
SEE ALSO |
|
|
9 |
AUTHOR |
|
|
10 |
---- |
|
|
11 |
!!NAME |
|
|
12 |
|
|
|
13 |
|
|
|
14 |
pod2latex - convert pod documentation to latex format |
|
|
15 |
!!SYNOPSIS |
|
|
16 |
|
|
|
17 |
|
|
|
18 |
pod2latex *.pm |
|
|
19 |
pod2latex -out mytex.tex *.pod |
|
|
20 |
pod2latex -full -sections 'DESCRIPTIONNAME' !SomeDir |
|
|
21 |
!!DESCRIPTION |
|
|
22 |
|
|
|
23 |
|
|
|
24 |
pod2latex is a program to convert POD format |
|
|
25 |
documentation (perlpod) into latex. It can process multiple |
|
|
26 |
input documents at a time and either generate a latex file |
|
|
27 |
per input document or a single combined output |
|
|
28 |
file. |
|
|
29 |
!!OPTIONS AND ARGUMENTS |
|
|
30 |
|
|
|
31 |
|
|
|
32 |
This section describes the supported command line options. |
|
|
33 |
Minium matching is supported. |
|
|
34 |
|
|
|
35 |
|
|
|
36 |
__-out__ |
|
|
37 |
|
|
|
38 |
|
|
|
39 |
Name of the output file to be used. If there are multiple |
|
|
40 |
input pods it is assumed that the intention is to write all |
|
|
41 |
translated output into a single file. .tex is |
|
|
42 |
appended if not present. If the argument is not supplied, a |
|
|
43 |
single document will be created for each input |
|
|
44 |
file. |
|
|
45 |
|
|
|
46 |
|
|
|
47 |
__-full__ |
|
|
48 |
|
|
|
49 |
|
|
|
50 |
Creates a complete latex file that can be processed |
|
|
51 |
immediately (unless =for/=begin directives are used |
|
|
52 |
that rely on extra packages). Table of contents and index |
|
|
53 |
generation commands are included in the wrapper |
|
|
54 |
latex code. |
|
|
55 |
|
|
|
56 |
|
|
|
57 |
__-sections__ |
|
|
58 |
|
|
|
59 |
|
|
|
60 |
Specify pod sections to include (or remove if negated) in |
|
|
61 |
the translation. See `` SECTION |
|
|
62 |
SPECIFICATIONS '' in Pod::Select for the format to |
|
|
63 |
use for ''section-spec''. This option may be given |
|
|
64 |
multiple times on the command line.This is identical to the |
|
|
65 |
similar option in the podselect() |
|
|
66 |
command. |
|
|
67 |
|
|
|
68 |
|
|
|
69 |
__-modify__ |
|
|
70 |
|
|
|
71 |
|
|
|
72 |
This option causes the output latex to be slightly |
|
|
73 |
modified from the input pod such that when a =head1 |
|
|
74 |
NAME is encountered a section is created containing the |
|
|
75 |
actual pod name (rather than __NAME__ ) |
|
|
76 |
and all subsequent =head1 directives are treated as |
|
|
77 |
subsections. This has the advantage that the description of |
|
|
78 |
a module will be in its own section which is helpful for |
|
|
79 |
including module descriptions in documentation. Also forces |
|
|
80 |
latex label and index entries to be prefixed by the |
|
|
81 |
name of the module. |
|
|
82 |
|
|
|
83 |
|
|
|
84 |
__-help__ |
|
|
85 |
|
|
|
86 |
|
|
|
87 |
Print a brief help message and exit. |
|
|
88 |
|
|
|
89 |
|
|
|
90 |
__-man__ |
|
|
91 |
|
|
|
92 |
|
|
|
93 |
Print the manual page and exit. |
|
|
94 |
|
|
|
95 |
|
|
|
96 |
__-verbose__ |
|
|
97 |
|
|
|
98 |
|
|
|
99 |
Print information messages as each document is |
|
|
100 |
processed. |
|
|
101 |
!!BUGS |
|
|
102 |
|
|
|
103 |
|
|
|
104 |
Known bugs are: |
|
|
105 |
|
|
|
106 |
|
|
|
107 |
Cross references between documents are not resolved when |
|
|
108 |
multiple pod documents are converted into a single output |
|
|
109 |
latex file. |
|
|
110 |
|
|
|
111 |
|
|
|
112 |
Functions and variables are not automatically recognized and |
|
|
113 |
they will therefore not be marked up in any special way |
|
|
114 |
unless instructed by an explicit pod command. |
|
|
115 |
!!SEE ALSO |
|
|
116 |
|
|
|
117 |
|
|
|
118 |
Pod::LaTeX |
|
|
119 |
!!AUTHOR |
|
|
120 |
|
|
|
121 |
|
|
|
122 |
Tim Jenness |
|
|
123 |
|
|
|
124 |
|
|
|
125 |
This program is free software; you can redistribute it |
|
|
126 |
and/or modify it under the same terms as Perl |
|
|
127 |
itself. |
|
|
128 |
|
|
|
129 |
|
|
|
130 |
Copyright (C) 2000 Tim Jenness. |
|
|
131 |
---- |