JezK
Edit File: _0040example.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>@example (GNU Texinfo 6.8)</title> <meta name="description" content="@example (GNU Texinfo 6.8)"> <meta name="keywords" content="@example (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="_0040verbatim.html" rel="next" title="@verbatim"> <link href="_0040indentedblock.html" rel="prev" title="@indentedblock"> <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_0040example"> <div class="header"> <p> Next: <a href="_0040verbatim.html" accesskey="n" rel="next"><code>@verbatim</code>: Literal Text</a>, Previous: <a href="_0040indentedblock.html" accesskey="p" rel="prev"><code>@indentedblock</code>: Indented text blocks</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_0040example_003a-Example-Text"></span><h3 class="section">7.4 <code>@example</code>: Example Text</h3> <span id="example"></span><span id="index-example"></span> <span id="index-Examples_002c-formatting-them"></span> <span id="index-Formatting-examples"></span> <p>The <code>@example</code> environment is used to indicate computer input or output that is not part of the running text. If you want to embed code fragments within sentences, use the <code>@code</code> command or its relatives instead (see <a href="_0040code.html"><code>@code</code>{<var>sample-code</var>}</a>). </p> <p>Write an <code>@example</code> command at the beginning of a line by itself. Mark the end of the block with <code>@end example</code>. For example, </p> <div class="example"> <pre class="example">@example cp foo @var{dest1}; \ cp foo @var{dest2} @end example </pre></div> <p>produces </p> <div class="example"> <pre class="example">cp foo <var>dest1</var>; \ cp foo <var>dest2</var> </pre></div> <p>The output uses a fixed-width font and is indented. Each line in the input file is a line in the output; that is, the source text is not filled. Extra spaces and blank lines are significant. Texinfo commands <em>are</em> expanded; if you want the output to be the input verbatim, use the <code>@verbatim</code> environment instead (see <a href="_0040verbatim.html"><code>@verbatim</code>: Literal Text</a>). </p> <p>Examples are often, logically speaking, “in the middle” of a paragraph, and the text that continues afterwards should not be indented, as in the example above. The <code>@noindent</code> command prevents a piece of text from being indented as if it were a new paragraph (see <a href="_0040noindent.html"><code>@noindent</code>: Omitting Indentation</a>). </p> <p>If you wish to use the normal roman font for a code comment, you can use the <code>@r</code> command (see <a href="Fonts.html">Fonts for Printing</a>). </p> <p>You may optionally give arguments to the <code>@example</code> command, separated by commas if there is more than one. In the HTML output, any such arguments are output as class names. This may be useful for adding syntax highlighting to manuals for code samples. We recommend that when you give multiple arguments to <code>@example</code>, you use the first argument to specify the language of the code (e.g. ‘<samp>C</samp>’, ‘<samp>lisp</samp>’, ‘<samp>Cplusplus</samp>’). You may find uses for other arguments, such as providing a formatting hint or marking code samples for extraction and further processing, but for now nothing definitive is recommended. Perhaps this will change in future Texinfo releases. </p> <blockquote> <p><b>Caution:</b> Do not use tabs in the lines of an example! (Or anywhere else in Texinfo, except in verbatim environments.) TeX treats tabs as single spaces, and that is not what they look like. </p></blockquote> </div> <hr> <div class="header"> <p> Next: <a href="_0040verbatim.html"><code>@verbatim</code>: Literal Text</a>, Previous: <a href="_0040indentedblock.html"><code>@indentedblock</code>: Indented text blocks</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>