JezK
Edit File: _0040verbatim.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>@verbatim (GNU Texinfo 6.8)</title> <meta name="description" content="@verbatim (GNU Texinfo 6.8)"> <meta name="keywords" content="@verbatim (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="Quotations-and-Examples.html" rel="up" title="Quotations and Examples"> <link href="_0040lisp.html" rel="next" title="@lisp"> <link href="_0040example.html" rel="prev" title="@example"> <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_0040verbatim"> <div class="header"> <p> Next: <a href="_0040lisp.html" accesskey="n" rel="next"><code>@lisp</code>: Marking a Lisp Example</a>, Previous: <a href="_0040example.html" accesskey="p" rel="prev"><code>@example</code>: Example Text</a>, Up: <a href="Quotations-and-Examples.html" accesskey="u" rel="up">Quotations and Examples</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_0040verbatim_003a-Literal-Text"></span><h3 class="section">7.5 <code>@verbatim</code>: Literal Text</h3> <span id="verbatim"></span><span id="index-verbatim"></span> <span id="index-Verbatim-environment"></span> <p>Use the <code>@verbatim</code> environment for printing of text that may contain special characters or commands that should not be interpreted, such as computer input or output (<code>@example</code> interprets its text as regular Texinfo commands). This is especially useful for including automatically generated files in a Texinfo manual. </p> <p>In general, the output will be just the same as the input. No character substitutions are made, e.g., all spaces and blank lines are significant, including tabs. In the printed manual, the text is typeset in a fixed-width font, and not indented or filled. </p> <p>Write a <code>@verbatim</code> command at the beginning of a line by itself. This line will disappear from the output. Mark the end of the verbatim block with an <code>@end verbatim</code> command, also written at the beginning of a line by itself. The <code>@end verbatim</code> will also disappear from the output. </p> <p>For example: </p> <div class="example"> <pre class="example"><tt>@verbatim</tt> </pre><pre class="example"><tt>{</tt> </pre><pre class="example"><span class="key">TAB</span><tt>@command with strange characters: @'e</tt> </pre><pre class="example"><tt>expand<span class="key">TAB</span>me</tt> </pre><pre class="example"><tt>}</tt> </pre><pre class="example"><tt>@end verbatim</tt> </pre></div> <p>This produces: </p> <pre class="verbatim">{ @command with strange characters: @'e expand me } </pre> <p>Since the lines containing <code>@verbatim</code> and <code>@end verbatim</code> produce no output, typically you should put a blank line before the <code>@verbatim</code> and another blank line after the <code>@end verbatim</code>. Blank lines between the beginning <code>@verbatim</code> and the ending <code>@end verbatim</code> will appear in the output. </p> <span id="index-Verbatim_002c-small"></span> <span id="index-Small-verbatim"></span> <p>You can get a “small” verbatim by enclosing the <code>@verbatim</code> in an <code>@smallformat</code> environment, as shown here: </p> <div class="example"> <pre class="example"><tt>@smallformat</tt> </pre><pre class="example"><tt>@verbatim</tt> </pre><pre class="example"><tt>... still verbatim, but in a smaller font ...</tt> </pre><pre class="example"><tt>@end verbatim</tt> </pre><pre class="example"><tt>@end smallformat</tt> </pre></div> <p>Finally, a word of warning: it is not reliable to use <code>@verbatim</code> inside other Texinfo constructs. </p> <p>See also <a href="_0040verbatiminclude.html"><code>@verbatiminclude</code> <var>file</var>: Include a File Verbatim</a>. </p> </div> <hr> <div class="header"> <p> Next: <a href="_0040lisp.html"><code>@lisp</code>: Marking a Lisp Example</a>, Previous: <a href="_0040example.html"><code>@example</code>: Example Text</a>, Up: <a href="Quotations-and-Examples.html">Quotations and Examples</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> </body> </html>