JezK
Edit File: Invoking-texi2any.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://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.8, 8 June 2021), 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-2021 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.8)</title> <meta name="description" content="Invoking texi2any (GNU Texinfo 6.8)"> <meta name="keywords" content="Invoking texi2any (GNU Texinfo 6.8)"> <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-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {margin-left: 3.2em} kbd {font-style: oblique} pre.display {font-family: inherit} pre.format {font-family: inherit} pre.menu-comment {font-family: serif} pre.menu-preformatted {font-family: serif} span.nolinebreak {white-space: nowrap} span.roman {font-family: initial; font-weight: normal} span.sansserif {font-family: sans-serif; font-weight: normal} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="section" id="Invoking-texi2any"> <div class="header"> <p> Next: <a href="texi2any-Environment-Variables.html" accesskey="n" rel="next">Environment Variables Recognized by <code>texi2any</code></a>, Up: <a href="Generic-Translator-texi2any.html" accesskey="u" rel="up"><code>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> <span id="Invoking-texi2any_002fmakeinfo-from-a-Shell"></span><h3 class="section">19.1 Invoking <code>texi2any</code>/<code>makeinfo</code> from a Shell</h3> <span id="Invoking-makeinfo"></span><span id="index-makeinfo"></span> <span id="index-texi2any"></span> <p>To process a Texinfo file, invoke <code>texi2any</code> or <code>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">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>-</samp>’, standard input is read. </p> <span id="makeinfo-Options"></span><span id="index-makeinfo-options"></span> <span id="index-Options-for-makeinfo"></span> <span id="texi2any-Options"></span><span id="index-texi2any-options"></span> <span id="index-Options-for-texi2any"></span> <p>The <code>texi2any</code> program accepts many options. Perhaps the most basic are those that change the output format. By default, <code>texi2any</code> outputs Info. </p> <p>Each command line option is either a long name preceded by ‘<samp>--</samp>’ or a single letter preceded by ‘<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>bison.texinfo</samp> in which lines are filled to only 68 columns: </p> <div class="example"> <pre class="example">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">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 compact="compact"> <dt id='index-_002d_002dcommands_002din_002dnode_002dnames'><span><code>--commands-in-node-names</code><a href='#index-_002d_002dcommands_002din_002dnode_002dnames' class='copiable-anchor'> ¶</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>@value</code>. This is now done by default.) </p> </dd> <dt id='index-_002d_002dconf_002ddir_003ddir'><span><code>--conf-dir=<var>dir</var></code><a href='#index-_002d_002dconf_002ddir_003ddir' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Prepend <var>dir</var> to the directory search list for finding customization files that may be loaded with <samp>--init-file</samp> (see below). The <var>dir</var> value can be a single directory, or a list of several directories separated by the usual path separator character (‘<samp>:</samp>’ on Unix-like systems, ‘<samp>;</samp>’ on Windows). </p> </dd> <dt id='index-_002d_002dcss_002dinclude'><span><code>--css-include=<var>file</var></code><a href='#index-_002d_002dcss_002dinclude' class='copiable-anchor'> ¶</a></span></dt> <dd><p>When producing HTML, literally include the contents of <var>file</var>, which should contain W3C cascading style sheets specifications, in the ‘<samp><style></samp>’ block of the HTML output. If <var>file</var> is ‘<samp>-</samp>’, read standard input. See <a href="HTML-CSS.html">HTML CSS</a>. </p> </dd> <dt id='index-_002d_002dcss_002dref'><span><code>--css-ref=<var>url</var></code><a href='#index-_002d_002dcss_002dref' class='copiable-anchor'> ¶</a></span></dt> <dd><p>When producing HTML, add a ‘<samp><link></samp>’ tag to the output which references a cascading style sheet at <var>url</var>. This allows using standalone style sheets. </p> </dd> <dt id='index-_002dD-var'><span><code>-D <var>var</var></code><a href='#index-_002dD-var' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>-D '<var>var</var> <var>value</var>'</code></span></dt> <dd><p>Cause the Texinfo variable <var>var</var> to be defined. This is equivalent to <code>@set <var>var</var></code> in the Texinfo file (see <a href="_0040set-_0040clear-_0040value.html">Flags: <code>@set</code>, <code>@clear</code>, conditionals, and <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>-D 'myvar someval'</code> is equivalent to <code>@set myvar someval</code>. </p> </dd> <dt id='index-_002d_002ddisable_002dencoding'><span><code>--disable-encoding</code><a href='#index-_002d_002ddisable_002dencoding' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>--enable-encoding</code></span></dt> <dd><span id="index-_002d_002denable_002dencoding"></span> <span id="index-ENABLE_005fENCODING"></span> <p>By default, or with <samp>--enable-encoding</samp>, output accented and special characters in Info and plain text output based on ‘<samp>@documentencoding</samp>’. With <samp>--disable-encoding</samp>, 7-bit ASCII transliterations are output. See <a href="_0040documentencoding.html"><code>@documentencoding <var>enc</var></code>: Set Input Encoding</a>, and <a href="Inserting-Accents.html">Inserting Accents</a>. </p> </dd> <dt id='index-_002d_002ddocbook'><span><code>--docbook</code><a href='#index-_002d_002ddocbook' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Generate DocBook output (rather than Info). </p> </dd> <dt id='index-_002d_002ddocument_002dlanguage'><span><code>--document-language=<var>lang</var></code><a href='#index-_002d_002ddocument_002dlanguage' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Use <var>lang</var> to translate Texinfo keywords which end up in the output document. The default is the locale specified by the <code>@documentlanguage</code> command if there is one, otherwise English (see <a href="_0040documentlanguage.html"><code>@documentlanguage <var>ll</var>[_<var>cc</var>]</code>: Set the Document Language</a>). </p> </dd> <dt id='index-_002d_002ddvi'><span><code>--dvi</code><a href='#index-_002d_002ddvi' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Generate a TeX DVI file using <code>texi2dvi</code>, rather than Info (see <a href="texi2any-Printed-Output.html"><code>texi2any</code> Printed Output</a>). </p> </dd> <dt id='index-_002d_002ddvipdf'><span><code>--dvipdf</code><a href='#index-_002d_002ddvipdf' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Generate a PDF file using <code>texi2dvi --dvipdf</code>, rather than Info (see <a href="texi2any-Printed-Output.html"><code>texi2any</code> Printed Output</a>). </p> </dd> <dt id='index-_002d_002derror_002dlimit_003dlimit'><span><code>--error-limit=<var>limit</var></code><a href='#index-_002d_002derror_002dlimit_003dlimit' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>-e <var>limit</var></code></span></dt> <dd><span id="index-_002de-limit"></span> <span id="index-ERROR_005fLIMIT"></span> <p>Report <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>--fill-column=<var>width</var></code><a href='#index-_002d_002dfill_002dcolumn_003dwidth' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>-f <var>width</var></code></span></dt> <dd><span id="index-_002df-width"></span> <span id="index-FILLCOLUMN"></span> <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>--footnote-style=<var>style</var></code><a href='#index-_002d_002dfootnote_002dstyle_003dstyle' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>-s <var>style</var></code></span></dt> <dd><span id="index-_002ds-style"></span> <span id="index-footnotestyle-1"></span> <p>Set the footnote style to <var>style</var>: either ‘<samp>end</samp>’ for the end node style (the default) or ‘<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>@footnotestyle</code> command (see <a href="Footnote-Styles.html">Footnote Styles</a>). </p> <p>When the footnote style is ‘<samp>separate</samp>’, <code>makeinfo</code> makes a new node containing the footnotes found in the current node. When the footnote style is ‘<samp>end</samp>’, <code>makeinfo</code> places the footnote references at the end of the current node. </p> <p>In HTML, when the footnote style is ‘<samp>end</samp>’, or if the output is not split, footnotes are put at the end of the output. If set to ‘<samp>separate</samp>’, and the output is split, they are placed in a separate file. </p> </dd> <dt id='index-_002d_002dforce'><span><code>--force</code><a href='#index-_002d_002dforce' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>-F</code></span></dt> <dd><span id="index-_002dF"></span> <span id="index-FORCE"></span> <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>--help</code><a href='#index-_002d_002dhelp_002c-for-texi2any' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>-h</code></span></dt> <dd><span id="index-_002dh"></span> <p>Print a message with available options and basic usage, then exit successfully. </p> </dd> <dt id='index-_002d_002dhtml'><span><code>--html</code><a href='#index-_002d_002dhtml' class='copiable-anchor'> ¶</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 href="Generating-HTML.html">Generating HTML</a>. </p> </dd> <dt id='index-_002dI-dir'><span><code>-I <var>dir</var></code><a href='#index-_002dI-dir' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Append <var>dir</var> to the directory search list for finding files that are included using the <code>@include</code> command. By default, <code>texi2any</code> searches only the current directory. If <var>dir</var> is not given, the current directory is appended. The <var>dir</var> value can be a single directory or a list of several directories separated by the usual path separator character (‘<samp>:</samp>’ on Unix-like systems, ‘<samp>;</samp>’ on Windows). </p> </dd> <dt id='index-_002d_002difxml'><span><code>--ifdocbook</code><a href='#index-_002d_002difxml' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-_002d_002difdocbook"></span> </dd> <dt><span><code>--ifhtml</code></span></dt> <dd><span id="index-_002d_002difhtml"></span> </dd> <dt><span><code>--ifinfo</code></span></dt> <dd><span id="index-_002d_002difinfo"></span> </dd> <dt><span><code>--ifplaintext</code></span></dt> <dd><span id="index-_002d_002difplaintext"></span> </dd> <dt><span><code>--iftex</code></span></dt> <dd><span id="index-_002d_002diftex"></span> </dd> <dt><span><code>--ifxml</code></span></dt> <dd><p>For the given format, process ‘<samp>@if<var>format</var></samp>’ and ‘<samp>@<var>format</var></samp>’ commands, and do not process ‘<samp>@ifnot<var>format</var></samp>’, regardless of the format being output. For instance, if <samp>--iftex</samp> is given, then ‘<samp>@iftex</samp>’ and ‘<samp>@tex</samp>’ blocks will be read, and ‘<samp>@ifnottex</samp>’ blocks will be ignored. </p> </dd> <dt id='index-_002d_002dinfo'><span><code>--info</code><a href='#index-_002d_002dinfo' class='copiable-anchor'> ¶</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>@setfilename</code> (see <a href="_0040setfilename.html"><code>@setfilename</code>: Set the Output File Name</a>). See <a href="Tag-and-Split-Files.html">Tag Files and Split Files</a>. </p> </dd> <dt id='index-_002d_002dinit_002dfile_003dfile'><span><code>--init-file=<var>file</var></code><a href='#index-_002d_002dinit_002dfile_003dfile' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Load <var>file</var> as code to modify the behavior and output of the generated manual. It is customary to use the <code>.pm</code> or the <code>.init</code> extensions for these customization files, but that is not enforced; the <var>file</var> name can be anything. The <samp>--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>--internal-links=<var>file</var></code><a href='#index-_002d_002dinternal_002dlinks_003dfile' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-Internal-links_002c-of-HTML"></span> <span id="index-INTERNAL_005fLINKS"></span> <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_002dmacro_002dexpand_003dfile'><span><code>--macro-expand=<var>file</var></code><a href='#index-_002d_002dmacro_002dexpand_003dfile' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>-E <var>file</var></code></span></dt> <dd><span id="index-_002dE-file"></span> <span id="index-MACRO_005fEXPAND"></span> <p>Output the Texinfo source, with all Texinfo macros expanded, to <var>file</var>. Normally, the result of macro expansion is used internally by <code>makeinfo</code> and then discarded. </p> </dd> <dt id='index-_002d_002dno_002dheaders'><span><code>--no-headers</code><a href='#index-_002d_002dno_002dheaders' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-Node-separators_002c-omitting-with-_002d_002dno_002dheaders"></span> <span id="index-Generating-plain-text-files-with-_002d_002dno_002dheaders"></span> <span id="index-Menus_002c-omitting-with-_002d_002dno_002dheaders"></span> <span id="index-HEADERS"></span> <p>Do not include menus or node separator lines in the output. </p> <p>When generating Info, this is the same as using <samp>--plaintext</samp>, resulting in a simple plain text file. Furthermore, <code>@setfilename</code> is ignored, and output is to standard output unless overridden with <samp>-o</samp>. (This behavior is for backward compatibility.) </p> <span id="index-Navigation-links_002c-omitting"></span> <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 href="Generating-HTML.html">Generating HTML</a>. </p> </dd> <dt id='index-_002d_002dno_002difxml'><span><code>--no-ifdocbook</code><a href='#index-_002d_002dno_002difxml' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-_002d_002dno_002difdocbook"></span> </dd> <dt><span><code>--no-ifhtml</code></span></dt> <dd><span id="index-_002d_002dno_002difhtml"></span> </dd> <dt><span><code>--no-ifinfo</code></span></dt> <dd><span id="index-_002d_002dno_002difinfo"></span> </dd> <dt><span><code>--no-ifplaintext</code></span></dt> <dd><span id="index-_002d_002dno_002difplaintext"></span> </dd> <dt><span><code>--no-iftex</code></span></dt> <dd><span id="index-_002d_002dno_002diftex"></span> </dd> <dt><span><code>--no-ifxml</code></span></dt> <dd><p>For the given format, do not process ‘<samp>@if<var>format</var></samp>’ and ‘<samp>@<var>format</var></samp>’ commands, and do process ‘<samp>@ifnot<var>format</var></samp>’, regardless of the format being output. For instance, if <samp>--no-ifhtml</samp> is given, then ‘<samp>@ifhtml</samp>’ and ‘<samp>@html</samp>’ blocks will not be read, and ‘<samp>@ifnothtml</samp>’ blocks will be. </p> </dd> <dt id='index-_002d_002dno_002dnode_002dfiles'><span><code>--no-node-files</code><a href='#index-_002d_002dno_002dnode_002dfiles' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>--node-files</code></span></dt> <dd><span id="index-_002d_002dnode_002dfiles"></span> <span id="index-NODE_005fFILES"></span> <p>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 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 href="HTML-Xref-Configuration.html">HTML Cross-reference Configuration: <samp>htmlxref.cnf</samp></a>). </p> <p>If the output is split, this is enabled by default. If the output is not split, <samp>--node-files</samp> enables the creation of the redirection files, in addition to the monolithic main output file. <samp>--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 href="Generating-HTML.html">Generating HTML</a>. </p> </dd> <dt id='index-_002d_002dno_002dnumber_002dfootnotes'><span><code>--no-number-footnotes</code><a href='#index-_002d_002dno_002dnumber_002dfootnotes' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>--number-footnotes</code></span></dt> <dd><span id="index-NUMBER_005fFOOTNOTES"></span> <p>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_002dno_002dnumber_002dsections'><span><code>--no-number-sections</code><a href='#index-_002d_002dno_002dnumber_002dsections' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>--number-sections</code></span></dt> <dd><span id="index-_002d_002dnumber_002dsections"></span> <span id="index-NUMBER_005fSECTIONS"></span> <p>With <samp>--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>--no-number-sections</code> if your manual is not normally structured. </p> </dd> <dt id='index-_002d_002dno_002dvalidate'><span><code>--no-validate</code><a href='#index-_002d_002dno_002dvalidate' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>--no-pointer-validate</code></span></dt> <dd><span id="index-_002d_002dno_002dpointer_002dvalidate"></span> <span id="index-Pointer-validation-1"></span> <span id="Pointer-Validation"></span><p>Suppress the pointer-validation phase of <code>makeinfo</code>—a dangerous thing to do. This can also be done with the <code>@novalidate</code> command (see <a href="Formatting-Partial-Documents.html">Formatting Partial Documents</a>). </p> <p>If you do not suppress pointer validation, <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>--no-warn</code><a href='#index-_002d_002dno_002dwarn' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-NO_005fWARN"></span> <p>Suppress warning messages (but not error messages). </p> </dd> <dt id='index-_002d_002doutput_003dfile'><span><code>--output=<var>file</var></code><a href='#index-_002d_002doutput_003dfile' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>-o <var>file</var></code></span></dt> <dd><span id="index-_002do-file"></span> <span id="index-OUTFILE"></span> <span id="index-SUBDIR"></span> <p>Specify that the output should be directed to <var>file</var>. This overrides any file name specified in a <code>@setfilename</code> command found in the Texinfo source. If neither <code>@setfilename</code> nor this option are specified, the input file name is used to determine the output name. See <a href="_0040setfilename.html"><code>@setfilename</code>: Set the Output File Name</a>. </p> <p>If <var>file</var> is ‘<samp>-</samp>’, output goes to standard output and ‘<samp>--no-split</samp>’ is implied. </p> <p>If <var>file</var> is a directory or ends with a ‘<samp>/</samp>’ the usual rules are used to determine the output file name (namely, use <code>@setfilename</code> or the input file name) but the files are written to the <var>file</var> directory. For example, ‘<samp>makeinfo -o bar/ foo.texi</samp>’, with or without <samp>--no-split</samp>, will write <samp>bar/foo.info</samp>, and possibly other files, under <samp>bar/</samp>. </p> <p>When generating HTML and output is split, <var>file</var> is used as the name for the directory into which all files are written. For example, ‘<samp>makeinfo -o bar --html foo.texi</samp>’ will write <samp>bar/index.html</samp>, among other files. </p> </dd> <dt id='index-_002d_002doutputindent'><span><code>--output-indent=<var>val</var></code><a href='#index-_002d_002doutputindent' class='copiable-anchor'> ¶</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>-P <var>path</var></code><a href='#index-_002dP-path' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Prepend <var>path</var> to the directory search list for <code>@include</code>. If <var>path</var> is not given, the current directory is prepended. See ‘<samp>-I</samp>’ above. </p> </dd> <dt id='index-_002d_002dparagraph_002dindent_003dindent'><span><code>--paragraph-indent=<var>indent</var></code><a href='#index-_002d_002dparagraph_002dindent_003dindent' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>-p <var>indent</var></code></span></dt> <dd><span id="index-_002dp-indent"></span> <p>Set the paragraph indentation style to <var>indent</var>. The value set by this option overrides the value set in a Texinfo file by an <code>@paragraphindent</code> command (see <a href="_0040paragraphindent.html"><code>@paragraphindent</code>: Controlling Paragraph Indentation</a>). The value of <var>indent</var> is interpreted as follows: </p> <dl compact="compact"> <dt><span>‘<samp>asis</samp>’</span></dt> <dd><p>Preserve any existing indentation (or lack thereof) at the beginnings of paragraphs. </p> </dd> <dt><span>‘<samp>0</samp>’ or ‘<samp>none</samp>’</span></dt> <dd><p>Delete any existing indentation. </p> </dd> <dt><span><var>num</var></span></dt> <dd><p>Indent each paragraph by <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>--pdf</code><a href='#index-_002d_002dpdf' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Generate a PDF file using <code>texi2dvi --pdf</code>, rather than Info (see <a href="texi2any-Printed-Output.html"><code>texi2any</code> Printed Output</a>). </p> </dd> <dt id='index-_002d_002dplaintext'><span><code>--plaintext</code><a href='#index-_002d_002dplaintext' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-Plain-text-output-with-_002d_002dplaintext"></span> <span id="index-ASCII-text-output-with-_002d_002dplaintext"></span> <span id="index-Generating-plain-text-files-with-_002d_002dplaintext"></span> <span id="index-Node-separators_002c-omitting-with-_002d_002dplaintext"></span> <span id="index-Menus_002c-omitting-with-_002d_002dplaintext"></span> <span id="index-INSTALL-file_002c-generating"></span> <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>INSTALL</samp> file). </p> <p>With this option, <code>@setfilename</code> is ignored and the output goes to standard output by default; this can be overridden with <samp>-o</samp>. </p> </dd> <dt id='index-_002d_002dps'><span><code>--ps</code><a href='#index-_002d_002dps' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Generate a PostScript file using <code>texi2dvi --ps</code>, rather than Info (see <a href="texi2any-Printed-Output.html"><code>texi2any</code> Printed Output</a>). </p> </dd> <dt id='index-_002d_002dset_002dcustomization_002dvariable-var_003dvalue'><span><code>--set-customization-variable <var>var</var>=<var>value</var></code><a href='#index-_002d_002dset_002dcustomization_002dvariable-var_003dvalue' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>-c <var>var</var>=<var>value</var></code></span></dt> <dd><span id="index-_002dc-var_003dvalue"></span> <p>Set the customization variable <var>var</var> to <var>value</var>. The <code>=</code> is optional, but both <var>var</var> and <var>value</var> must be quoted to the shell as necessary so the result is a single word. Many aspects of <code>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 href="Customization-Variables.html">Customization Variables</a>. </p> </dd> <dt id='index-_002d_002dsplit_003dhow'><span><code>--split=<var>how</var></code><a href='#index-_002d_002dsplit_003dhow' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>--no-split</code></span></dt> <dd><span id="index-_002d_002dno_002dsplit"></span> <span id="index-Splitting-of-output-files"></span> <span id="index-Output-file-splitting"></span> <span id="Splitting-Output"></span><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 href="Generating-HTML.html">Generating HTML</a>). <samp>--no-split</samp> suppresses this splitting of the output. </p> <span id="index-SPLIT"></span> <p>Alternatively, <samp>--split=<var>how</var></samp> may be used to specify at which level the HTML output should be split. The possible values for <var>how</var> are: </p> <dl compact="compact"> <dt><span>‘<samp>chapter</samp>’</span></dt> <dd><p>The output is split at <code>@chapter</code> and other sectioning @-commands at this level (<code>@appendix</code>, etc.). </p> </dd> <dt><span>‘<samp>section</samp>’</span></dt> <dd><p>The output is split at <code>@section</code> and similar. </p> </dd> <dt><span>‘<samp>node</samp>’</span></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>--split-size=<var>num</var></code><a href='#index-_002d_002dsplit_002dsize_003dnum' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-SPLIT_005fSIZE"></span> <p>Keep Info files to at most <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>--transliterate-file-names</code><a href='#index-_002d_002dtransliterate_002dfile_002dnames' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-TRANSLITERATE_005fFILE_005fNAMES"></span> <p>Enable transliteration of 8-bit characters in node names for the purpose of file name creation. See <a href="HTML-Xref-8_002dbit-Character-Expansion.html">HTML Cross-reference 8-bit Character Expansion</a>. </p> </dd> <dt><span><code>-U <var>var</var></code></span></dt> <dd><p>Cause <var>var</var> to be undefined. This is equivalent to <code>@clear <var>var</var></code> in the Texinfo file (see <a href="_0040set-_0040clear-_0040value.html">Flags: <code>@set</code>, <code>@clear</code>, conditionals, and <code>@value</code></a>). </p> </dd> <dt id='index-_002d_002dverbose'><span><code>--verbose</code><a href='#index-_002d_002dverbose' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-VERBOSE"></span> <p>Cause <code>makeinfo</code> to display messages saying what it is doing. Normally, <code>makeinfo</code> only outputs messages if there are errors or warnings. </p> </dd> <dt id='index-_002d_002dversion_002c-for-texi2any'><span><code>--version</code><a href='#index-_002d_002dversion_002c-for-texi2any' class='copiable-anchor'> ¶</a></span></dt> <dt><span><code>-V</code></span></dt> <dd><span id="index-_002dV"></span> <p>Print the version number, then exit successfully. </p> </dd> <dt id='index-_002d_002dXopt-str'><span><code>--Xopt <var>str</var></code><a href='#index-_002d_002dXopt-str' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Pass <var>str</var> (a single shell word) to <code>texi2dvi</code>; may be repeated (see <a href="texi2any-Printed-Output.html"><code>texi2any</code> Printed Output</a>). </p> </dd> <dt id='index-_002d_002dxml'><span><code>--xml</code><a href='#index-_002d_002dxml' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Generate Texinfo XML output (rather than Info). </p> </dd> </dl> </div> <hr> <div class="header"> <p> Next: <a href="texi2any-Environment-Variables.html">Environment Variables Recognized by <code>texi2any</code></a>, Up: <a href="Generic-Translator-texi2any.html"><code>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>