/usr/share/doc/texinfo/html/Using-Include-Files.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.5, 25 August 2017),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016 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 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 have the freedom to copy and
modify this GNU manual.  Buying copies from the FSF supports it in
developing GNU and promoting software freedom." -->
<!-- Created by GNU Texinfo 6.4.90, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Using Include Files (GNU Texinfo 6.5)</title>

<meta name="description" content="Using Include Files (GNU Texinfo 6.5)">
<meta name="keywords" content="Using Include Files (GNU Texinfo 6.5)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Command-and-Variable-Index.html#Command-and-Variable-Index" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Include-Files.html#Include-Files" rel="up" title="Include Files">
<link href="texinfo_002dmultiple_002dfiles_002dupdate.html#texinfo_002dmultiple_002dfiles_002dupdate" rel="next" title="texinfo-multiple-files-update">
<link href="Include-Files.html#Include-Files" rel="prev" title="Include Files">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="Using-Include-Files"></a>
<div class="header">
<p>
Next: <a href="texinfo_002dmultiple_002dfiles_002dupdate.html#texinfo_002dmultiple_002dfiles_002dupdate" accesskey="n" rel="next"><code>texinfo-multiple-files-update</code></a>, Up: <a href="Include-Files.html#Include-Files" 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#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="How-to-Use-Include-Files"></a>
<h3 class="section">18.1 How to Use Include Files</h3>

<a name="index-include"></a>

<p>To include another file within a Texinfo file, write the
<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">@include buffers.texi
</pre></div>

<p>@-commands are expanded in file names.  The one most likely to be
useful is <code>@value</code> (see <a href="_0040set-_0040value.html#g_t_0040set-_0040value"><code>@set @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>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>\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>@bye</code> command; nothing after <code>@bye</code>
is formatted.
</p>
<p>In the long-ago past, you were required to write an
<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>@setfilename</code> line exists in an included file, it is ignored.
</p>




</body>
</html>
texinfo-doc-nonfree 6.5.0-1 / usr / share / doc / texinfo / html / Using-Include-Files.html
