1POD2TEXI(1)           User Contributed Perl Documentation          POD2TEXI(1)
2
3
4

NAME

6       pod2texi - convert Pod to Texinfo
7

SYNOPSIS

9         pod2texi [OPTION]... POD...
10

DESCRIPTION

12       Translate Pod file(s) to Texinfo.  There are two basic modes of
13       operation.  First, by default, each Pod is translated to a standalone
14       Texinfo manual.
15
16       Second, if "--base-level" is set higher than 0, each Pod is translated
17       to a file suitable for @include, and one more file with a main menu and
18       all the @include is generated.
19

OPTIONS

21       --appendix-sections
22           Use appendix sectioning commands (@appendix, ...) instead of the
23           default numbered sectioning Texinfo @-commands (@chapter, @section,
24           ...).
25
26       --base-level=NUM|NAME
27           Sets the level of the "head1" commands.  It may be an integer or a
28           Texinfo sectioning command (without the "@"): 1 corresponds to the
29           @chapter/@unnumbered level, 2 to the @section level, and so on.
30           The default is 0, meaning that "head1" commands are still output as
31           chapters, but the output is arranged as a standalone manual.
32
33           If the level is not 0, the Pod file is rendered as a fragment of a
34           Texinfo manual suitable for @include.  In this case, each Pod file
35           has an additional sectioning command covering the entire file, one
36           level above the "--base-level" value.  Therefore, to make each Pod
37           file a chapter in a large manual, you should use "section" as the
38           base level.
39
40           For an example of making Texinfo out of the Perl documentation
41           itself, see "contrib/perldoc-all" in the Texinfo source
42           distribution.
43
44       --debug=NUM
45           Set debugging level to NUM.
46
47       --headings-as-sections
48           Use headings commands (@heading, ...) instead of the default
49           numbered sectioning Texinfo @-commands (@chapter, @section, ...).
50           The sectioning command covering the entire file output for each Pod
51           file if --base-level is not 0 is a numbered command.
52
53       --help
54           Display help and exit.
55
56       --menus
57           Output node menus. If there is a main manual, its Top node menu is
58           always output, since a master menu is generated. Other nodes menus
59           are not output in the default case.
60
61       --output=NAME
62           Name for the first manual, or the main manual if there is a main
63           manual.  Default is to write to standard output.
64
65       --no-section-nodes
66           Use anchors for sections instead of nodes.
67
68       --no-fill-section-gaps
69           Do not fill sectioning gaps with empty @unnumbered files.
70           Ordinarily, it's good to keep the sectioning hierarchy intact.
71
72       --preamble=STR
73           Insert STR as top boilerplate before menu and includes.  If STR is
74           set to "-", read the top boilerplate from the standard input.  The
75           default top boilerplate is a minimal beginning for a Texinfo
76           document.
77
78       --setfilename=STR
79           Use STR in top boilerplate before menu and includes for
80           @setfilename.  No @setfilename is output in the default case.
81
82       --subdir=NAME
83           If there is a main manual with include files (each corresponding to
84           an input Pod file), then those include files are put in directory
85           NAME.
86
87       --unnumbered-sections
88           Use unnumbered sectioning commands (@unnumbered, ...) instead of
89           the default numbered sectioning Texinfo @-commands (@chapter,
90           @section, ...).
91
92       --top=TOP
93           Name of the @top element for the main manual.  May contain Texinfo
94           code.
95
96       --version
97           Display version information and exit.
98

SEE ALSO

100       Pod::Simple::Texinfo.  perlpod.  The Texinfo manual.  Texinfo home
101       page: <http://www.gnu.org/software/texinfo/>
102

104       Copyright 2012-2022 Free Software Foundation, Inc.
105
106       This program is free software; you can redistribute it and/or modify it
107       under the terms of the GNU General Public License as published by the
108       Free Software Foundation; either version 3 of the License, or (at your
109       option) any later version.
110
111       There is NO WARRANTY, to the extent permitted by law.
112

AUTHOR

114       Patrice Dumas <bug-texinfo@gnu.org>.
115
116
117
118perl v5.34.0                      2022-10-24                       POD2TEXI(1)
Impressum