blob: 9bae344b7b1c567052ca6be31f3e71d08a365e1b [file] [log] [blame]
<!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>HTML Splitting (GNU Texinfo 6.8dev)</title>
<meta name="description" content="HTML Splitting (GNU Texinfo 6.8dev)">
<meta name="keywords" content="HTML Splitting (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="Generating-HTML.html" rel="up" title="Generating HTML">
<link href="HTML-CSS.html" rel="next" title="HTML CSS">
<link href="HTML-Translation.html" rel="prev" title="HTML Translation">
</head>
<body lang="en">
<div class="section-level-extent" id="HTML-Splitting">
<div class="nav-panel">
<p>
Next: <a href="HTML-CSS.html" accesskey="n" rel="next">HTML CSS</a>, Previous: <a href="HTML-Translation.html" accesskey="p" rel="prev">HTML Translation</a>, Up: <a href="Generating-HTML.html" accesskey="u" rel="up">Generating HTML</a> &nbsp; [<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="HTML-Splitting-1">21.2 HTML Splitting</h3>
<a class="index-entry-id" id="index-Split-HTML-output"></a>
<a class="index-entry-id" id="index-HTML-output_002c-split"></a>
<p>When splitting output at nodes (which is the default),
<code class="command">makeinfo</code> writes HTML output into (basically) one output file
per Texinfo source <code class="code">@node</code>.
</p>
<p>Each output file name is the node name with spaces replaced by
&lsquo;<samp class="samp">-</samp>&rsquo;&rsquo;s and special characters changed to &lsquo;<samp class="samp">_</samp>&rsquo; followed by
their code point in hex (see <a class="pxref" href="HTML-Xref.html">HTML Cross-references</a>). This is to make it
portable and easy to use as a file name. In the unusual case of two
different nodes having the same name after this treatment, they are
written consecutively to the same file, with HTML anchors so each can
be referred to independently.
</p>
<p>If <code class="command">makeinfo</code> is run on a system which does not distinguish
case in file names, nodes which are the same except for case (e.g.,
&lsquo;<samp class="samp">index</samp>&rsquo; and &lsquo;<samp class="samp">Index</samp>&rsquo;) will also be folded into the same
output file with anchors. You can also pretend to be on a case
insensitive filesystem by setting the customization variable
<code class="code">CASE_INSENSITIVE_FILENAMES</code>.
</p>
<p>It is also possible to split at chapters or sections with
<samp class="option">--split</samp> (see <a class="pxref" href="Invoking-texi2any.html">Invoking <code class="command">texi2any</code>/<code class="command">makeinfo</code> from a Shell</a>). In that case,
the file names are constructed after the name of the node associated
with the relevant sectioning command. Also, unless
<samp class="option">--no-node-files</samp> is specified, a redirection file is output
for every node in order to more reliably support cross-references to
that manual (see <a class="pxref" href="HTML-Xref.html">HTML Cross-references</a>).
</p>
<p>When splitting, the HTML output files are written into a subdirectory. The
subdirectory name is derived from the base name from <code class="code">@setfilename</code> (that
is, any extension is removed), with <code class="code">_html</code> postpended. For example, HTML
output for <code class="code">@setfilename gcc.info</code> would be written into a subdirectory
named &lsquo;<samp class="samp">gcc_html/</samp>&rsquo;. The subdirectory name is based in the input file name
if there is no <code class="code">@setfilename</code>.
</p>
<p>In any case, the top-level output file within the directory
is always named &lsquo;<samp class="samp">index.html</samp>&rsquo;.
</p>
<p>Monolithic output (<code class="code">--no-split</code>) is named according to
<code class="code">@setfilename</code> (with any &lsquo;<samp class="samp">.info</samp>&rsquo; extension is replaced with
&lsquo;<samp class="samp">.html</samp>&rsquo;), <code class="code">--output</code> (the argument is used literally), or
based on the input file name as a last resort
(see <a class="pxref" href="_0040setfilename.html"><code class="code">@setfilename</code>: Set the Output File Name</a>).
</p>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="HTML-CSS.html">HTML CSS</a>, Previous: <a href="HTML-Translation.html">HTML Translation</a>, Up: <a href="Generating-HTML.html">Generating HTML</a> &nbsp; [<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>