infog/test-infodir/texinfo_html/_0040example.html - texinfo - Git at Google

 <!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>@example (GNU Texinfo 6.8dev)</title>

 <meta name="description" content="@example (GNU Texinfo 6.8dev)">
 <meta name="keywords" content="@example (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="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">
 <!--
 div.example {margin-left: 3.2em}
 -->
 </style>


 </head>

 <body lang="en">
 <div class="section-level-extent" id="g_t_0040example">
 <div class="nav-panel">
 <p>
 Next: <a href="_0040verbatim.html" accesskey="n" rel="next"><code class="code">@verbatim</code>: Literal Text</a>, Previous: <a href="_0040indentedblock.html" accesskey="p" rel="prev"><code class="code">@indentedblock</code>: Indented text blocks</a>, Up: <a href="Quotations-and-Examples.html" accesskey="u" rel="up">Quotations and Examples</a> &nbsp; [<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_0040example_003a-Example-Text">7.4 <code class="code">@example</code>: Example Text</h3>

 <a class="anchor" id="example"></a><a class="index-entry-id" id="index-example"></a>
 <a class="index-entry-id" id="index-Examples_002c-formatting-them"></a>
 <a class="index-entry-id" id="index-Formatting-examples"></a>

 <p>The <code class="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 class="code">@code</code>
 command or its relatives instead (see <a class="pxref" href="_0040code.html"><code class="code">@code</code>{<var class="var">sample-code</var>}</a>).
 </p>
 <p>Write an <code class="code">@example</code> command at the beginning of a line by
 itself.  Mark the end of the block with <code class="code">@end example</code>.
 For example,
 </p>
 <div class="example">
 <pre class="example-preformatted">@example
 cp foo @var{dest1}; \
  cp foo @var{dest2}
 @end example
 </pre></div>

 <p>produces
 </p>
 <div class="example">
 <pre class="example-preformatted">cp foo <var class="var">dest1</var>; \
  cp foo <var class="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 class="emph">are</em> expanded; if you want the output to be
 the input verbatim, use the <code class="code">@verbatim</code> environment instead
 (see <a class="pxref" href="_0040verbatim.html"><code class="code">@verbatim</code>: Literal Text</a>).
 </p>
 <p>Examples are often, logically speaking, &ldquo;in the middle&rdquo; of a
 paragraph, and the text that continues afterwards should not be
 indented, as in the example above.  The <code class="code">@noindent</code> command
 prevents a piece of text from being indented as if it were a new
 paragraph (see <a class="pxref" href="_0040noindent.html"><code class="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 class="code">@r</code> command (see <a class="pxref" href="Fonts.html">Fonts for Printing</a>).
 </p>
 <p>You may optionally give arguments to the <code class="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 class="code">@example</code>, you
 use the first argument to specify the language of the code (e.g.
 &lsquo;<samp class="samp">C</samp>&rsquo;, &lsquo;<samp class="samp">lisp</samp>&rsquo;, &lsquo;<samp class="samp">Cplusplus</samp>&rsquo;).  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 class="quotation">
 <p><b class="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="nav-panel">
 <p>
 Next: <a href="_0040verbatim.html"><code class="code">@verbatim</code>: Literal Text</a>, Previous: <a href="_0040indentedblock.html"><code class="code">@indentedblock</code>: Indented text blocks</a>, Up: <a href="Quotations-and-Examples.html">Quotations and Examples</a> &nbsp; [<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>
	<!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>@example (GNU Texinfo 6.8dev)</title>

	<meta name="description" content="@example (GNU Texinfo 6.8dev)">
	<meta name="keywords" content="@example (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="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">
	<!--
	div.example {margin-left: 3.2em}
	-->
	</style>


	</head>

	<body lang="en">
	<div class="section-level-extent" id="g_t_0040example">
	<div class="nav-panel">
	<p>
	Next: <a href="_0040verbatim.html" accesskey="n" rel="next"><code class="code">@verbatim</code>: Literal Text</a>, Previous: <a href="_0040indentedblock.html" accesskey="p" rel="prev"><code class="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>
	<h3 class="section" id="g_t_0040example_003a-Example-Text">7.4 <code class="code">@example</code>: Example Text</h3>

	<a class="anchor" id="example"></a><a class="index-entry-id" id="index-example"></a>
	<a class="index-entry-id" id="index-Examples_002c-formatting-them"></a>
	<a class="index-entry-id" id="index-Formatting-examples"></a>

	<p>The <code class="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 class="code">@code</code>
	command or its relatives instead (see <a class="pxref" href="_0040code.html"><code class="code">@code</code>{<var class="var">sample-code</var>}</a>).
	</p>
	<p>Write an <code class="code">@example</code> command at the beginning of a line by
	itself. Mark the end of the block with <code class="code">@end example</code>.
	For example,
	</p>
	<div class="example">
	<pre class="example-preformatted">@example
	cp foo @var{dest1}; \
	cp foo @var{dest2}
	@end example
	</pre></div>

	<p>produces
	</p>
	<div class="example">
	<pre class="example-preformatted">cp foo <var class="var">dest1</var>; \
	cp foo <var class="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 class="emph">are</em> expanded; if you want the output to be
	the input verbatim, use the <code class="code">@verbatim</code> environment instead
	(see <a class="pxref" href="_0040verbatim.html"><code class="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 class="code">@noindent</code> command
	prevents a piece of text from being indented as if it were a new
	paragraph (see <a class="pxref" href="_0040noindent.html"><code class="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 class="code">@r</code> command (see <a class="pxref" href="Fonts.html">Fonts for Printing</a>).
	</p>
	<p>You may optionally give arguments to the <code class="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 class="code">@example</code>, you
	use the first argument to specify the language of the code (e.g.
	‘<samp class="samp">C</samp>’, ‘<samp class="samp">lisp</samp>’, ‘<samp class="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 class="quotation">
	<p><b class="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="nav-panel">
	<p>
	Next: <a href="_0040verbatim.html"><code class="code">@verbatim</code>: Literal Text</a>, Previous: <a href="_0040indentedblock.html"><code class="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>