JezK
Edit File: _0040samp.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>@samp (GNU Texinfo 6.8)</title> <meta name="description" content="@samp (GNU Texinfo 6.8)"> <meta name="keywords" content="@samp (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="Indicating.html" rel="up" title="Indicating"> <link href="_0040verb.html" rel="next" title="@verb"> <link href="_0040key.html" rel="prev" title="@key"> <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="subsection" id="g_t_0040samp"> <div class="header"> <p> Next: <a href="_0040verb.html" accesskey="n" rel="next"><code>@verb</code>{<var>char</var><var>text</var><var>char</var>}</a>, Previous: <a href="_0040key.html" accesskey="p" rel="prev"><code>@key</code>{<var>key-name</var>}</a>, Up: <a href="Indicating.html" accesskey="u" rel="up">Indicating Definitions, Commands, etc.</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_0040samp_007btext_007d"></span><h4 class="subsection">6.1.5 <code>@samp</code>{<var>text</var>}</h4> <span id="samp"></span><span id="index-samp"></span> <p>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. </p> <div class="example"> <pre class="example">To match @samp{foo} at the end of the line, use the regexp @samp{foo$}. </pre></div> <p>produces </p> <blockquote> <p>To match ‘<samp>foo</samp>’ at the end of the line, use the regexp ‘<samp>foo$</samp>’. </p></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—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>, <code>@key</code>, <code>@command</code>, etc. </p> <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: </p> <div class="example"> <pre class="example">In English, the vowels are @samp{a}, @samp{e}, @samp{i}, @samp{o}, @samp{u}, and sometimes @samp{y}. </pre></div> <p>This produces: </p> <blockquote> <p>In English, the vowels are ‘<samp>a</samp>’, ‘<samp>e</samp>’, ‘<samp>i</samp>’, ‘<samp>o</samp>’, ‘<samp>u</samp>’, and sometimes ‘<samp>y</samp>’. </p></blockquote> </div> </body> </html>