blob: 0c0ca4b17bb381617e41aa043cb70049f1dd58df [file]
<!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>Using Include Files (GNU Texinfo 6.8dev)</title>
<meta name="description" content="Using Include Files (GNU Texinfo 6.8dev)">
<meta name="keywords" content="Using Include Files (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="Include-Files.html" rel="up" title="Include Files">
<link href="texinfo_002dmultiple_002dfiles_002dupdate.html" rel="next" title="texinfo-multiple-files-update">
<style type="text/css">
<!--
div.example {margin-left: 3.2em}
-->
</style>
</head>
<body lang="en">
<div class="section-level-extent" id="Using-Include-Files">
<div class="nav-panel">
<p>
Next: <a href="texinfo_002dmultiple_002dfiles_002dupdate.html" accesskey="n" rel="next"><code class="code">texinfo-multiple-files-update</code></a>, Up: <a href="Include-Files.html" accesskey="u" rel="up">Include Files</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="How-to-Use-Include-Files">17.1 How to Use Include Files</h3>
<a class="index-entry-id" id="index-include"></a>
<p>To include another file within a Texinfo file, write the
<code class="code">@include</code> command at the beginning of a line and follow it on
the same line by the name of a file to be included. For example:
</p>
<div class="example">
<pre class="example-preformatted">@include buffers.texi
</pre></div>
<p>@-commands are expanded in file names. The one most likely to be
useful is <code class="code">@value</code> (see <a class="pxref" href="_0040set-_0040value.html"><code class="code">@set</code> and <code class="code">@value</code></a>), and even then
only in complicated situations.
</p>
<p>An included file should simply be a segment of text that you expect to
be included as is into the overall or <em class="dfn">outer</em> Texinfo file; it
should not contain the standard beginning and end parts of a Texinfo
file. In particular, you should not start an included file with a
line saying &lsquo;<samp class="samp">\input texinfo</samp>&rsquo;; if you do, that text is inserted
into the output file literally. Likewise, you should not end an
included file with a <code class="code">@bye</code> command; nothing after <code class="code">@bye</code>
is formatted.
</p>
<p>In the long-ago past, you were required to write an
<code class="code">@setfilename</code> line at the beginning of an included file, but no
longer. Now, it does not matter whether you write such a line. If an
<code class="code">@setfilename</code> line exists in an included file, it is ignored.
</p>
</div>
</body>
</html>