/usr/share/doc/texinfo/html/verbatiminclude.html

<html lang="en">
<head>
<title>verbatiminclude - 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="Quotations-and-Examples.html#Quotations-and-Examples" title="Quotations and Examples">
<link rel="prev" href="verbatim.html#verbatim" title="verbatim">
<link rel="next" href="lisp.html#lisp" title="lisp">
<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="verbatiminclude"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="lisp.html#lisp">lisp</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="verbatim.html#verbatim">verbatim</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Quotations-and-Examples.html#Quotations-and-Examples">Quotations and Examples</a>
<hr>
</div>

<h3 class="section">10.5 <code>@verbatiminclude</code> <var>file</var>: Include a File Verbatim</h3>

<p><a name="index-Verbatim_002c-include-file-489"></a><a name="index-Including-a-file-verbatim-490"></a><a name="index-verbatiminclude-491"></a>
You can include the exact contents of a file in the document with the
<code>@verbatiminclude</code> command:

<pre class="example">     @verbatiminclude <var>filename</var>
</pre>
  <p>The contents of <var>filename</var> is printed in a verbatim environment
(see <a href="verbatim.html#verbatim"><code>@verbatim</code></a>).  Generally, the file is printed
exactly as it is, with all special characters and white space
retained.  No indentation is added; if you want indentation, enclose
the <code>@verbatiminclude</code> within <code>@example</code>
(see <a href="example.html#example"><code>@example</code></a>).

  <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 include files in other directories within a distribution,
for instance:

<pre class="example">     @verbatiminclude @value{top_srcdir}/NEWS
</pre>
  <p class="noindent">(You still have to get <code>top_srcdir</code> defined in the
first place.)

  <p>For a method on printing the file contents in a smaller font size, see
the end of the previous section on <code>@verbatim</code>.

  </body></html>
texinfo-doc-nonfree 4.13a-1 / usr / share / doc / texinfo / html / verbatiminclude.html
