| <!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>@verbatiminclude (GNU Texinfo 6.8dev)</title> |
| |
| <meta name="description" content="@verbatiminclude (GNU Texinfo 6.8dev)"> |
| <meta name="keywords" content="@verbatiminclude (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="Sample-Include-File.html" rel="prev" title="Sample Include File"> |
| <style type="text/css"> |
| <!-- |
| div.example {margin-left: 3.2em} |
| --> |
| </style> |
| |
| |
| </head> |
| |
| <body lang="en"> |
| <div class="section-level-extent" id="g_t_0040verbatiminclude"> |
| <div class="nav-panel"> |
| <p> |
| Previous: <a href="Sample-Include-File.html" accesskey="p" rel="prev">Sample File with <code class="code">@include</code></a>, Up: <a href="Include-Files.html" accesskey="u" rel="up">Include Files</a> [<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="g_t_0040verbatiminclude-file_003a-Include-a-File-Verbatim">17.5 <code class="code">@verbatiminclude</code> <var class="var">file</var>: Include a File Verbatim</h3> |
| |
| <a class="anchor" id="verbatiminclude"></a><a class="index-entry-id" id="index-verbatiminclude"></a> |
| <a class="index-entry-id" id="index-Verbatim_002c-include-file"></a> |
| <a class="index-entry-id" id="index-Including-a-file-verbatim"></a> |
| |
| <p>You can include the exact contents of a file in the document with the |
| <code class="code">@verbatiminclude</code> command: |
| </p> |
| <div class="example"> |
| <pre class="example-preformatted">@verbatiminclude <var class="var">filename</var> |
| </pre></div> |
| |
| <p>The contents of <var class="var">filename</var> is printed in a verbatim environment |
| (see <a class="pxref" href="_0040verbatim.html"><code class="code">@verbatim</code>: Literal Text</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 class="code">@verbatiminclude</code> within <code class="code">@example</code> |
| (see <a class="pxref" href="_0040example.html"><code class="code">@example</code>: Example Text</a>). |
| </p> |
| <p>The name of the file is taken literally, with a single exception: |
| <code class="code">@value{<var class="var">var</var>}</code> references are expanded. This makes it |
| possible to include files in other directories within a distribution, |
| for instance: |
| </p> |
| <div class="example"> |
| <pre class="example-preformatted">@verbatiminclude @value{top_srcdir}/NEWS |
| </pre></div> |
| |
| <p>(You still have to get <code class="code">top_srcdir</code> defined in the |
| first place.) |
| </p> |
| <p>For a method on printing the file contents in a smaller font size, see |
| the end of the section on <code class="code">@verbatim</code>. |
| </p> |
| |
| |
| |
| </div> |
| |
| |
| |
| </body> |
| </html> |
