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

This file is indexed.

/usr/share/doc/texinfo/html/samp.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
<html lang="en">
<head>
<title>samp - 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="Indicating.html#Indicating" title="Indicating">
<link rel="prev" href="key.html#key" title="key">
<link rel="next" href="verb.html#verb" title="verb">
<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="samp"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="verb.html#verb">verb</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="key.html#key">key</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Indicating.html#Indicating">Indicating</a>
<hr>
</div>

<h4 class="subsection">9.1.5 <code>@samp</code>{<var>text</var>}</h4>

<p><a name="index-samp-421"></a>
Use the <code>@samp</code> command to indicate text that is a literal example
or `sample' of a sequence of characters in a file, string, pattern, etc. 
Enclose the text in braces.  The argument appears within single
quotation marks in both the Info file and the printed manual; in
addition, it is printed in a fixed-width font.

<pre class="example">     To match @samp{foo} at the end of the line,
     use the regexp @samp{foo$}.
</pre>
  <p class="noindent">produces

  <blockquote>
To match &lsquo;<samp><span class="samp">foo</span></samp>&rsquo; at the end of the line, use the regexp
&lsquo;<samp><span class="samp">foo$</span></samp>&rsquo;. 
</blockquote>

  <p>Any time you are referring to single characters, you should use
<code>@samp</code> unless <code>@kbd</code> or <code>@key</code> is more appropriate. 
Also, you may use <code>@samp</code> for entire statements in C and for entire
shell commands&mdash;in this case, <code>@samp</code> often looks better than
<code>@code</code>.  Basically, <code>@samp</code> is a catchall for whatever is
not covered by <code>@code</code>, <code>@kbd</code>, or <code>@key</code>.

  <p>Only include punctuation marks within braces if they are part of the
string you are specifying.  Write punctuation marks outside the braces
if those punctuation marks are part of the English text that surrounds
the string.  In the following sentence, for example, the commas and
period are outside of the braces:

<pre class="example">     In English, the vowels are @samp{a}, @samp{e},
     @samp{i}, @samp{o}, @samp{u}, and sometimes
     @samp{y}.
</pre>
  <p class="noindent">This produces:

  <blockquote>
In English, the vowels are &lsquo;<samp><span class="samp">a</span></samp>&rsquo;, &lsquo;<samp><span class="samp">e</span></samp>&rsquo;,
&lsquo;<samp><span class="samp">i</span></samp>&rsquo;, &lsquo;<samp><span class="samp">o</span></samp>&rsquo;, &lsquo;<samp><span class="samp">u</span></samp>&rsquo;,  and sometimes
&lsquo;<samp><span class="samp">y</span></samp>&rsquo;. 
</blockquote>

  </body></html>

APT Browse - Built by Thomas Orozco.