Go to main content

man pages section 1: User Commands

Exit Print View

Updated: July 2017

makeinfo (1)


makeinfo - translate Texinfo documents


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


MAKEINFO(1)                      User Commands                     MAKEINFO(1)

       makeinfo - translate Texinfo documents

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

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

   General options:
              quit after NUM errors (default 100).

       --document-language=STR locale to use in translating Texinfo keywords
              for the output document (default C).

              preserve output even if errors.

       --help display this help and exit.

              suppress node cross-reference validation.

              suppress warnings (but not errors).

       -v, --verbose
              explain what is being done.

              display version information and exit.

   Output format selection (default is to produce Info):
              output Docbook XML rather than Info.

       --html output HTML rather than Info.

       --xml  output Texinfo XML rather than Info.

              output plain text rather than Info.

   General output options:
       -E, --macro-expand=FILE
              output macro-expanded source to FILE, ignoring any @setfilename.

              suppress  node separators, Node: lines, and menus from Info out-
              put (thus producing plain text) or  from  HTML  (thus  producing
              shorter output); also, write to standard output by default.

              suppress the splitting of Info or HTML output, generate only one
              output file.

              output chapter and sectioning numbers.

       -o, --output=FILE
              output to FILE (or directory if split HTML).

   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

              split Info files at size NUM (default 300000).

   Options for HTML:
              include FILE in HTML <style> output; read stdin if FILE is -.

              generate reference to a CSS file.

              produce list of internal links in FILE.

              produce file names in ASCII transliteration.

   Options for XML and Docbook:
              indent  XML  elements  by  VAL spaces (default 2).  If VAL is 0,
              ignorable whitespace is dropped.

   Input file options:
              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:
              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; implies --no-split.

              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 HTML, --ifhtml is on and the others are off; if generat-
       ing 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.

       makeinfo foo.texi
              write Info to foo's @setfilename

       makeinfo --html foo.texi
              write HTML to @setfilename

       makeinfo --xml foo.texi
              write Texinfo XML to @setfilename

       makeinfo --docbook foo.texi
              write DocBook XML to @setfilename

       makeinfo --no-headers foo.texi
              write plain text to standard output

       makeinfo --html --no-headers foo.texi
              write html without node lines, menus

       makeinfo --number-sections foo.texi
              write Info with numbered sections

       makeinfo --no-split foo.texi
              write one Info file however big

       Email bug reports to bug-texinfo@gnu.org, general questions and discus-
       sion      to      help-texinfo@gnu.org.      Texinfo     home     page:

       Copyright (C) 2008 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 attributes(5) for descriptions of the following attributes:

       |Availability   | text/texinfo     |
       |Stability      | Volatile         |
       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.

       This    software    was    built    from    source     available     at
       https://java.net/projects/solaris-userland.    The  original  community
       source   was   downloaded   from    http://ftp.gnu.org/gnu/texinfo/tex-

       Further information about this software can be found on the open source
       community website at http://www.gnu.org/software/texinfo/.

makeinfo 4.13                   September 2008                     MAKEINFO(1)