texinfo-doc-nonfree 4.13a-1 / usr / share / doc / texinfo / html / example.html

This file is indexed.

/usr/share/doc/texinfo/html/example.html is in texinfo-doc-nonfree 4.13a-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<html lang="en">
<head>
<title>example - GNU Texinfo 4.13</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Texinfo 4.13">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Quotations-and-Examples.html#Quotations-and-Examples" title="Quotations and Examples">
<link rel="prev" href="quotation.html#quotation" title="quotation">
<link rel="next" href="verbatim.html#verbatim" title="verbatim">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual is for GNU Texinfo (version 4.13, 18 September 2008),
a documentation system that can produce both online information and a
printed manual from a single source.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
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.2 or any later version published by the Free Software
     Foundation; with no Invariant Sections, with the Front-Cover Texts
     being ``A GNU Manual'', and with the Back-Cover Texts as in (a)
     below.  A copy of the license is included in the section entitled
     ``GNU Free Documentation License.''

     (a) The FSF's Back-Cover Text is: ``You are free to copy and modify
     this GNU Manual.  Buying copies from GNU Press supports the FSF in
     developing GNU and promoting software freedom.''
  -->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<a name="example"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="verbatim.html#verbatim">verbatim</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="quotation.html#quotation">quotation</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Quotations-and-Examples.html#Quotations-and-Examples">Quotations and Examples</a>
<hr>
</div>

<h3 class="section">10.3 <code>@example</code>: Example Text</h3>

<p><a name="index-Examples_002c-formatting-them-482"></a><a name="index-Formatting-examples-483"></a><a name="index-example-484"></a>
The <code>@example</code> environment is used to indicate an example that
is not part of the running text, such as computer input or output. 
Write an <code>@example</code> command at the beginning of a line by
itself.  Mark the end of the example with an <code>@end example</code>
command, also written at the beginning of a line by itself.

  <p>An <code>@example</code> environment has the following characteristics:

     <ul>
<li>Each line in the input file is a line in the output; that is,
the source text is not filled as it normally is. 
<li>Extra spaces and blank lines are significant. 
<li>The output is indented. 
<li>The output uses a fixed-width font. 
<li>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="verbatim.html#verbatim"><code>@verbatim</code></a>). 
</ul>

  <p>For example,

<pre class="example">     @example
     cp foo @var{dest1}; \
      cp foo @var{dest2}
     @end example
</pre>
  <p class="noindent">produces

<pre class="example">     cp foo <var>dest1</var>; \
      cp foo <var>dest2</var>
</pre>
  <p>The lines containing <code>@example</code> and <code>@end example</code> will
disappear from the output.  To make the output look good, you should
put a blank line before the <code>@example</code> and another blank line
after the <code>@end example</code>.  Blank lines inside the beginning
<code>@example</code> and the ending <code>@end example</code>, on the other
hand, do appear in the output.

  <blockquote>
<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.  In Emacs, you can
use <kbd>M-x untabify</kbd> to convert tabs in a region to multiple spaces. 
</blockquote>

  <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>@noindent</code> command
prevents a piece of text from being indented as if it were a new
paragraph (see <a href="noindent.html#noindent"><code>@noindent</code></a>.

  <p>If you want to embed code fragments within sentences, instead of
displaying them, use the <code>@code</code> command or its relatives
(see <a href="code.html#code"><code>@code</code></a>).

  <p>If you wish to write a &ldquo;comment&rdquo; on a line of an example in the
normal roman font, you can use the <code>@r</code> command (see <a href="Fonts.html#Fonts">Fonts</a>).

  </body></html>

APT Browse - Built by Thomas Orozco.