/usr/share/doc/texinfo/html/makeinfo-options.html is in texinfo-doc-nonfree 4.13a-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 | <html lang="en">
<head>
<title>makeinfo options - GNU Texinfo 4.13</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Texinfo 4.13">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Creating-an-Info-File.html#Creating-an-Info-File" title="Creating an Info File">
<link rel="prev" href="Invoking-makeinfo.html#Invoking-makeinfo" title="Invoking makeinfo">
<link rel="next" href="Pointer-Validation.html#Pointer-Validation" title="Pointer Validation">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual is for GNU Texinfo (version 4.13, 18 September 2008),
a documentation system that can produce both online information and a
printed manual from a single source.
Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
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.2 or any later version published by the Free Software
Foundation; with no Invariant Sections, with the Front-Cover Texts
being ``A GNU Manual'', and with the Back-Cover Texts as in (a)
below. A copy of the license is included in the section entitled
``GNU Free Documentation License.''
(a) The FSF's Back-Cover Text is: ``You are free to copy and modify
this GNU Manual. Buying copies from GNU Press supports the FSF in
developing GNU and promoting software freedom.''
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="makeinfo-options"></a>
<p>
Next: <a rel="next" accesskey="n" href="Pointer-Validation.html#Pointer-Validation">Pointer Validation</a>,
Previous: <a rel="previous" accesskey="p" href="Invoking-makeinfo.html#Invoking-makeinfo">Invoking makeinfo</a>,
Up: <a rel="up" accesskey="u" href="Creating-an-Info-File.html#Creating-an-Info-File">Creating an Info File</a>
<hr>
</div>
<h4 class="subsection">21.1.3 Options for <code>makeinfo</code></h4>
<p><a name="index-g_t_0040code_007bmakeinfo_007d-options-1211"></a><a name="index-Options-for-_0040code_007bmakeinfo_007d-1212"></a>
The <samp><span class="command">makeinfo</span></samp> program accepts many options. Perhaps the most
commonly needed are those that change the output format. By default,
<samp><span class="command">makeinfo</span></samp> outputs Info files.
<p>Each command line option is a word preceded by ‘<samp><span class="samp">--</span></samp>’ or a letter
preceded by ‘<samp><span class="samp">-</span></samp>’. You can use abbreviations for the long option
names as long as they are unique.
<p>For example, you could use the following shell command to create an Info
file for <samp><span class="file">bison.texinfo</span></samp> in which each line is filled to only 68
columns:
<pre class="example"> makeinfo --fill-column=68 bison.texinfo
</pre>
<p>You can write two or more options in sequence, like this:
<pre class="example"> makeinfo --no-split --fill-column=70 ...
</pre>
<p class="noindent">This would keep the Info file together as one possibly very long
file and would also set the fill column to 70.
<p>The options are:
<dl>
<dt><code>-D </code><var>var</var><dd><a name="index-g_t_002dD-_0040var_007bvar_007d-1213"></a>Cause the variable <var>var</var> to be defined. This is equivalent to
<code>@set </code><var>var</var> in the Texinfo file (see <a href="set-clear-value.html#set-clear-value">set clear value</a>).
<br><dt><code>--commands-in-node-names</code><dd><a name="index-g_t_002d_002dcommands_002din_002dnode_002dnames-1214"></a>Allow <code>@</code>-commands in node names. This is not recommended, as it
can probably never be implemented in TeX. It also makes
<code>makeinfo</code> much slower. Also, this option is ignored when
‘<samp><span class="samp">--no-validate</span></samp>’ is used. See <a href="Pointer-Validation.html#Pointer-Validation">Pointer Validation</a>, for more
details.
<br><dt><code>--css-include=</code><var>file</var><dd><a name="index-g_t_002d_002dcss_002dinclude-1215"></a>Include the contents of <var>file</var>, which should contain cascading
style sheets specifications, in the ‘<samp><span class="samp"><style></span></samp>’ block of the HTML
output. See <a href="HTML-CSS.html#HTML-CSS">HTML CSS</a>. If <var>file</var> is ‘<samp><span class="samp">-</span></samp>’, read standard
input.
<br><dt><code>--css-ref=</code><var>url</var><dd><a name="index-g_t_002d_002dcss_002dref-1216"></a>In HTML mode, add a ‘<samp><span class="samp"><link></span></samp>’ tag to the HTML output which
references a cascading style sheet at <var>url</var>. This allows using
standalone style sheets.
<br><dt><code>--disable-encoding</code><dt><code>--enable-encoding</code><dd><a name="index-g_t_002d_002ddisable_002dencoding-1217"></a><a name="index-g_t_002d_002denable_002dencoding-1218"></a>By default, or with <samp><span class="option">--enable-encoding</span></samp>, output accented and
special characters in Info or plain text output based on
‘<samp><span class="samp">@documentencoding</span></samp>’. With <samp><span class="option">--disable-encoding</span></samp>, 7-bit
ASCII transliterations are output.
See <a href="documentencoding.html#documentencoding"><code>documentencoding</code></a>, and <a href="Inserting-Accents.html#Inserting-Accents">Inserting Accents</a>.
<br><dt><code>--docbook</code><dd><a name="index-g_t_002d_002ddocbook-1219"></a>Generate Docbook output rather than Info.
<br><dt><code>--document-language=</code><var>lang</var><dd><a name="index-g_t_002d_002ddocument_002dlanguage-1220"></a><a name="index-LANG-1221"></a>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
(see <a href="documentlanguage.html#documentlanguage">documentlanguage</a>).
<br><dt><code>--error-limit=</code><var>limit</var><dt><code>-e </code><var>limit</var><dd><a name="index-g_t_002d_002derror_002dlimit_003d_0040var_007blimit_007d-1222"></a><a name="index-g_t_002de-_0040var_007blimit_007d-1223"></a>Set the maximum number of errors that <code>makeinfo</code> will report
before exiting (on the assumption that continuing would be useless);
default 100.
<br><dt><code>--fill-column=</code><var>width</var><dt><code>-f </code><var>width</var><dd><a name="index-g_t_002d_002dfill_002dcolumn_003d_0040var_007bwidth_007d-1224"></a><a name="index-g_t_002df-_0040var_007bwidth_007d-1225"></a>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. Ignored with ‘<samp><span class="samp">--html</span></samp>’.
<br><dt><code>--footnote-style=</code><var>style</var><dt><code>-s </code><var>style</var><dd><a name="index-g_t_002d_002dfootnote_002dstyle_003d_0040var_007bstyle_007d-1226"></a><a name="index-g_t_002ds-_0040var_007bstyle_007d-1227"></a>Set the footnote style to <var>style</var>, either ‘<samp><span class="samp">end</span></samp>’ for the end
node style (the default) or ‘<samp><span class="samp">separate</span></samp>’ for the separate node style.
The value set by this option overrides the value set in a Texinfo file
by an <code>@footnotestyle</code> command (see <a href="Footnotes.html#Footnotes">Footnotes</a>). When the
footnote style is ‘<samp><span class="samp">separate</span></samp>’, <code>makeinfo</code> makes a new node
containing the footnotes found in the current node. When the footnote
style is ‘<samp><span class="samp">end</span></samp>’, <code>makeinfo</code> places the footnote references at
the end of the current node. Ignored with ‘<samp><span class="samp">--html</span></samp>’.
<br><dt><code>--force</code><dt><code>-F</code><dd><a name="index-g_t_002d_002dforce-1228"></a><a name="index-g_t_002dF-1229"></a>Ordinarily, if the input file has errors, the output files are not
created. With this option, they are preserved.
<br><dt><code>--help</code><dt><code>-h</code><dd><a name="index-g_t_002d_002dhelp-1230"></a><a name="index-g_t_002dh-1231"></a>Print a usage message listing all available options, then exit successfully.
<br><dt><code>--html</code><dd><a name="index-g_t_002d_002dhtml-1232"></a>Generate HTML output rather than Info. See <a href="Generating-HTML.html#Generating-HTML">Generating HTML</a>. By
default, the HTML output is split into one output file per Texinfo
source node, and the split output is written into a subdirectory with
the name of the top-level info file.
<br><dt><code>-I </code><var>dir</var><dd><a name="index-g_t_002dI-_0040var_007bdir_007d-1233"></a>Append <var>dir</var> to the directory search list for finding files that
are included using the <code>@include</code> command. By default,
<code>makeinfo</code> searches only the current directory. If <var>dir</var> is
not given, the current directory <samp><span class="file">.</span></samp> is appended. Note that
<var>dir</var> can actually be a list of several directories separated by the
usual path separator character (‘<samp><span class="samp">:</span></samp>’ on Unix, ‘<samp><span class="samp">;</span></samp>’ on
MS-DOS/MS-Windows).
<br><dt><code>--ifdocbook</code><dd><a name="index-g_t_002d_002difdocbook-1234"></a><dt><code>--ifhtml</code><dd><a name="index-g_t_002d_002difhtml-1235"></a><dt><code>--ifinfo</code><dd><a name="index-g_t_002d_002difinfo-1236"></a><dt><code>--ifplaintext</code><dd><a name="index-g_t_002d_002difplaintext-1237"></a><dt><code>--iftex</code><dd><a name="index-g_t_002d_002diftex-1238"></a><dt><code>--ifxml</code><dd><a name="index-g_t_002d_002difxml-1239"></a>For the specified format, process ‘<samp><span class="samp">@if</span><var>format</var></samp>’ and
‘<samp><span class="samp">@</span><var>format</var></samp>’ commands even if not generating the given output
format. For instance, if <samp><span class="option">--iftex</span></samp> is specified, then
‘<samp><span class="samp">@iftex</span></samp>’ and ‘<samp><span class="samp">@tex</span></samp>’ blocks will be read.
<br><dt><code>--internal-links=</code><var>file</var><dd><a name="index-g_t_002d_002dinternal_002dlinks_003d_0040var_007bfile_007d-1240"></a>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 "toc") in which it occurs, and the term
which was indexed or entered.
<br><dt><code>--macro-expand=</code><var>file</var><dt><code>-E </code><var>file</var><dd><a name="index-g_t_002d_002dmacro_002dexpand_003d_0040var_007bfile_007d-1241"></a><a name="index-g_t_002dE-_0040var_007bfile_007d-1242"></a>Output the Texinfo source with all the macros expanded to the named
file. Normally, the results of macro expansion are used internally by
<code>makeinfo</code> and then discarded. This option is used by
<samp><span class="command">texi2dvi</span></samp>.
<br><dt><code>--no-headers</code><br><dt><code>--plaintext</code><dd><a name="index-g_t_002d_002dno_002dheaders-1243"></a><a name="index-g_t_002d_002dplaintext-1244"></a><a name="index-Plain-text-output-1245"></a><a name="index-ASCII-text-output-1246"></a><a name="index-Generating-plain-text-files-1247"></a><a name="index-g_t_0040file_007bINSTALL_007d-file_002c-generating-1248"></a><a name="index-Node-separators_002c-omitting-1249"></a><a name="index-Menus_002c-omitting-1250"></a>Do not include menus or node separator lines in the output, and
implicitly <samp><span class="option">--enable-encoding</span></samp> (see above). This results in a
simple plain text file that you can (for example) send in email
without complications, or include in a distribution (as in an
<samp><span class="file">INSTALL</span></samp> file).
<p><a name="index-Navigation-links_002c-omitting-1251"></a>For HTML output, likewise omit menus. And if ‘<samp><span class="samp">--no-split</span></samp>’ is also
specified, do not include a navigation links at the top of each node
(these are never included in the default case of split output).
See <a href="Generating-HTML.html#Generating-HTML">Generating HTML</a>.
<p>In both cases, ignore <code>@setfilename</code> and write to standard
output by default—can be overridden with <samp><span class="option">-o</span></samp>.
<br><dt><code>--no-ifdocbook</code><dd><a name="index-g_t_002d_002dno_002difdocbook-1252"></a><dt><code>--no-ifhtml</code><dd><a name="index-g_t_002d_002dno_002difhtml-1253"></a><dt><code>--no-ifinfo</code><dd><a name="index-g_t_002d_002dno_002difinfo-1254"></a><dt><code>--no-ifplaintext</code><dd><a name="index-g_t_002d_002dno_002difplaintext-1255"></a><dt><code>--no-iftex</code><dd><a name="index-g_t_002d_002dno_002diftex-1256"></a><dt><code>--no-ifxml</code><dd><a name="index-g_t_002d_002dno_002difxml-1257"></a>Do not process ‘<samp><span class="samp">@if</span><var>format</var></samp>’ and ‘<samp><span class="samp">@</span><var>format</var></samp>’
commands, and do process ‘<samp><span class="samp">@ifnot</span><var>format</var></samp>’, even if
generating the given format. For instance, if <samp><span class="option">--no-ifhtml</span></samp> is
specified, then ‘<samp><span class="samp">@ifhtml</span></samp>’ and ‘<samp><span class="samp">@html</span></samp>’ blocks will not be
read, and ‘<samp><span class="samp">@ifnothtml</span></samp>’ blocks will be.
<br><dt><code>--no-number-footnotes</code><dd><a name="index-g_t_002d_002dno_002dnumber_002dfootnotes-1258"></a>Suppress automatic footnote numbering. By default, <code>makeinfo</code>
numbers each footnote sequentially in a single node, resetting the
current footnote number to 1 at the start of each node.
<br><dt><code>--no-number-sections</code><dd><a name="index-g_t_002d_002dno_002dnumber_002dsections-1259"></a>Do not output chapter, section, and appendix numbers.
You need to specify this if your manual is not hierarchically-structured.
<br><dt><code>--no-split</code><dd><a name="index-g_t_002d_002dno_002dsplit-1260"></a><a name="index-Splitting-of-output-files-1261"></a><a name="index-Output-file-splitting-1262"></a>Suppress the splitting stage of <code>makeinfo</code>. By default, large
output files (where the size is greater than 70k bytes) are split into
smaller subfiles. For Info output, each one is approximately 50k bytes.
For HTML output, each file contains one node (see <a href="Generating-HTML.html#Generating-HTML">Generating HTML</a>).
<br><dt><code>--no-pointer-validate</code><dt><code>--no-validate</code><dd><a name="index-g_t_002d_002dno_002dpointer_002dvalidate-1263"></a><a name="index-g_t_002d_002dno_002dvalidate-1264"></a><a name="index-Pointer-validation_002c-suppressing-1265"></a>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="Use-TeX.html#Use-TeX">Use TeX</a>). Normally, after a Texinfo file
is processed, some consistency checks are made to ensure that cross
references can be resolved, etc. See <a href="Pointer-Validation.html#Pointer-Validation">Pointer Validation</a>.
<br><dt><code>--no-warn</code><dd><a name="index-g_t_002d_002dno_002dwarn-1266"></a>Suppress warning messages (but <em>not</em> error messages).
<br><dt><code>--number-sections</code><dd><a name="index-g_t_002d_002dnumber_002dsections-1267"></a>Output chapter, section, and appendix numbers as in printed manuals.
This is the default. It works only with hierarchically-structured
manuals.
<br><dt><code>--output=</code><var>file</var><dt><code>-o </code><var>file</var><dd><a name="index-g_t_002d_002doutput_003d_0040var_007bfile_007d-1268"></a><a name="index-g_t_002do-_0040var_007bfile_007d-1269"></a>Specify that the output should be directed to <var>file</var> and not to the
file name specified in the <code>@setfilename</code> command found in the
Texinfo source (see <a href="setfilename.html#setfilename">setfilename</a>). If <var>file</var> is ‘<samp><span class="samp">-</span></samp>’, output
goes to standard output and ‘<samp><span class="samp">--no-split</span></samp>’ is implied. For split
HTML output, <var>file</var> is the name for the directory into which all
HTML nodes are written (see <a href="Generating-HTML.html#Generating-HTML">Generating HTML</a>).
<br><dt><code>-P </code><var>dir</var><dd><a name="index-g_t_002dP-_0040var_007bdir_007d-1270"></a>Prepend <var>dir</var> to the directory search list for <code>@include</code>.
If <var>dir</var> is not given, the current directory <samp><span class="file">.</span></samp> is prepended.
See ‘<samp><span class="samp">-I</span></samp>’ for more details.
<br><dt><code>--paragraph-indent=</code><var>indent</var><dt><code>-p </code><var>indent</var><dd><a name="index-g_t_002d_002dparagraph_002dindent_003d_0040var_007bindent_007d-1271"></a><a name="index-g_t_002dp-_0040var_007bindent_007d-1272"></a>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="paragraphindent.html#paragraphindent">paragraphindent</a>). The value
of <var>indent</var> is interpreted as follows:
<dl>
<dt>‘<samp><span class="samp">asis</span></samp>’<dd>Preserve any existing indentation at the starts of paragraphs.
<br><dt>‘<samp><span class="samp">0</span></samp>’ or ‘<samp><span class="samp">none</span></samp>’<dd>Delete any existing indentation.
<br><dt><var>num</var><dd>Indent each paragraph by <var>num</var> spaces.
</dl>
<br><dt><code>--split-size=</code><var>num</var><dd><a name="index-g_t_002d_002dsplit_002dsize_003d_0040var_007bnum_007d-1273"></a>Keep Info files to at most <var>num</var> characters; default is 300,000.
<br><dt><code>--transliterate-file-names</code><dd><a name="index-g_t_002d_002dtransliterate_002dfile_002dnames-1274"></a>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-Xref-8_002dbit-Character-Expansion">HTML Xref 8-bit Character Expansion</a>.
<br><dt><code>-U </code><var>var</var><dd>Cause <var>var</var> to be undefined. This is equivalent to
<code>@clear </code><var>var</var> in the Texinfo file (see <a href="set-clear-value.html#set-clear-value">set clear value</a>).
<br><dt><code>--verbose</code><dd><a name="index-g_t_002d_002dverbose-1275"></a>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.
<br><dt><code>--version</code><dt><code>-V</code><dd><a name="index-g_t_002d_002dversion-1276"></a><a name="index-g_t_002dV-1277"></a>Print the version number, then exit successfully.
<br><dt><code>--xml</code><dd><a name="index-g_t_002d_002dxml-1278"></a>Generate XML output rather than Info.
</dl>
<p><a name="index-TEXINFO_005fOUTPUT_005fFORMAT-1279"></a><a name="index-Environment-variable-_0040code_007bTEXINFO_005fOUTPUT_005fFORMAT_007d-1280"></a><samp><span class="command">makeinfo</span></samp> also reads the environment variable
<samp><span class="env">TEXINFO_OUTPUT_FORMAT</span></samp> to determine the output format, if not
overridden by a command line option. The possible values are:
<pre class="example"> docbook html info plaintext xml
</pre>
<p>If not set, Info output is the default.
</body></html>
|