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

<html lang="en">
<head>
<title>Using Include Files - 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="Include-Files.html#Include-Files" title="Include Files">
<link rel="next" href="texinfo_002dmultiple_002dfiles_002dupdate.html#texinfo_002dmultiple_002dfiles_002dupdate" title="texinfo-multiple-files-update">
<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="Using-Include-Files"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="texinfo_002dmultiple_002dfiles_002dupdate.html#texinfo_002dmultiple_002dfiles_002dupdate">texinfo-multiple-files-update</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Include-Files.html#Include-Files">Include Files</a>
<hr>
</div>

<h3 class="section">D.1 How to Use Include Files</h3>

<p><a name="index-include-1418"></a>
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:

<pre class="example">     @include buffers.texi
</pre>
  <p>The name of the file is taken literally, with a single exception:
<code>@value{</code><var>var</var><code>}</code> references are expanded.  This makes it
possible to reliably include files in other directories in a
distribution.  See <a href="verbatiminclude.html#verbatiminclude"><code>@verbatiminclude</code></a>, for
an example.

  <p>An included file should simply be a segment of text that you expect to
be included as is into the overall or <dfn>outer</dfn> 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><span class="samp">\input texinfo</span></samp>&rsquo;; if you do, that phrase is inserted
into the output file as is.  Likewise, you should not end an included
file with an <code>@bye</code> command; nothing after <code>@bye</code> is
formatted.

  <p>In the 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>Conventionally, an included file begins with an <code>@node</code> line that
is followed by an <code>@chapter</code> line.  Each included file is one
chapter.  This makes it easy to use the regular node and menu creating
and updating commands to create the node pointers and menus within the
included file.  However, the simple Emacs node and menu creating and
updating commands do not work with multiple Texinfo files.  Thus you
cannot use these commands to fill in the `Next', `Previous', and `Up'
pointers of the <code>@node</code> line that begins the included file.  Also,
you cannot use the regular commands to create a master menu for the
whole file.  Either you must insert the menus and the `Next',
`Previous', and `Up' pointers by hand, or you must use the GNU Emacs
Texinfo mode command, <code>texinfo-multiple-files-update</code>, that is
designed for <code>@include</code> files.

  <p>When an included file does not have any node lines in it, the
multiple files update command does not try to create a menu entry
for it.  Consequently, you can include any file, such as a
version or an update file without node lines, not just files that
are chapters.  Small includable files like this are created by
Automake (see <a href="GNU-Sample-Texts.html#GNU-Sample-Texts">GNU Sample Texts</a>).

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