| .\" -*- mode: troff; coding: utf-8 -*- |
| .\" Automatically generated by Pod::Man (Pod::Simple) |
| .\" |
| .\" Standard preamble: |
| .\" ======================================================================== |
| .de Sp \" Vertical space (when we can't use .PP) |
| .if t .sp .5v |
| .if n .sp |
| .. |
| .de Vb \" Begin verbatim text |
| .ft CW |
| .nf |
| .ne \\$1 |
| .. |
| .de Ve \" End verbatim text |
| .ft R |
| .fi |
| .. |
| .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| .ie n \{\ |
| . ds C` "" |
| . ds C' "" |
| 'br\} |
| .el\{\ |
| . ds C` |
| . ds C' |
| 'br\} |
| .\" |
| .\" Escape single quotes in literal strings from groff's Unicode transform. |
| .ie \n(.g .ds Aq \(aq |
| .el .ds Aq ' |
| .\" |
| .\" If the F register is >0, we'll generate index entries on stderr for |
| .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| .\" entries marked with X<> in POD. Of course, you'll have to process the |
| .\" output yourself in some meaningful fashion. |
| .\" |
| .\" Avoid warning from groff about undefined register 'F'. |
| .de IX |
| .. |
| .nr rF 0 |
| .if \n(.g .if rF .nr rF 1 |
| .if (\n(rF:(\n(.g==0)) \{\ |
| . if \nF \{\ |
| . de IX |
| . tm Index:\\$1\t\\n%\t"\\$2" |
| .. |
| . if !\nF==2 \{\ |
| . nr % 0 |
| . nr F 2 |
| . \} |
| . \} |
| .\} |
| .rr rF |
| .\" ======================================================================== |
| .\" |
| .IX Title "POD2TEXI 1" |
| .TH POD2TEXI 1 2024-05-05 perl "User Contributed Perl Documentation" |
| .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| .\" way too many mistakes in technical documents. |
| .if n .ad l |
| .nh |
| .SH NAME |
| pod2texi \- convert Pod to Texinfo |
| .SH SYNOPSIS |
| .IX Header "SYNOPSIS" |
| .Vb 1 |
| \& pod2texi [OPTION]... POD... |
| .Ve |
| .SH DESCRIPTION |
| .IX Header "DESCRIPTION" |
| Translate Pod file(s) to Texinfo. There are two basic modes of |
| operation. First, by default, each Pod is translated to a standalone |
| Texinfo manual. |
| .PP |
| Second, if \f(CW\*(C`\-\-base\-level\*(C'\fR is set higher than 0, each Pod is translated |
| to a file suitable for \f(CW@include\fR, and one more file with a main menu |
| and all the \f(CW@include\fR is generated. |
| .SH OPTIONS |
| .IX Header "OPTIONS" |
| .IP \fB\-\-appendix\-sections\fR 4 |
| .IX Item "--appendix-sections" |
| Use appendix sectioning commands (\f(CW@appendix\fR, ...) instead of the |
| default numbered sectioning Texinfo @\-commands (\f(CW@chapter\fR, |
| \&\f(CW@section\fR, ...). |
| .IP \fB\-\-base\-level\fR=\fINUM|NAME\fR 4 |
| .IX Item "--base-level=NUM|NAME" |
| Sets the level of the \f(CW\*(C`head1\*(C'\fR commands. It may be an integer or a |
| Texinfo sectioning command (without the \f(CW\*(C`@\*(C'\fR): 1 corresponds to the |
| \&\f(CW@chapter\fR/\f(CW@unnumbered\fR level, 2 to the \f(CW@section\fR level, and so on. |
| The default is 0, meaning that \f(CW\*(C`head1\*(C'\fR commands are still output as |
| chapters, but the output is arranged as a standalone manual. |
| .Sp |
| If the level is not 0, the Pod file is rendered as a fragment of a |
| Texinfo manual suitable for \f(CW@include\fR. In this case, each Pod file |
| has an additional sectioning command covering the entire file, one level |
| above the \f(CW\*(C`\-\-base\-level\*(C'\fR value. Therefore, to make each Pod file a |
| chapter in a large manual, you should use \f(CW\*(C`section\*(C'\fR as the base level. |
| .Sp |
| For an example of making Texinfo out of the Perl documentation itself, |
| see \f(CW\*(C`contrib/perldoc\-all\*(C'\fR in the Texinfo source distribution. |
| .IP \fB\-\-debug\fR=\fINUM\fR 4 |
| .IX Item "--debug=NUM" |
| Set debugging level to \fINUM\fR. |
| .IP \fB\-\-generate\-setfilename\fR 4 |
| .IX Item "--generate-setfilename" |
| Generate a \f(CW@setfilename\fR line for standalone manuals. Can be negated |
| with \f(CW\*(C`\-\-no\-generate\-setfilename\*(C'\fR. Ignored if \f(CW\*(C`\-\-base\-level\*(C'\fR is not 0. |
| .IP \fB\-\-headings\-as\-sections\fR 4 |
| .IX Item "--headings-as-sections" |
| Use headings commands (\f(CW@heading\fR, ...) instead of the |
| default numbered sectioning Texinfo @\-commands (\f(CW@chapter\fR, |
| \&\f(CW@section\fR, ...). The sectioning command covering the entire |
| file output for each Pod file if \fB\-\-base\-level\fR is not 0 is a |
| numbered command. |
| .IP \fB\-\-help\fR 4 |
| .IX Item "--help" |
| Display help and exit. |
| .IP \fB\-\-menus\fR 4 |
| .IX Item "--menus" |
| Output node menus. If there is a main manual, its Top node menu |
| is always output, since a master menu is generated. Other nodes |
| menus are not output in the default case. |
| .IP \fB\-\-output\fR=\fINAME\fR 4 |
| .IX Item "--output=NAME" |
| Name for the first manual, or the main manual if there is a main manual. |
| Default is to write to standard output. |
| .IP \fB\-\-no\-section\-nodes\fR 4 |
| .IX Item "--no-section-nodes" |
| Use anchors for sections instead of nodes. |
| .IP \fB\-\-no\-fill\-section\-gaps\fR 4 |
| .IX Item "--no-fill-section-gaps" |
| Do not fill sectioning gaps with empty \f(CW@unnumbered\fR files. |
| Ordinarily, it's good to keep the sectioning hierarchy intact. |
| .IP \fB\-\-preamble\fR=\fISTR\fR 4 |
| .IX Item "--preamble=STR" |
| Insert \fISTR\fR as top boilerplate before menu and includes. If \fISTR\fR is |
| set to \f(CW\*(C`\-\*(C'\fR, read the top boilerplate from the standard input. The default top |
| boilerplate is a minimal beginning for a Texinfo document. |
| .IP \fB\-\-setfilename\fR=\fISTR\fR 4 |
| .IX Item "--setfilename=STR" |
| Use \fISTR\fR in top boilerplate before menu and includes for \f(CW@setfilename\fR |
| for the main manual, if \f(CW\*(C`\-\-base\-level\*(C'\fR is not set to 0. Ignored if |
| \&\f(CW\*(C`\-\-base\-level\*(C'\fR is 0. No \f(CW@setfilename\fR is output in the default case |
| for the main manual. |
| .IP \fB\-\-subdir\fR=\fINAME\fR 4 |
| .IX Item "--subdir=NAME" |
| If there is a main manual with include files (each corresponding to |
| an input Pod file), then those include files are put in directory \fINAME\fR. |
| .IP \fB\-\-unnumbered\-sections\fR 4 |
| .IX Item "--unnumbered-sections" |
| Use unnumbered sectioning commands (\f(CW@unnumbered\fR, ...) instead of the |
| default numbered sectioning Texinfo @\-commands (\f(CW@chapter\fR, |
| \&\f(CW@section\fR, ...). |
| .IP \fB\-\-top\fR=\fITOP\fR 4 |
| .IX Item "--top=TOP" |
| Name of the \f(CW@top\fR element for the main manual. May contain Texinfo code. |
| .IP \fB\-\-version\fR 4 |
| .IX Item "--version" |
| Display version information and exit. |
| .SH "SEE ALSO" |
| .IX Header "SEE ALSO" |
| Pod::Simple::Texinfo. perlpod. The Texinfo manual. |
| Texinfo home page: <https://www.gnu.org/software/texinfo/> |
| .SH "COPYRIGHT AND LICENSE" |
| .IX Header "COPYRIGHT AND LICENSE" |
| Copyright 2012\-2024 Free Software Foundation, Inc. |
| .PP |
| This program is free software; you can redistribute it and/or modify |
| it under the terms of the GNU General Public License as published by |
| the Free Software Foundation; either version 3 of the License, |
| or (at your option) any later version. |
| .PP |
| There is NO WARRANTY, to the extent permitted by law. |
| .SH AUTHOR |
| .IX Header "AUTHOR" |
| Patrice Dumas <bug\-texinfo@gnu.org>. |
