Debian Codegraph @

upstream/debian-trixie/man1/pod2texi.1

raw
1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 . ds C`
42 . ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
60 . if \nF \{\
61 . de IX
62 . tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 . if !\nF==2 \{\
65 . nr % 0
66 . nr F 2
67 . \}
68 . \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
75 .if n \{\
76 . ds #H 0
77 . ds #V .8m
78 . ds #F .3m
79 . ds #[ \f1
80 . ds #] \fP
81 .\}
82 .if t \{\
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 . ds #V .6m
85 . ds #F 0
86 . ds #[ \&
87 . ds #] \&
88 .\}
89 . \" simple accents for nroff and troff
90 .if n \{\
91 . ds ' \&
92 . ds ` \&
93 . ds ^ \&
94 . ds , \&
95 . ds ~ ~
96 . ds /
97 .\}
98 .if t \{\
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 . ds : e
123 . ds 8 ss
124 . ds o a
125 . ds d- d\h'-1'\(ga
126 . ds D- D\h'-1'\(hy
127 . ds th \o'bp'
128 . ds Th \o'LP'
129 . ds ae ae
130 . ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "POD2TEXI 1"
136 .TH POD2TEXI 1 "2024-08-29" "perl v5.34.0" "User Contributed Perl Documentation"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 pod2texi \- convert Pod to Texinfo
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& pod2texi [OPTION]... POD...
147 .Ve
148 .SH "DESCRIPTION"
149 .IX Header "DESCRIPTION"
150 Translate Pod file(s) to Texinfo. There are two basic modes of
151 operation. First, by default, each Pod is translated to a standalone
152 Texinfo manual.
153 .PP
154 Second, if \f(CW\*(C`\-\-base\-level\*(C'\fR is set higher than 0, each Pod is translated
155 to a file suitable for \f(CW@include\fR, and one more file with a main menu
156 and all the \f(CW@include\fR is generated.
157 .SH "OPTIONS"
158 .IX Header "OPTIONS"
159 .IP "\fB\-\-appendix\-sections\fR" 4
160 .IX Item "--appendix-sections"
161 Use appendix sectioning commands (\f(CW@appendix\fR, ...) instead of the
162 default numbered sectioning Texinfo @\-commands (\f(CW@chapter\fR,
163 \&\f(CW@section\fR, ...).
164 .IP "\fB\-\-base\-level\fR=\fINUM|NAME\fR" 4
165 .IX Item "--base-level=NUM|NAME"
166 Sets the level of the \f(CW\*(C`head1\*(C'\fR commands. It may be an integer or a
167 Texinfo sectioning command (without the \f(CW\*(C`@\*(C'\fR): 1 corresponds to the
168 \&\f(CW@chapter\fR/\f(CW@unnumbered\fR level, 2 to the \f(CW@section\fR level, and so on.
169 The default is 0, meaning that \f(CW\*(C`head1\*(C'\fR commands are still output as
170 chapters, but the output is arranged as a standalone manual.
171 .Sp
172 If the level is not 0, the Pod file is rendered as a fragment of a
173 Texinfo manual suitable for \f(CW@include\fR. In this case, each Pod file
174 has an additional sectioning command covering the entire file, one level
175 above the \f(CW\*(C`\-\-base\-level\*(C'\fR value. Therefore, to make each Pod file a
176 chapter in a large manual, you should use \f(CW\*(C`section\*(C'\fR as the base level.
177 .Sp
178 For an example of making Texinfo out of the Perl documentation itself,
179 see \f(CW\*(C`contrib/perldoc\-all\*(C'\fR in the Texinfo source distribution.
180 .IP "\fB\-\-debug\fR=\fI\s-1NUM\s0\fR" 4
181 .IX Item "--debug=NUM"
182 Set debugging level to \fI\s-1NUM\s0\fR.
183 .IP "\fB\-\-headings\-as\-sections\fR" 4
184 .IX Item "--headings-as-sections"
185 Use headings commands (\f(CW@heading\fR, ...) instead of the
186 default numbered sectioning Texinfo @\-commands (\f(CW@chapter\fR,
187 \&\f(CW@section\fR, ...). The sectioning command covering the entire
188 file output for each Pod file if \fB\-\-base\-level\fR is not 0 is a
189 numbered command.
190 .IP "\fB\-\-help\fR" 4
191 .IX Item "--help"
192 Display help and exit.
193 .IP "\fB\-\-menus\fR" 4
194 .IX Item "--menus"
195 Output node menus. If there is a main manual, its Top node menu
196 is always output, since a master menu is generated. Other nodes
197 menus are not output in the default case.
198 .IP "\fB\-\-output\fR=\fI\s-1NAME\s0\fR" 4
199 .IX Item "--output=NAME"
200 Name for the first manual, or the main manual if there is a main manual.
201 Default is to write to standard output.
202 .IP "\fB\-\-no\-section\-nodes\fR" 4
203 .IX Item "--no-section-nodes"
204 Use anchors for sections instead of nodes.
205 .IP "\fB\-\-no\-fill\-section\-gaps\fR" 4
206 .IX Item "--no-fill-section-gaps"
207 Do not fill sectioning gaps with empty \f(CW@unnumbered\fR files.
208 Ordinarily, it's good to keep the sectioning hierarchy intact.
209 .IP "\fB\-\-preamble\fR=\fI\s-1STR\s0\fR" 4
210 .IX Item "--preamble=STR"
211 Insert \fI\s-1STR\s0\fR as top boilerplate before menu and includes. If \fI\s-1STR\s0\fR is
212 set to \f(CW\*(C`\-\*(C'\fR, read the top boilerplate from the standard input. The default top
213 boilerplate is a minimal beginning for a Texinfo document.
214 .IP "\fB\-\-setfilename\fR=\fI\s-1STR\s0\fR" 4
215 .IX Item "--setfilename=STR"
216 Use \fI\s-1STR\s0\fR in top boilerplate before menu and includes for \f(CW@setfilename\fR.
217 No \f(CW@setfilename\fR is output in the default case.
218 .IP "\fB\-\-subdir\fR=\fI\s-1NAME\s0\fR" 4
219 .IX Item "--subdir=NAME"
220 If there is a main manual with include files (each corresponding to
221 an input Pod file), then those include files are put in directory \fI\s-1NAME\s0\fR.
222 .IP "\fB\-\-unnumbered\-sections\fR" 4
223 .IX Item "--unnumbered-sections"
224 Use unnumbered sectioning commands (\f(CW@unnumbered\fR, ...) instead of the
225 default numbered sectioning Texinfo @\-commands (\f(CW@chapter\fR,
226 \&\f(CW@section\fR, ...).
227 .IP "\fB\-\-top\fR=\fI\s-1TOP\s0\fR" 4
228 .IX Item "--top=TOP"
229 Name of the \f(CW@top\fR element for the main manual. May contain Texinfo code.
230 .IP "\fB\-\-version\fR" 4
231 .IX Item "--version"
232 Display version information and exit.
233 .SH "SEE ALSO"
234 .IX Header "SEE ALSO"
235 Pod::Simple::Texinfo. perlpod. The Texinfo manual.
236 Texinfo home page: <http://www.gnu.org/software/texinfo/>
237 .SH "COPYRIGHT AND LICENSE"
238 .IX Header "COPYRIGHT AND LICENSE"
239 Copyright 2012\-2023 Free Software Foundation, Inc.
240 .PP
241 This program is free software; you can redistribute it and/or modify
242 it under the terms of the \s-1GNU\s0 General Public License as published by
243 the Free Software Foundation; either version 3 of the License,
244 or (at your option) any later version.
245 .PP
246 There is \s-1NO WARRANTY,\s0 to the extent permitted by law.
247 .SH "AUTHOR"
248 .IX Header "AUTHOR"
249 Patrice Dumas <bug\[email protected]>.