| .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) |
| .\" |
| .\" 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 |
| .. |
| .\" Set up some character translations and predefined strings. \*(-- will |
| .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
| .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
| .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
| .\" nothing in troff, for use with C<>. |
| .tr \(*W- |
| .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| .ie n \{\ |
| . ds -- \(*W- |
| . ds PI pi |
| . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| . ds L" "" |
| . ds R" "" |
| . ds C` "" |
| . ds C' "" |
| 'br\} |
| .el\{\ |
| . ds -- \|\(em\| |
| . ds PI \(*p |
| . ds L" `` |
| . ds R" '' |
| . 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 turned on, 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 |
| .\" |
| .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| .\" Fear. Run. Save yourself. No user-serviceable parts. |
| . \" fudge factors for nroff and troff |
| .if n \{\ |
| . ds #H 0 |
| . ds #V .8m |
| . ds #F .3m |
| . ds #[ \f1 |
| . ds #] \fP |
| .\} |
| .if t \{\ |
| . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| . ds #V .6m |
| . ds #F 0 |
| . ds #[ \& |
| . ds #] \& |
| .\} |
| . \" simple accents for nroff and troff |
| .if n \{\ |
| . ds ' \& |
| . ds ` \& |
| . ds ^ \& |
| . ds , \& |
| . ds ~ ~ |
| . ds / |
| .\} |
| .if t \{\ |
| . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| .\} |
| . \" troff and (daisy-wheel) nroff accents |
| .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| .ds ae a\h'-(\w'a'u*4/10)'e |
| .ds Ae A\h'-(\w'A'u*4/10)'E |
| . \" corrections for vroff |
| .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| . \" for low resolution devices (crt and lpr) |
| .if \n(.H>23 .if \n(.V>19 \ |
| \{\ |
| . ds : e |
| . ds 8 ss |
| . ds o a |
| . ds d- d\h'-1'\(ga |
| . ds D- D\h'-1'\(hy |
| . ds th \o'bp' |
| . ds Th \o'LP' |
| . ds ae ae |
| . ds Ae AE |
| .\} |
| .rm #[ #] #H #V #F C |
| .\" ======================================================================== |
| .\" |
| .IX Title "POD2TEXI 1" |
| .TH POD2TEXI 1 "2015-02-25" "perl v5.18.1" "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 all the |
| \&\f(CW@include\fRs is generated, intended to be \f(CW@include\fRd in turn within a |
| hand-written top-level file. |
| .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, with |
| output available at <http://www.gnu.org/software/perl/manual>. |
| .IP "\fB\-\-debug\fR=\fI\s-1NUM\s0\fR" 4 |
| .IX Item "--debug=NUM" |
| Set debugging level to \fI\s-1NUM\s0\fR. |
| .IP "\fB\-\-help\fR" 4 |
| .IX Item "--help" |
| Display help and exit. |
| .IP "\fB\-\-output\fR=\fI\s-1NAME\s0\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=\fI\s-1STR\s0\fR" 4 |
| .IX Item "--preamble=STR" |
| Insert \fI\s-1STR\s0\fR as top boilerplate before includes. The default is a |
| minimal beginning for a Texinfo document, and sets \f(CW@documentencoding\fR |
| to \f(CW\*(C`utf\-8\*(C'\fR (because the output is written that way). |
| .IP "\fB\-\-subdir\fR=\fI\s-1NAME\s0\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 \fI\s-1NAME\s0\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=\fI\s-1TOP\s0\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: <http://www.gnu.org/software/texinfo/> |
| .SH "COPYRIGHT" |
| .IX Header "COPYRIGHT" |
| Copyright 2015 Free Software Foundation, Inc. |
| .PP |
| This program is free software; you can redistribute it and/or modify |
| it under the terms of the \s-1GNU\s0 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 \s-1NO WARRANTY,\s0 to the extent permitted by law. |
| .SH "AUTHOR" |
| .IX Header "AUTHOR" |
| Patrice Dumas <bug\-texinfo@gnu.org>. |