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 all the
18       @includes is generated, intended to be @included in turn within a hand-
19       written top-level file.
20

OPTIONS

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

SEE ALSO

87       Pod::Simple::Texinfo.  perlpod.  The Texinfo manual.  Texinfo home
88       page: <http://www.gnu.org/software/texinfo/>
89

91       Copyright 2016 Free Software Foundation, Inc.
92
93       This program is free software; you can redistribute it and/or modify it
94       under the terms of the GNU General Public License as published by the
95       Free Software Foundation; either version 3 of the License, or (at your
96       option) any later version.
97
98       There is NO WARRANTY, to the extent permitted by law.
99

AUTHOR

101       Patrice Dumas <bug-texinfo@gnu.org>.
102
103
104
105perl v5.28.0                      2019-02-01                       POD2TEXI(1)
Impressum