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

SEE ALSO

82       Pod::Simple::Texinfo.  perlpod.  The Texinfo manual.  Texinfo home
83       page: <http://www.gnu.org/software/texinfo/>
84

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

AUTHOR

96       Patrice Dumas <bug-texinfo@gnu.org>.
97
98
99
100perl v5.16.2                      2013-02-22                       POD2TEXI(1)
Impressum