JezK
Edit File: Customization-Variables-and-Options.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>Customization Variables and Options (GNU Texinfo 6.8)</title> <meta name="description" content="Customization Variables and Options (GNU Texinfo 6.8)"> <meta name="keywords" content="Customization Variables and Options (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="Customization-Variables.html" rel="up" title="Customization Variables"> <link href="HTML-Customization-Variables.html" rel="next" title="HTML Customization Variables"> <link href="Customization-Variables-for-_0040_002dCommands.html" rel="prev" title="Customization Variables for @-Commands"> <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="subsection" id="Customization-Variables-and-Options"> <div class="header"> <p> Next: <a href="HTML-Customization-Variables.html" accesskey="n" rel="next">HTML Customization Variables</a>, Previous: <a href="Customization-Variables-for-_0040_002dCommands.html" accesskey="p" rel="prev">Customization Variables for @-Commands</a>, Up: <a href="Customization-Variables.html" accesskey="u" rel="up">Customization Variables</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="Customization-Variables-and-Options-1"></span><h4 class="subsection">19.4.2 Customization Variables and Options</h4> <span id="index-Customization-variables-for-options"></span> <span id="index-Options_002c-customization-variables-for"></span> <p>The following table gives the customization variables associated with some command line options. See <a href="Invoking-texi2any.html">Invoking <code>texi2any</code>/<code>makeinfo</code> from a Shell</a>, for the meaning of the options. </p> <table> <thead><tr><th width="50%">Option</th><th width="50%">Variable</th></tr></thead> <tr><td width="50%"><samp>--enable-encoding</samp></td><td width="50%"><code>ENABLE_ENCODING</code></td></tr> <tr><td width="50%"><samp>--document-language</samp></td><td width="50%"><code>documentlanguage</code></td></tr> <tr><td width="50%"><samp>--error-limit</samp></td><td width="50%"><code>ERROR_LIMIT</code></td></tr> <tr><td width="50%"><samp>--fill-column</samp></td><td width="50%"><code>FILLCOLUMN</code></td></tr> <tr><td width="50%"><samp>--footnote-style</samp></td><td width="50%"><code>footnotestyle</code></td></tr> <tr><td width="50%"><samp>--force</samp></td><td width="50%"><code>FORCE</code></td></tr> <tr><td width="50%"><samp>--internal-links</samp></td><td width="50%"><code>INTERNAL_LINKS</code></td></tr> <tr><td width="50%"><samp>--macro-expand</samp></td><td width="50%"><code>MACRO_EXPAND</code></td></tr> <tr><td width="50%"><samp>--headers</samp></td><td width="50%"><code>HEADERS</code>, <code>FORMAT_MENU</code></td></tr> <tr><td width="50%"><samp>--no-warn</samp></td><td width="50%"><code>NO_WARN</code></td></tr> <tr><td width="50%"><span id="index-novalidate-1"></span> <samp>--no-validate</samp></td><td width="50%"><code>novalidate</code></td></tr> <tr><td width="50%"><samp>--number-footnotes</samp></td><td width="50%"><code>NUMBER_FOOTNOTES</code></td></tr> <tr><td width="50%"><samp>--number-sections</samp></td><td width="50%"><code>NUMBER_SECTIONS</code></td></tr> <tr><td width="50%"><samp>--node-files</samp></td><td width="50%"><code>NODE_FILES</code></td></tr> <tr><td width="50%"><samp>--output</samp></td><td width="50%"><code>OUTFILE</code>, <code>SUBDIR</code></td></tr> <tr><td width="50%"><span id="index-paragraphindent-1"></span> <samp>--paragraph-indent</samp></td><td width="50%"><code>paragraphindent</code></td></tr> <tr><td width="50%"><samp>--silent</samp></td><td width="50%"><code>SILENT</code></td></tr> <tr><td width="50%"><samp>--split</samp></td><td width="50%"><code>SPLIT</code></td></tr> <tr><td width="50%"><samp>--split-size</samp></td><td width="50%"><code>SPLIT_SIZE</code></td></tr> <tr><td width="50%"><samp>--transliterate-file-names</samp></td><td width="50%"><code>TRANSLITERATE_FILE_NAMES</code></td></tr> <tr><td width="50%"><samp>--verbose</samp></td><td width="50%"><code>VERBOSE</code></td></tr> </table> <p>Setting such a customization variable to a value ‘<samp>foo</samp>’ is essentially the same as specifying the <code>--<var>opt</var>=foo</code> if the option takes an argument, or <code>--<var>opt</var></code> if not. </p> <span id="index-TEXINFO_005fOUTPUT_005fFORMAT-1"></span> <p>In addition, the customization variable <code>TEXINFO_OUTPUT_FORMAT</code> allows specifying what <code>makeinfo</code> outputs, either one of the usual output formats that can be specified with options, or various other forms: </p> <dl compact="compact"> <dt id='index-docbook-1'><span>‘<samp>docbook</samp>’<a href='#index-docbook-1' class='copiable-anchor'> ¶</a></span></dt> <dt id='index-dvi'><span>‘<samp>dvi</samp>’<a href='#index-dvi' class='copiable-anchor'> ¶</a></span></dt> <dt id='index-dvipdf'><span>‘<samp>dvipdf</samp>’<a href='#index-dvipdf' class='copiable-anchor'> ¶</a></span></dt> <dt id='index-html-1'><span>‘<samp>html</samp>’<a href='#index-html-1' class='copiable-anchor'> ¶</a></span></dt> <dt id='index-info'><span>‘<samp>info</samp>’<a href='#index-info' class='copiable-anchor'> ¶</a></span></dt> <dt id='index-pdf'><span>‘<samp>pdf</samp>’<a href='#index-pdf' class='copiable-anchor'> ¶</a></span></dt> <dt id='index-plaintext'><span>‘<samp>plaintext</samp>’<a href='#index-plaintext' class='copiable-anchor'> ¶</a></span></dt> <dt id='index-ps'><span>‘<samp>ps</samp>’<a href='#index-ps' class='copiable-anchor'> ¶</a></span></dt> <dt id='index-xml-1'><span>‘<samp>xml</samp>’<a href='#index-xml-1' class='copiable-anchor'> ¶</a></span></dt> <dd><p>These correspond to the command-line options (and <code>TEXINFO_OUTPUT_FORMAT</code> environment variable values) of the same name. See <a href="Invoking-texi2any.html">Invoking <code>texi2any</code>/<code>makeinfo</code> from a Shell</a>. </p> </dd> <dt id='index-debugtree'><span>‘<samp>debugtree</samp>’<a href='#index-debugtree' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-tree-representation_002c-for-debugging"></span> <span id="index-debugging-document_002c-with-tree-representation"></span> <p>Instead of generating a regular output format, output a text representation of the tree obtained by parsing the input texinfo document. </p> </dd> <dt id='index-parse'><span>‘<samp>parse</samp>’<a href='#index-parse' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Do only Texinfo source parsing; there is no output. </p> </dd> <dt id='index-plaintexinfo'><span>‘<samp>plaintexinfo</samp>’<a href='#index-plaintexinfo' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Output the Texinfo source with all the macros, <code>@include</code> and <code>@value{}</code> expanded. This is similar to setting <samp>--macro-expand</samp>, but instead of being output in addition to the normal conversion, output of Texinfo is the main output. </p> </dd> <dt id='index-rawtext'><span>‘<samp>rawtext</samp>’<a href='#index-rawtext' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-raw-text-output"></span> <p>Output raw text, with minimal formatting. For example, footnotes are ignored and there is no paragraph filling. This is used by the parser for file names and copyright text in HTML comments, for example. </p> </dd> <dt id='index-structure'><span>‘<samp>structure</samp>’<a href='#index-structure' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Do only Texinfo source parsing and determination of the document structure; there is no output. </p> </dd> <dt id='index-texinfosxml'><span>‘<samp>texinfosxml</samp>’<a href='#index-texinfosxml' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-SXML-output"></span> <span id="index-S_002dexpressions_002c-output-format"></span> <p>Output the document in TexinfoSXML representation, a syntax for writing XML data using Lisp S-expressions. </p> </dd> <dt id='index-textcontent'><span>‘<samp>textcontent</samp>’<a href='#index-textcontent' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-spell-checking"></span> <span id="index-word-counting"></span> <span id="index-detexinfo"></span> <span id="index-stripping-Texinfo-commands"></span> <p>Output the text content only, stripped of commands; this is useful for spell checking or word counting, for example. The trivial <code>detexinfo</code> script setting this is in the <samp>util</samp> directory of the Texinfo source as an example. It’s one line: </p> <div class="example"> <pre class="example">exec texi2any -c TEXINPUT_OUTPUT_FORMAT=textcontent "$@" </pre></div> </dd> </dl> </div> <hr> <div class="header"> <p> Next: <a href="HTML-Customization-Variables.html">HTML Customization Variables</a>, Previous: <a href="Customization-Variables-for-_0040_002dCommands.html">Customization Variables for @-Commands</a>, Up: <a href="Customization-Variables.html">Customization Variables</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>