Manpages

Manpage of MAKEINFO

MAKEINFO

Section: FSF (1)
Updated: March 2002
Index
Return to Main Contents
 

NAME

makeinfo - translate Texinfo documents  

SYNOPSIS

makeinfo [OPTION]... TEXINFO-FILE...  

DESCRIPTION

Translate Texinfo source documentation to various other formats, by default Info files suitable for reading online with Emacs or standalone GNU Info.  

General options:

--error-limit=NUM
quit after NUM errors (default 100).
--force
preserve output even if errors.
--help
display this help and exit.
--no-validate
suppress node cross-reference validation.
--no-warn
suppress warnings (but not errors).
--reference-limit=NUM
warn about at most NUM references (default 1000).
-v, --verbose
explain what is being done.
--version
display version information and exit.
 

Output format selection (default is to produce Info):

--docbook
output DocBook rather than Info.
--html
output HTML rather than Info.
--no-headers
output plain text, suppressing Info node separators and Node: lines; also, write to standard output without --output.
--xml
output XML (TexinfoML) rather than Info.
 

General output options:

-E, --macro-expand FILE
output macro-expanded source to FILE. ignoring any @setfilename.
--no-split
suppress splitting of Info or HTML output, generate only one output file.
--number-sections
output chapter and sectioning numbers.
-o, --output=FILE
output to FILE (directory if split HTML),
 

Options for Info and plain text:

--enable-encoding
output accented and special characters in Info output based on @documentencoding.
--fill-column=NUM
break Info lines at NUM characters (default 72).
--footnote-style=STYLE
output footnotes in Info according to STYLE: `separate' to put them in their own node; `end' to put them at the end of the node
in which they are defined (default).
--paragraph-indent=VAL
indent Info paragraphs by VAL spaces (default 3). If VAL is `none', do not indent; if VAL is `asis', preserve existing indentation.
--split-size=NUM
split Info files at size NUM (default 50000).
 

Input file options:

--commands-in-node-names
allow @ commands in node names.
-D VAR
define the variable VAR, as with @set.
-I DIR
append DIR to the @include search path.
-P DIR
prepend DIR to the @include search path.
-U VAR
undefine the variable VAR, as with @clear.
 

Conditional processing in input:

--ifhtml
process @ifhtml and @html even if not generating HTML.
--ifinfo
process @ifinfo text even when generating HTML.
--iftex
process @iftex and @tex text; implies --no-split.
--no-ifhtml
do not process @ifhtml and @html text.
--no-ifinfo
do not process @ifinfo text.
--no-iftex
do not process @iftex and @tex text.
The defaults for the @if... conditionals depend on the output format: if generating HTML, --ifhtml is on and the others are off; if generating Info or plain text, --ifinfo is on and the others are off.
 

EXAMPLES

makeinfo foo.texi
write Info to foo's @setfilename
makeinfo --html foo.texi
write HTML to foo's @setfilename
makeinfo --no-headers -o - foo.texi
write plain text to standard output
makeinfo --number-sections foo.texi
write Info with numbered sections
makeinfo --no-split foo.texi
write one Info file however big
 

REPORTING BUGS

Email bug reports to bug-texinfo@gnu.org, general questions and discussion to help-texinfo@gnu.org.  

COPYRIGHT

Copyright © 2002 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.  

SEE ALSO

The full documentation for makeinfo is maintained as a Texinfo manual. If the info and makeinfo programs are properly installed at your site, the command
info makeinfo

should give you access to the complete manual.


 

Index

NAME
SYNOPSIS
DESCRIPTION
General options:
Output format selection (default is to produce Info):
General output options:
Options for Info and plain text:
Input file options:
Conditional processing in input:
EXAMPLES
REPORTING BUGS
COPYRIGHT
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 23:55:19 GMT, April 26, 2024