Scroll to navigation

MAKEINFO(1) User Commands MAKEINFO(1)

NAME

makeinfo - translate Texinfo documents

SYNOPSIS

makeinfo [OPTION]... TEXINFO-FILE...
texi2any [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:

for the output document (default C).
quit after NUM errors (default 100).
preserve output even if errors.
display this help and exit.
suppress node cross-reference validation.
suppress warnings (but not errors).
search also for initialization files in DIR.
load FILE to modify the default behavior.
set customization variable VAR to VAL.
explain what is being done.
display version information and exit.

Output format selection (default is to produce Info):

output Docbook XML rather than Info.
output HTML rather than Info.
output plain text rather than Info.
output Texinfo XML rather than Info.
call texi2dvi to generate given output.

General output options:

output macro-expanded source to FILE, ignoring any @setfilename.
suppress node separators, Node: lines, and menus from Info output (thus producing plain text) or from HTML (thus producing shorter output). Also, if producing Info, write to standard output by default
suppress any splitting of the output; generate only one output file.
--[no-]number-sections
output chapter and sectioning numbers; default is on.
output to DEST. With split output, create DEST as a directory
and put the output files there.
With non-split output, if DEST is already
a directory or ends with a /, put the output file there.
Otherwise, DEST names the output file.

Options for Info and plain text:

do not output accented and special characters in Info output based on @documentencoding.
override --disable-encoding (default).
break Info lines at NUM characters (default 72).
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 (this is the default).
indent Info paragraphs by VAL spaces (default 3). If VAL is `none', do not indent; if VAL is `asis', preserve existing indentation.
split Info files at size NUM (default 300000).

Options for HTML:

include FILE in HTML <style> output; read stdin if FILE is -.
generate CSS reference to URL.
produce list of internal links in FILE.
split at SPLIT, where SPLIT may be `chapter', `section' or `node'.
use file names in ASCII transliteration.
produce redirection files for nodes and anchors; default is set only if split.

Options for XML and Docbook:

does nothing, retained for compatibility.

Options for DVI/PS/PDF:

pass OPT to texi2dvi; can be repeated.

Input file options:

does nothing, retained for compatibility.
define the variable VAR, as with @set.
append DIR to the @include search path.
prepend DIR to the @include search path.
undefine the variable VAR, as with @clear.

Conditional processing in input:

process @ifdocbook and @docbook even if not generating Docbook.
process @ifhtml and @html even if not generating HTML.
process @ifinfo even if not generating Info.
process @ifplaintext even if not generating plain text.
process @iftex and @tex.
process @ifxml and @xml.
do not process @ifdocbook and @docbook text.
do not process @ifhtml and @html text.
do not process @ifinfo text.
do not process @ifplaintext text.
do not process @iftex and @tex text.
do not process @ifxml and @xml text.

Also, for the --no-ifFORMAT options, do process @ifnotFORMAT text.

The defaults for the @if... conditionals depend on the output format: if generating Docbook, --ifdocbook is on and the others are off; if generating HTML, --ifhtml is on and the others are off; if generating Info, --ifinfo is on and the others are off; if generating plain text, --ifplaintext is on and the others are off; if generating XML, --ifxml is on and the others are off.

EXAMPLES

write Info to foo's @setfilename
write HTML to @setfilename
write Texinfo XML to @setfilename
write Docbook XML to @setfilename
write plain text to standard output
write PDF using texi2dvi
write html without node lines, menus
write Info with numbered sections
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.
Texinfo home page: http://www.gnu.org/software/texinfo/

COPYRIGHT

Copyright © 2013 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

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.

March 2013 makeinfo 5.1