JezK
Edit File: _0040verbatiminclude.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://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.8, 8 June 2021), 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-2021 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.8)</title> <meta name="description" content="@verbatiminclude (GNU Texinfo 6.8)"> <meta name="keywords" content="@verbatiminclude (GNU Texinfo 6.8)"> <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"> <!-- a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {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} span.nolinebreak {white-space: nowrap} span.roman {font-family: initial; font-weight: normal} span.sansserif {font-family: sans-serif; font-weight: normal} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="section" id="g_t_0040verbatiminclude"> <div class="header"> <p> Previous: <a href="Sample-Include-File.html" accesskey="p" rel="prev">Sample File with <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> <span id="g_t_0040verbatiminclude-file_003a-Include-a-File-Verbatim"></span><h3 class="section">17.5 <code>@verbatiminclude</code> <var>file</var>: Include a File Verbatim</h3> <span id="verbatiminclude"></span><span id="index-verbatiminclude"></span> <span id="index-Verbatim_002c-include-file"></span> <span id="index-Including-a-file-verbatim"></span> <p>You can include the exact contents of a file in the document with the <code>@verbatiminclude</code> command: </p> <div class="example"> <pre class="example">@verbatiminclude <var>filename</var> </pre></div> <p>The contents of <var>filename</var> is printed in a verbatim environment (see <a href="_0040verbatim.html"><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>@verbatiminclude</code> within <code>@example</code> (see <a href="_0040example.html"><code>@example</code>: Example Text</a>). </p> <p>The name of the file is taken literally, with a single exception: <code>@value{<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">@verbatiminclude @value{top_srcdir}/NEWS </pre></div> <p>(You still have to get <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>@verbatim</code>. </p> </div> </body> </html>