| <!DOCTYPE html> |
| <html> |
| <!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ --> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022), |
| a documentation system that can produce both online information and a |
| printed manual from a single source using semantic markup. |
| |
| Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 Free Software Foundation, Inc. |
| |
| Permission is granted to copy, distribute and/or modify this document |
| under the terms of the GNU Free Documentation License, Version 1.3 or |
| any later version published by the Free Software Foundation; with no |
| Invariant Sections, with no Front-Cover Texts, and with no Back-Cover |
| Texts. A copy of the license is included in the section entitled |
| "GNU Free Documentation License". --> |
| <title>Invoking texi2any (GNU Texinfo 6.8dev)</title> |
| |
| <meta name="description" content="Invoking texi2any (GNU Texinfo 6.8dev)"> |
| <meta name="keywords" content="Invoking texi2any (GNU Texinfo 6.8dev)"> |
| <meta name="resource-type" content="document"> |
| <meta name="distribution" content="global"> |
| <meta name="Generator" content="texi2any"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| |
| <link href="index.html" rel="start" title="Top"> |
| <link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index"> |
| <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> |
| <link href="Generic-Translator-texi2any.html" rel="up" title="Generic Translator texi2any"> |
| <link href="texi2any-Environment-Variables.html" rel="next" title="texi2any Environment Variables"> |
| <style type="text/css"> |
| <!-- |
| a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em} |
| div.example {margin-left: 3.2em} |
| span:hover a.copiable-link {visibility: visible} |
| --> |
| </style> |
| |
| |
| </head> |
| |
| <body lang="en"> |
| <div class="section-level-extent" id="Invoking-texi2any"> |
| <div class="nav-panel"> |
| <p> |
| Next: <a href="texi2any-Environment-Variables.html" accesskey="n" rel="next">Environment Variables Recognized by <code class="command">texi2any</code></a>, Up: <a href="Generic-Translator-texi2any.html" accesskey="u" rel="up"><code class="command">texi2any</code>: The Generic Translator for Texinfo</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p> |
| </div> |
| <hr> |
| <h3 class="section" id="Invoking-texi2any_002fmakeinfo-from-a-Shell">19.1 Invoking <code class="command">texi2any</code>/<code class="command">makeinfo</code> from a Shell</h3> |
| |
| <a class="anchor" id="Invoking-makeinfo"></a><a class="index-entry-id" id="index-makeinfo"></a> |
| <a class="index-entry-id" id="index-texi2any"></a> |
| |
| <p>To process a Texinfo file, invoke <code class="command">texi2any</code> or |
| <code class="command">makeinfo</code> (the two names are synonyms for the same program; |
| we’ll use the names interchangeably) followed by the name of the |
| Texinfo file. Also select the format you want to output with the |
| appropriate command line option (default is Info). Thus, to create |
| the Info file for Bison, type the following to the shell: |
| </p> |
| <div class="example"> |
| <pre class="example-preformatted">texi2any --info bison.texinfo |
| </pre></div> |
| |
| <p>You can specify more than one input file name; each is processed in |
| turn. If an input file name is ‘<samp class="samp">-</samp>’, standard input is read. |
| </p> |
| <a class="anchor" id="makeinfo-Options"></a><a class="index-entry-id" id="index-makeinfo-options"></a> |
| <a class="index-entry-id" id="index-Options-for-makeinfo"></a> |
| <a class="anchor" id="texi2any-Options"></a><a class="index-entry-id" id="index-texi2any-options"></a> |
| <a class="index-entry-id" id="index-Options-for-texi2any"></a> |
| |
| <p>The <code class="command">texi2any</code> program accepts many options. Perhaps the |
| most basic are those that change the output format. By default, |
| <code class="command">texi2any</code> outputs Info. |
| </p> |
| <p>Each command line option is either a long name preceded by ‘<samp class="samp">--</samp>’ |
| or a single letter preceded by ‘<samp class="samp">-</samp>’. You can use abbreviations |
| for the long option names as long as they are unique. |
| </p> |
| <p>For example, you could use the following shell command to create an |
| Info file for <samp class="file">bison.texinfo</samp> in which lines are filled to only |
| 68 columns: |
| </p> |
| <div class="example"> |
| <pre class="example-preformatted">texi2any --fill-column=68 bison.texinfo |
| </pre></div> |
| |
| <p>You can write two or more options in sequence, like this: |
| </p> |
| <div class="example"> |
| <pre class="example-preformatted">texi2any --no-split --fill-column=70 … |
| </pre></div> |
| |
| <p>(This would keep the Info file together as one possibly very long |
| file and would also set the fill column to 70.) |
| </p> |
| <p>The options are (approximately in alphabetical order): |
| </p> |
| <dl class="table"> |
| <dt id='index-_002d_002dcommands_002din_002dnode_002dnames'><span><code class="code">--commands-in-node-names</code><a class="copiable-link" href='#index-_002d_002dcommands_002din_002dnode_002dnames'> ¶</a></span></dt> |
| <dd><p>This option now does nothing, but remains for compatibility. (It used |
| to ensure that @-commands in node names were expanded throughout the |
| document, especially <code class="code">@value</code>. This is now done by default.) |
| </p> |
| </dd> |
| <dt id='index-_002d_002dconf_002ddir_003ddir'><span><code class="code">--conf-dir=<var class="var">dir</var></code><a class="copiable-link" href='#index-_002d_002dconf_002ddir_003ddir'> ¶</a></span></dt> |
| <dd><p>Prepend <var class="var">dir</var> to the directory search list for finding |
| customization files that may be loaded with <samp class="option">--init-file</samp> (see |
| below). The <var class="var">dir</var> value can be a single directory, or a list of |
| several directories separated by the usual path separator character |
| (‘<samp class="samp">:</samp>’ on Unix-like systems, ‘<samp class="samp">;</samp>’ on Windows). </p> |
| </dd> |
| <dt id='index-_002d_002dcss_002dinclude'><span><code class="code">--css-include=<var class="var">file</var></code><a class="copiable-link" href='#index-_002d_002dcss_002dinclude'> ¶</a></span></dt> |
| <dd><p>When producing HTML, literally include the contents of <var class="var">file</var>, |
| which should contain W3C cascading style sheets specifications, in the |
| ‘<samp class="samp"><style></samp>’ block of the HTML output. If <var class="var">file</var> is ‘<samp class="samp">-</samp>’, |
| read standard input. See <a class="xref" href="HTML-CSS.html">HTML CSS</a>. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dcss_002dref'><span><code class="code">--css-ref=<var class="var">url</var></code><a class="copiable-link" href='#index-_002d_002dcss_002dref'> ¶</a></span></dt> |
| <dd><p>When producing HTML, add a ‘<samp class="samp"><link></samp>’ tag to the output which |
| references a cascading style sheet at <var class="var">url</var>. This allows using |
| standalone style sheets. |
| </p> |
| </dd> |
| <dt id='index-_002dD-var'><span><code class="code">-D <var class="var">var</var></code><a class="copiable-link" href='#index-_002dD-var'> ¶</a></span></dt> |
| <dt><code class="code">-D '<var class="var">var</var> <var class="var">value</var>'</code></dt> |
| <dd><p>Cause the Texinfo variable <var class="var">var</var> to be defined. This is |
| equivalent to <code class="code">@set <var class="var">var</var></code> in the Texinfo file |
| (see <a class="pxref" href="_0040set-_0040clear-_0040value.html">Flags: <code class="code">@set</code>, <code class="code">@clear</code>, conditionals, and <code class="code">@value</code></a>). |
| </p> |
| <p>The argument to the option is always one word to the shell; if it |
| contains internal whitespace, the first word is taken as the variable |
| name and the remainder as the value. For example, <code class="code">-D 'myvar |
| someval'</code> is equivalent to <code class="code">@set myvar someval</code>. |
| </p> |
| </dd> |
| <dt id='index-_002d_002ddocbook'><span><code class="code">--docbook</code><a class="copiable-link" href='#index-_002d_002ddocbook'> ¶</a></span></dt> |
| <dd><p>Generate DocBook output (rather than Info). |
| </p> |
| </dd> |
| <dt id='index-_002d_002ddocument_002dlanguage'><span><code class="code">--document-language=<var class="var">lang</var></code><a class="copiable-link" href='#index-_002d_002ddocument_002dlanguage'> ¶</a></span></dt> |
| <dd><p>Use <var class="var">lang</var> to translate Texinfo keywords which end up in the |
| output document. The default is the locale specified by the |
| <code class="code">@documentlanguage</code> command if there is one, otherwise English |
| (see <a class="pxref" href="_0040documentlanguage.html"><code class="code">@documentlanguage <var class="var">ll</var>[_<var class="var">cc</var>]</code>: Set the Document Language</a>). |
| </p> |
| </dd> |
| <dt id='index-_002d_002ddvi'><span><code class="code">--dvi</code><a class="copiable-link" href='#index-_002d_002ddvi'> ¶</a></span></dt> |
| <dd><p>Generate a TeX DVI file using <code class="command">texi2dvi</code>, rather than Info |
| (see <a class="pxref" href="texi2any-Printed-Output.html"><code class="command">texi2any</code> Printed Output</a>). |
| </p> |
| </dd> |
| <dt id='index-_002d_002ddvipdf'><span><code class="code">--dvipdf</code><a class="copiable-link" href='#index-_002d_002ddvipdf'> ¶</a></span></dt> |
| <dd><p>Generate a PDF file using <code class="command">texi2dvi --dvipdf</code>, rather than |
| Info (see <a class="pxref" href="texi2any-Printed-Output.html"><code class="command">texi2any</code> Printed Output</a>). |
| </p> |
| </dd> |
| <dt id='index-_002d_002denable_002dencoding'><span><code class="code">--enable-encoding</code><a class="copiable-link" href='#index-_002d_002denable_002dencoding'> ¶</a></span></dt> |
| <dt><code class="code">--disable-encoding</code></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002ddisable_002dencoding"></a> |
| <a class="index-entry-id" id="index-ENABLE_005fENCODING"></a> |
| <p>By default, or with <samp class="option">--enable-encoding</samp>, output accented and |
| special characters in Info and plain text output based on |
| ‘<samp class="samp">@documentencoding</samp>’. With <samp class="option">--disable-encoding</samp>, 7-bit |
| ASCII transliterations are output. See <a class="xref" href="_0040documentencoding.html"><code class="code">@documentencoding <var class="var">enc</var></code>: Set Input Encoding</a>, |
| and <a class="ref" href="Inserting-Accents.html">Inserting Accents</a>. |
| </p> |
| |
| </dd> |
| <dt id='index-_002d_002derror_002dlimit_003dlimit'><span><code class="code">--error-limit=<var class="var">limit</var></code><a class="copiable-link" href='#index-_002d_002derror_002dlimit_003dlimit'> ¶</a></span></dt> |
| <dt><code class="code">-e <var class="var">limit</var></code></dt> |
| <dd><a class="index-entry-id" id="index-_002de-limit"></a> |
| <a class="index-entry-id" id="index-ERROR_005fLIMIT"></a> |
| <p>Report <var class="var">limit</var> errors before aborting (on the assumption that |
| continuing would be useless); default 100. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dfill_002dcolumn_003dwidth'><span><code class="code">--fill-column=<var class="var">width</var></code><a class="copiable-link" href='#index-_002d_002dfill_002dcolumn_003dwidth'> ¶</a></span></dt> |
| <dt><code class="code">-f <var class="var">width</var></code></dt> |
| <dd><a class="index-entry-id" id="index-_002df-width"></a> |
| <a class="index-entry-id" id="index-FILLCOLUMN"></a> |
| <p>Specify the maximum number of columns in a line; this is the |
| right-hand edge of a line. Paragraphs that are filled will be filled |
| to this width. (Filling is the process of breaking up and connecting |
| lines so that lines are the same length as or shorter than the number |
| specified as the fill column. Lines are broken between words.) The |
| default value is 72. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dfootnote_002dstyle_003dstyle'><span><code class="code">--footnote-style=<var class="var">style</var></code><a class="copiable-link" href='#index-_002d_002dfootnote_002dstyle_003dstyle'> ¶</a></span></dt> |
| <dt><code class="code">-s <var class="var">style</var></code></dt> |
| <dd><a class="index-entry-id" id="index-_002ds-style"></a> |
| <a class="index-entry-id" id="index-footnotestyle-1"></a> |
| <p>Set the footnote style to <var class="var">style</var>: either ‘<samp class="samp">end</samp>’ for the end |
| node style (the default) or ‘<samp class="samp">separate</samp>’ for the separate node |
| style. The value set by this option overrides the value set in a |
| Texinfo file by a <code class="code">@footnotestyle</code> command (see <a class="pxref" href="Footnote-Styles.html">Footnote Styles</a>). |
| </p> |
| <p>When the footnote style is ‘<samp class="samp">separate</samp>’, <code class="code">makeinfo</code> makes a |
| new node containing the footnotes found in the current node. When the |
| footnote style is ‘<samp class="samp">end</samp>’, <code class="code">makeinfo</code> places the footnote |
| references at the end of the current node. |
| </p> |
| <p>In HTML, when the footnote style is ‘<samp class="samp">end</samp>’, or if the output is |
| not split, footnotes are put at the end of the output. If set to |
| ‘<samp class="samp">separate</samp>’, and the output is split, they are placed in a |
| separate file. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dforce'><span><code class="code">--force</code><a class="copiable-link" href='#index-_002d_002dforce'> ¶</a></span></dt> |
| <dt><code class="code">-F</code></dt> |
| <dd><a class="index-entry-id" id="index-_002dF"></a> |
| <a class="index-entry-id" id="index-FORCE"></a> |
| <p>Ordinarily, if the input file has errors, the output files are not |
| created. With this option, they are preserved. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dhelp_002c-for-texi2any'><span><code class="code">--help</code><a class="copiable-link" href='#index-_002d_002dhelp_002c-for-texi2any'> ¶</a></span></dt> |
| <dt><code class="code">-h</code></dt> |
| <dd><a class="index-entry-id" id="index-_002dh"></a> |
| <p>Print a message with available options and basic usage, then exit |
| successfully. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dhtml'><span><code class="code">--html</code><a class="copiable-link" href='#index-_002d_002dhtml'> ¶</a></span></dt> |
| <dd><p>Generate HTML output (rather than Info). By default, the HTML output |
| is split into one output file per Texinfo source node, and the split |
| output is written into a subdirectory based on the name of the |
| top-level Info file. See <a class="xref" href="Generating-HTML.html">Generating HTML</a>. |
| </p> |
| </dd> |
| <dt id='index-_002dI-dir'><span><code class="code">-I <var class="var">dir</var></code><a class="copiable-link" href='#index-_002dI-dir'> ¶</a></span></dt> |
| <dd><p>Append <var class="var">dir</var> to the directory search list for finding files that |
| are included using the <code class="code">@include</code> command. By default, |
| <code class="code">texi2any</code> searches only the current directory. If <var class="var">dir</var> is |
| not given, the current directory is appended. The <var class="var">dir</var> value |
| can be a single directory or a list of several directories separated |
| by the usual path separator character (‘<samp class="samp">:</samp>’ on Unix-like systems, |
| ‘<samp class="samp">;</samp>’ on Windows). |
| </p> |
| </dd> |
| <dt id='index-_002d_002difxml'><span><code class="code">--ifdocbook</code><a class="copiable-link" href='#index-_002d_002difxml'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002difdocbook"></a> |
| </dd> |
| <dt><code class="code">--ifhtml</code></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002difhtml"></a> |
| </dd> |
| <dt><code class="code">--ifinfo</code></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002difinfo"></a> |
| </dd> |
| <dt><code class="code">--ifplaintext</code></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002difplaintext"></a> |
| </dd> |
| <dt><code class="code">--iftex</code></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002diftex"></a> |
| </dd> |
| <dt><code class="code">--ifxml</code></dt> |
| <dd><p>For the given format, process ‘<samp class="samp">@if<var class="var">format</var></samp>’ and |
| ‘<samp class="samp">@<var class="var">format</var></samp>’ commands, and do not process |
| ‘<samp class="samp">@ifnot<var class="var">format</var></samp>’, regardless of the format being output. |
| For instance, if <samp class="option">--iftex</samp> is given, then ‘<samp class="samp">@iftex</samp>’ and |
| ‘<samp class="samp">@tex</samp>’ blocks will be read, and ‘<samp class="samp">@ifnottex</samp>’ blocks will be |
| ignored. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dno_002difxml'><span><code class="code">--no-ifdocbook</code><a class="copiable-link" href='#index-_002d_002dno_002difxml'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002dno_002difdocbook"></a> |
| </dd> |
| <dt><code class="code">--no-ifhtml</code></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002dno_002difhtml"></a> |
| </dd> |
| <dt><code class="code">--no-ifinfo</code></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002dno_002difinfo"></a> |
| </dd> |
| <dt><code class="code">--no-ifplaintext</code></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002dno_002difplaintext"></a> |
| </dd> |
| <dt><code class="code">--no-iftex</code></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002dno_002diftex"></a> |
| </dd> |
| <dt><code class="code">--no-ifxml</code></dt> |
| <dd><p>For the given format, do not process ‘<samp class="samp">@if<var class="var">format</var></samp>’ and |
| ‘<samp class="samp">@<var class="var">format</var></samp>’ commands, and do process |
| ‘<samp class="samp">@ifnot<var class="var">format</var></samp>’, regardless of the format being output. |
| For instance, if <samp class="option">--no-ifhtml</samp> is given, then ‘<samp class="samp">@ifhtml</samp>’ |
| and ‘<samp class="samp">@html</samp>’ blocks will not be read, and ‘<samp class="samp">@ifnothtml</samp>’ |
| blocks will be. |
| </p> |
| |
| </dd> |
| <dt id='index-_002d_002dinfo'><span><code class="code">--info</code><a class="copiable-link" href='#index-_002d_002dinfo'> ¶</a></span></dt> |
| <dd><p>Generate Info output. By default, if the output file contains more |
| than about 300,000 bytes, it is split into shorter subfiles of about |
| that size. The name of the output file and any subfiles is determined |
| by <code class="code">@setfilename</code> (see <a class="pxref" href="_0040setfilename.html"><code class="code">@setfilename</code>: Set the Output File Name</a>). See <a class="xref" href="Tag-and-Split-Files.html">Tag Files and Split Files</a>. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dinit_002dfile_003dfile'><span><code class="code">--init-file=<var class="var">file</var></code><a class="copiable-link" href='#index-_002d_002dinit_002dfile_003dfile'> ¶</a></span></dt> |
| <dd><p>Load <var class="var">file</var> as code to modify the behavior and output of the |
| generated manual. It is customary to use the <code class="code">.pm</code> or the |
| <code class="code">.init</code> extensions for these customization files, but that is not |
| enforced; the <var class="var">file</var> name can be anything. The |
| <samp class="option">--conf-dir</samp> option (see above) can be used to add to the list |
| of directories in which these customization files are searched for. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dinternal_002dlinks_003dfile'><span><code class="code">--internal-links=<var class="var">file</var></code><a class="copiable-link" href='#index-_002d_002dinternal_002dlinks_003dfile'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-Internal-links_002c-of-HTML"></a> |
| <a class="index-entry-id" id="index-INTERNAL_005fLINKS"></a> |
| <p>In HTML mode, output a tab-separated file containing three columns: |
| the internal link to an indexed item or item in the table of contents, |
| the name of the index (or table of contents) in which it occurs, and |
| the term which was indexed or entered. The items are in the natural |
| sorting order for the given element. This dump can be useful for |
| post-processors. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dlatex'><span><code class="code">--latex</code><a class="copiable-link" href='#index-_002d_002dlatex'> ¶</a></span></dt> |
| <dd><p>Generate LaTeX output. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dmacro_002dexpand_003dfile'><span><code class="code">--macro-expand=<var class="var">file</var></code><a class="copiable-link" href='#index-_002d_002dmacro_002dexpand_003dfile'> ¶</a></span></dt> |
| <dt><code class="code">-E <var class="var">file</var></code></dt> |
| <dd><a class="index-entry-id" id="index-_002dE-file"></a> |
| <a class="index-entry-id" id="index-MACRO_005fEXPAND"></a> |
| <p>Output the Texinfo source, with all Texinfo macros expanded, to |
| <var class="var">file</var>. Normally, the result of macro expansion is used |
| internally by <code class="code">makeinfo</code> and then discarded. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dno_002dheaders'><span><code class="code">--no-headers</code><a class="copiable-link" href='#index-_002d_002dno_002dheaders'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-Node-separators_002c-omitting-with-_002d_002dno_002dheaders"></a> |
| <a class="index-entry-id" id="index-Generating-plain-text-files-with-_002d_002dno_002dheaders"></a> |
| <a class="index-entry-id" id="index-Menus_002c-omitting-with-_002d_002dno_002dheaders"></a> |
| <a class="index-entry-id" id="index-HEADERS"></a> |
| <p>Do not include menus or node separator lines in the output. |
| </p> |
| <p>When generating Info, this is the same as using <samp class="option">--plaintext</samp>, |
| resulting in a simple plain text file. Furthermore, |
| <code class="code">@setfilename</code> is ignored, and output is to standard output |
| unless overridden with <samp class="option">-o</samp>. (This behavior is for backward |
| compatibility.) |
| </p> |
| <a class="index-entry-id" id="index-Navigation-links_002c-omitting"></a> |
| <p>When generating HTML, and output is split, also output navigation |
| links only at the beginning of each file. If output is not split, do |
| not include navigation links at the top of each node at all. |
| See <a class="xref" href="Generating-HTML.html">Generating HTML</a>. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dnode_002dfiles'><span><code class="code">--node-files</code><a class="copiable-link" href='#index-_002d_002dnode_002dfiles'> ¶</a></span></dt> |
| <dt><code class="code">--no-node-files</code></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002dno_002dnode_002dfiles"></a> |
| <a class="index-entry-id" id="index-NODE_005fFILES"></a> |
| <p>With <samp class="option">--node-files</samp>, when generating HTML, create redirection |
| files for anchors and any nodes not already output with the file name |
| corresponding to the node name (see <a class="pxref" href="HTML-Xref-Node-Name-Expansion.html">HTML Cross-reference Node Name Expansion</a>). |
| This makes it possible for section- and chapter-level cross-manual |
| references to succeed (see <a class="pxref" href="HTML-Xref-Configuration.html">HTML Cross-reference Configuration: <samp class="file">htmlxref.cnf</samp></a>). |
| </p> |
| <p>If the output is split, this is enabled by default. If the output is |
| not split, <samp class="option">--node-files</samp> enables the creation of the |
| redirection files, in addition to the monolithic main output file. |
| <samp class="option">--no-node-files</samp> suppresses the creation of redirection files |
| in any case. This option has no effect with any output format other |
| than HTML. See <a class="xref" href="Generating-HTML.html">Generating HTML</a>. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dno_002dvalidate'><span><code class="code">--no-validate</code><a class="copiable-link" href='#index-_002d_002dno_002dvalidate'> ¶</a></span></dt> |
| <dt><code class="code">--no-pointer-validate</code></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002dno_002dpointer_002dvalidate"></a> |
| <a class="index-entry-id" id="index-Pointer-validation-1"></a> |
| <a class="anchor" id="Pointer-Validation"></a><p>Suppress the pointer-validation phase of <code class="code">makeinfo</code>—a dangerous |
| thing to do. This can also be done with the <code class="code">@novalidate</code> |
| command (see <a class="pxref" href="Formatting-Partial-Documents.html">Formatting Partial Documents</a>). |
| </p> |
| <p>If you do not suppress pointer validation, <code class="code">makeinfo</code> will check the |
| validity of cross-references and menu entries in the Texinfo file, as |
| well as node pointers if they are given explicitly. |
| </p> |
| |
| </dd> |
| <dt id='index-_002d_002dno_002dwarn'><span><code class="code">--no-warn</code><a class="copiable-link" href='#index-_002d_002dno_002dwarn'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-NO_005fWARN"></a> |
| <p>Suppress warning messages (but not error messages). |
| </p> |
| </dd> |
| <dt id='index-_002d_002dno_002dnumber_002dfootnotes'><span><code class="code">--number-footnotes</code><a class="copiable-link" href='#index-_002d_002dno_002dnumber_002dfootnotes'> ¶</a></span></dt> |
| <dt><code class="code">--no-number-footnotes</code></dt> |
| <dd><a class="index-entry-id" id="index-NUMBER_005fFOOTNOTES"></a> |
| <p>With <samp class="option">--no-number-footnotes</samp>, suppress automatic footnote |
| numbering. By default, footnotes are numbered sequentially within a node, |
| i.e., the current footnote number is reset to 1 at the start of each node. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dnumber_002dsections'><span><code class="code">--number-sections</code><a class="copiable-link" href='#index-_002d_002dnumber_002dsections'> ¶</a></span></dt> |
| <dt><code class="code">--no-number-sections</code></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002dno_002dnumber_002dsections"></a> |
| <a class="index-entry-id" id="index-NUMBER_005fSECTIONS"></a> |
| <p>With <samp class="option">--number_sections</samp> (the default), output chapter, |
| section, and appendix numbers as in printed manuals. This works only |
| with hierarchically structured manuals. You should specify |
| <code class="code">--no-number-sections</code> if your manual is not normally structured. |
| </p> |
| |
| </dd> |
| <dt id='index-_002d_002doutput_003dfile'><span><code class="code">--output=<var class="var">file</var></code><a class="copiable-link" href='#index-_002d_002doutput_003dfile'> ¶</a></span></dt> |
| <dt><code class="code">-o <var class="var">file</var></code></dt> |
| <dd><a class="index-entry-id" id="index-_002do-file"></a> |
| <a class="index-entry-id" id="index-OUTFILE"></a> |
| <a class="index-entry-id" id="index-SUBDIR"></a> |
| <p>Specify that the output should be directed to <var class="var">file</var>. This |
| overrides any file name specified in a <code class="code">@setfilename</code> command |
| found in the Texinfo source. If neither <code class="code">@setfilename</code> nor this |
| option are specified, the input file name is used to determine the |
| output name. See <a class="xref" href="_0040setfilename.html"><code class="code">@setfilename</code>: Set the Output File Name</a>. |
| </p> |
| <p>If <var class="var">file</var> is ‘<samp class="samp">-</samp>’, output goes to standard output and |
| ‘<samp class="samp">--no-split</samp>’ is implied. |
| </p> |
| <p>If <var class="var">file</var> is a directory or ends with a ‘<samp class="samp">/</samp>’ the usual rules |
| are used to determine the output file name (namely, use |
| <code class="code">@setfilename</code> or the input file name) but the files are written |
| to the <var class="var">file</var> directory. For example, ‘<samp class="samp">makeinfo -o bar/ |
| foo.texi</samp>’, with or without <samp class="option">--no-split</samp>, will write |
| <samp class="file">bar/foo.info</samp>, and possibly other files, under <samp class="file">bar/</samp>. |
| </p> |
| <p>When generating HTML and output is split, <var class="var">file</var> is used as the |
| name for the directory into which all files are written. For example, |
| ‘<samp class="samp">makeinfo -o bar --html foo.texi</samp>’ will write |
| <samp class="file">bar/index.html</samp>, among other files. |
| </p> |
| </dd> |
| <dt id='index-_002d_002doutputindent'><span><code class="code">--output-indent=<var class="var">val</var></code><a class="copiable-link" href='#index-_002d_002doutputindent'> ¶</a></span></dt> |
| <dd><p>This option now does nothing, but remains for compatibility. (It used |
| to alter indentation in XML/DocBook output.) |
| </p> |
| </dd> |
| <dt id='index-_002dP-path'><span><code class="code">-P <var class="var">path</var></code><a class="copiable-link" href='#index-_002dP-path'> ¶</a></span></dt> |
| <dd><p>Prepend <var class="var">path</var> to the directory search list for <code class="code">@include</code>. |
| If <var class="var">path</var> is not given, the current directory is prepended. See |
| ‘<samp class="samp">-I</samp>’ above. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dparagraph_002dindent_003dindent'><span><code class="code">--paragraph-indent=<var class="var">indent</var></code><a class="copiable-link" href='#index-_002d_002dparagraph_002dindent_003dindent'> ¶</a></span></dt> |
| <dt><code class="code">-p <var class="var">indent</var></code></dt> |
| <dd><a class="index-entry-id" id="index-_002dp-indent"></a> |
| <p>Set the paragraph indentation style to <var class="var">indent</var>. The value set by |
| this option overrides the value set in a Texinfo file by an |
| <code class="code">@paragraphindent</code> command (see <a class="pxref" href="_0040paragraphindent.html"><code class="code">@paragraphindent</code>: Controlling Paragraph Indentation</a>). |
| The value of <var class="var">indent</var> is interpreted as follows: |
| </p> |
| <dl class="table"> |
| <dt>‘<samp class="samp">asis</samp>’</dt> |
| <dd><p>Preserve any existing indentation (or lack thereof) at the beginnings |
| of paragraphs. |
| </p> |
| </dd> |
| <dt>‘<samp class="samp">0</samp>’ or ‘<samp class="samp">none</samp>’</dt> |
| <dd><p>Delete any existing indentation. |
| </p> |
| </dd> |
| <dt><var class="var">num</var></dt> |
| <dd><p>Indent each paragraph by <var class="var">num</var> spaces. |
| </p></dd> |
| </dl> |
| |
| <p>The default is to indent by two spaces, except for paragraphs |
| following a section heading, which are not indented. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dpdf'><span><code class="code">--pdf</code><a class="copiable-link" href='#index-_002d_002dpdf'> ¶</a></span></dt> |
| <dd><p>Generate a PDF file using <code class="command">texi2dvi --pdf</code>, rather than Info |
| (see <a class="pxref" href="texi2any-Printed-Output.html"><code class="command">texi2any</code> Printed Output</a>). |
| </p> |
| </dd> |
| <dt id='index-_002d_002dplaintext'><span><code class="code">--plaintext</code><a class="copiable-link" href='#index-_002d_002dplaintext'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-Plain-text-output-with-_002d_002dplaintext"></a> |
| <a class="index-entry-id" id="index-ASCII-text-output-with-_002d_002dplaintext"></a> |
| <a class="index-entry-id" id="index-Generating-plain-text-files-with-_002d_002dplaintext"></a> |
| <a class="index-entry-id" id="index-Node-separators_002c-omitting-with-_002d_002dplaintext"></a> |
| <a class="index-entry-id" id="index-Menus_002c-omitting-with-_002d_002dplaintext"></a> |
| <a class="index-entry-id" id="index-INSTALL-file_002c-generating"></a> |
| <p>Output a plain text file (rather than Info): do not include menus or |
| node separator lines in the output. This results in a straightforward |
| plain text file that you can (for example) send in email without |
| complications, or include in a distribution (for example, an |
| <samp class="file">INSTALL</samp> file). |
| </p> |
| <p>With this option, <code class="code">@setfilename</code> is ignored and the output goes |
| to standard output by default; this can be overridden with <samp class="option">-o</samp>. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dps'><span><code class="code">--ps</code><a class="copiable-link" href='#index-_002d_002dps'> ¶</a></span></dt> |
| <dd><p>Generate a PostScript file using <code class="command">texi2dvi --ps</code>, rather than |
| Info (see <a class="pxref" href="texi2any-Printed-Output.html"><code class="command">texi2any</code> Printed Output</a>). |
| </p> |
| </dd> |
| <dt id='index-_002d_002dset_002dcustomization_002dvariable-var_003dvalue'><span><code class="code">--set-customization-variable <var class="var">var</var>=<var class="var">value</var></code><a class="copiable-link" href='#index-_002d_002dset_002dcustomization_002dvariable-var_003dvalue'> ¶</a></span></dt> |
| <dt><code class="code">-c <var class="var">var</var>=<var class="var">value</var></code></dt> |
| <dd><a class="index-entry-id" id="index-_002dc-var_003dvalue"></a> |
| <p>Set the customization variable <var class="var">var</var> to <var class="var">value</var>. The <code class="code">=</code> |
| is optional, but both <var class="var">var</var> and <var class="var">value</var> must be quoted to the |
| shell as necessary so the result is a single word. Many aspects of |
| <code class="command">texi2any</code> behavior and output may be controlled by |
| customization variables, beyond what can be set in the document by |
| @-commands and with other command line switches. See <a class="xref" href="Customization-Variables.html">Customization Variables</a>. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dsplit_003dhow'><span><code class="code">--split=<var class="var">how</var></code><a class="copiable-link" href='#index-_002d_002dsplit_003dhow'> ¶</a></span></dt> |
| <dt><code class="code">--no-split</code></dt> |
| <dd><a class="index-entry-id" id="index-_002d_002dno_002dsplit"></a> |
| <a class="index-entry-id" id="index-Splitting-of-output-files"></a> |
| <a class="index-entry-id" id="index-Output-file-splitting"></a> |
| <a class="anchor" id="Splitting-Output"></a><p>When generating Info, by default large output files are split into |
| smaller subfiles, of approximately 300k bytes. When generating HTML, |
| by default each output file contains one node (see <a class="pxref" href="Generating-HTML.html">Generating HTML</a>). <samp class="option">--no-split</samp> suppresses this splitting of the output. |
| </p> |
| <a class="index-entry-id" id="index-SPLIT"></a> |
| <p>Alternatively, <samp class="option">--split=<var class="var">how</var></samp> may be used to specify at |
| which level the HTML output should be split. The possible values for |
| <var class="var">how</var> are: |
| </p> |
| <dl class="table"> |
| <dt>‘<samp class="samp">chapter</samp>’</dt> |
| <dd><p>The output is split at <code class="code">@chapter</code> and other sectioning |
| @-commands at this level (<code class="code">@appendix</code>, etc.). |
| </p> |
| </dd> |
| <dt>‘<samp class="samp">section</samp>’</dt> |
| <dd><p>The output is split at <code class="code">@section</code> and similar. |
| </p> |
| </dd> |
| <dt>‘<samp class="samp">node</samp>’</dt> |
| <dd><p>The output is split at every node. This is the default. |
| </p></dd> |
| </dl> |
| |
| <p>Plain text output can be split similarly to HTML. This may be useful |
| for extracting sections from a Texinfo document and making them |
| available as separate files. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dsplit_002dsize_003dnum'><span><code class="code">--split-size=<var class="var">num</var></code><a class="copiable-link" href='#index-_002d_002dsplit_002dsize_003dnum'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-SPLIT_005fSIZE"></a> |
| <p>Keep Info files to at most <var class="var">num</var> characters if possible; default |
| is 300,000. (However, a single node will never be split across Info |
| files.) |
| </p> |
| </dd> |
| <dt id='index-_002d_002dtransliterate_002dfile_002dnames'><span><code class="code">--transliterate-file-names</code><a class="copiable-link" href='#index-_002d_002dtransliterate_002dfile_002dnames'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-TRANSLITERATE_005fFILE_005fNAMES"></a> |
| <p>Enable transliteration of 8-bit characters in node names for the |
| purpose of file name creation. See <a class="xref" href="HTML-Xref-8_002dbit-Character-Expansion.html">HTML Cross-reference 8-bit Character Expansion</a>. |
| </p> |
| </dd> |
| <dt><code class="code">-U <var class="var">var</var></code></dt> |
| <dd><p>Cause <var class="var">var</var> to be undefined. This is equivalent to <code class="code">@clear |
| <var class="var">var</var></code> in the Texinfo file (see <a class="pxref" href="_0040set-_0040clear-_0040value.html">Flags: <code class="code">@set</code>, <code class="code">@clear</code>, conditionals, and <code class="code">@value</code></a>). |
| </p> |
| </dd> |
| <dt id='index-_002d_002dverbose'><span><code class="code">--verbose</code><a class="copiable-link" href='#index-_002d_002dverbose'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-VERBOSE"></a> |
| <p>Cause <code class="code">makeinfo</code> to display messages saying what it is doing. |
| Normally, <code class="code">makeinfo</code> only outputs messages if there are errors or |
| warnings. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dversion_002c-for-texi2any'><span><code class="code">--version</code><a class="copiable-link" href='#index-_002d_002dversion_002c-for-texi2any'> ¶</a></span></dt> |
| <dt><code class="code">-V</code></dt> |
| <dd><a class="index-entry-id" id="index-_002dV"></a> |
| <p>Print the version number, then exit successfully. |
| </p> |
| </dd> |
| <dt id='index-_002d_002dXopt-str'><span><code class="code">--Xopt <var class="var">str</var></code><a class="copiable-link" href='#index-_002d_002dXopt-str'> ¶</a></span></dt> |
| <dd><p>Pass <var class="var">str</var> (a single shell word) to <code class="command">texi2dvi</code>; may be |
| repeated (see <a class="pxref" href="texi2any-Printed-Output.html"><code class="command">texi2any</code> Printed Output</a>). |
| </p> |
| </dd> |
| <dt id='index-_002d_002dxml'><span><code class="code">--xml</code><a class="copiable-link" href='#index-_002d_002dxml'> ¶</a></span></dt> |
| <dd><p>Generate Texinfo XML output (rather than Info). |
| </p> |
| </dd> |
| </dl> |
| |
| |
| </div> |
| <hr> |
| <div class="nav-panel"> |
| <p> |
| Next: <a href="texi2any-Environment-Variables.html">Environment Variables Recognized by <code class="command">texi2any</code></a>, Up: <a href="Generic-Translator-texi2any.html"><code class="command">texi2any</code>: The Generic Translator for Texinfo</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p> |
| </div> |
| |
| |
| |
| </body> |
| </html> |
