summaryrefslogtreecommitdiffstats
path: root/contrib/texinfo/doc/makeinfo.1
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/texinfo/doc/makeinfo.1')
-rw-r--r--contrib/texinfo/doc/makeinfo.1152
1 files changed, 152 insertions, 0 deletions
diff --git a/contrib/texinfo/doc/makeinfo.1 b/contrib/texinfo/doc/makeinfo.1
new file mode 100644
index 0000000..62d22b8
--- /dev/null
+++ b/contrib/texinfo/doc/makeinfo.1
@@ -0,0 +1,152 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.013.
+.TH MAKEINFO "1" "September 1999" "GNU texinfo 4.0" FSF
+.SH NAME
+makeinfo \- translate Texinfo documents
+.SH SYNOPSIS
+.B makeinfo
+[\fIOPTION\fR]...\fI TEXINFO-FILE\fR...
+.SH DESCRIPTION
+.PP
+Translate Texinfo source documentation to various other formats:
+Info files suitable for reading online with Emacs or standalone GNU Info
+(by default); plain text (with \fB\-\-no\-headers\fR); or HTML (with \fB\-\-html\fR).
+.SH OPTIONS
+.TP
+\fB\-\-commands\-in\-node\-names\fR
+allow @ commands in node names.
+.TP
+\fB\-D\fR VAR
+define a variable, as with @set.
+.TP
+\fB\-E\fR, \fB\-\-macro\-expand\fR FILE
+output macro-expanded source to FILE.
+.TP
+\fB\-\-error\-limit\fR=\fINUM\fR
+quit after NUM errors (default 100).
+.TP
+\fB\-\-fill\-column\fR=\fINUM\fR
+break Info lines at NUM characters (default 72).
+.TP
+\fB\-\-footnote\-style\fR=\fISTYLE\fR
+output footnotes according to STYLE:
+.IP
+`separate' to place footnotes in their own node,
+`end' to place the footnotes at the end of the
+.IP
+node in which they are defined (the default).
+.TP
+\fB\-\-force\fR
+preserve output even if errors.
+.TP
+\fB\-\-help\fR
+display this help and exit.
+.TP
+\fB\-\-html\fR
+output HTML rather than Info format;
+.TP
+\fB\-I\fR DIR
+append DIR to the @include search path.
+.TP
+\fB\-\-ifhtml\fR
+process @ifhtml and @html text even when not
+.IP
+generating HTML.
+.TP
+\fB\-\-ifinfo\fR
+process @ifinfo text even when generating HTML.
+.TP
+\fB\-\-iftex\fR
+process @iftex and @tex text.
+.IP
+implies \fB\-\-no\-split\fR.
+.TP
+\fB\-\-no\-headers\fR
+suppress Info node separators and Node: lines and
+.IP
+write to standard output without \fB\-\-output\fR.
+.TP
+\fB\-\-no\-ifhtml\fR
+do not process @ifhtml and @html text.
+.TP
+\fB\-\-no\-ifinfo\fR
+do not process @ifinfo text.
+.TP
+\fB\-\-no\-iftex\fR
+do not process @iftex and @tex text.
+.TP
+\fB\-\-no\-split\fR
+suppress splitting of large Info output files or
+generation of one HTML file per node.
+.TP
+\fB\-\-no\-validate\fR
+suppress node cross-reference validation.
+.TP
+\fB\-\-no\-warn\fR
+suppress warnings (but not errors).
+.TP
+\fB\-\-number\-sections\fR
+include chapter, section, etc. numbers in output.
+.TP
+\fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
+output to FILE, ignoring any @setfilename.
+.TP
+\fB\-P\fR DIR
+prepend DIR to the @include search path.
+.TP
+\fB\-\-paragraph\-indent\fR=\fIVAL\fR
+indent Info paragraphs by VAL spaces (default 3).
+.IP
+if VAL is `none', do not indent;
+if VAL is `asis', preserve existing indentation.
+.TP
+\fB\-\-reference\-limit\fR=\fINUM\fR
+warn about at most NUM references (default 1000).
+.TP
+\fB\-U\fR VAR
+undefine a variable, as with @clear.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+explain what is being done.
+.TP
+\fB\-\-version\fR
+display version information and exit.
+.PP
+The defaults for the @if... conditionals depend on the output format:
+if generating HTML, \fB\-\-ifhtml\fR is on and the others are off;
+if generating Info or plain text, \fB\-\-ifinfo\fR is on and the others are off.
+.SH EXAMPLES
+.TP
+makeinfo foo.texi
+write Info to foo's @setfilename
+.TP
+makeinfo \fB\-\-html\fR foo.texi
+write HTML to foo's @setfilename
+.TP
+makeinfo \fB\-\-no\-headers\fR \fB\-o\fR - foo.texi
+write plain text to standard output
+.TP
+makeinfo \fB\-\-number\-sections\fR foo.texi
+write Info with numbered sections
+.TP
+makeinfo \fB\-\-no\-split\fR foo.texi
+write one Info file however big
+.SH "REPORTING BUGS"
+Email bug reports to bug-texinfo@gnu.org,
+general questions and discussion to help-texinfo@gnu.org.
+.SH "SEE ALSO"
+The full documentation for
+.B makeinfo
+is maintained as a Texinfo manual. If the
+.B info
+and
+.B makeinfo
+programs are properly installed at your site, the command
+.IP
+.B info makeinfo
+.PP
+should give you access to the complete manual.
+.SH COPYRIGHT
+Copyright \(co 1999 Free Software Foundation, Inc.
+There is NO warranty. You may redistribute this software
+under the terms of the GNU General Public License.
+For more information about these matters, see the files named COPYING.
OpenPOWER on IntegriCloud