/usr/share/doc/texinfo/html/Useful-Highlighting.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.5, 25 August 2017),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016 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 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 have the freedom to copy and
modify this GNU manual.  Buying copies from the FSF supports it in
developing GNU and promoting software freedom." -->
<!-- Created by GNU Texinfo 6.4.90, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Useful Highlighting (GNU Texinfo 6.5)</title>

<meta name="description" content="Useful Highlighting (GNU Texinfo 6.5)">
<meta name="keywords" content="Useful Highlighting (GNU Texinfo 6.5)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Command-and-Variable-Index.html#Command-and-Variable-Index" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Indicating.html#Indicating" rel="up" title="Indicating">
<link href="_0040code.html#g_t_0040code" rel="next" title="@code">
<link href="Indicating.html#Indicating" rel="prev" title="Indicating">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="Useful-Highlighting"></a>
<div class="header">
<p>
Next: <a href="_0040code.html#g_t_0040code" accesskey="n" rel="next"><code>@code</code></a>, Up: <a href="Indicating.html#Indicating" accesskey="u" rel="up">Indicating</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Highlighting-Commands-are-Useful"></a>
<h4 class="subsection">7.1.1 Highlighting Commands are Useful</h4>

<p>The commands serve a variety of purposes:
</p>
<dl compact="compact">
<dt><code>@code{<var>sample-code</var>}</code></dt>
<dd><p>Indicate text that is a literal example of a piece of a program.
See <a href="_0040code.html#g_t_0040code"><code>@code</code></a>.
</p>
</dd>
<dt><code>@kbd{<var>keyboard-characters</var>}</code></dt>
<dd><p>Indicate keyboard input.  See <a href="_0040kbd.html#g_t_0040kbd"><code>@kbd</code></a>.
</p>
</dd>
<dt><code>@key{<var>key-name</var>}</code></dt>
<dd><p>Indicate the conventional name for a key on a keyboard.
See <a href="_0040key.html#g_t_0040key"><code>@key</code></a>.
</p>
</dd>
<dt><code>@samp{<var>text</var>}</code></dt>
<dd><p>Indicate text that is a literal example of a sequence of characters.
See <a href="_0040samp.html#g_t_0040samp"><code>@samp</code></a>.
</p>
</dd>
<dt><code>@verb{<var>text</var>}</code></dt>
<dd><p>Write a verbatim sequence of characters.
See <a href="_0040verb.html#g_t_0040verb"><code>@verb</code></a>.
</p>
</dd>
<dt><code>@var{<var>metasyntactic-variable</var>}</code></dt>
<dd><p>Indicate a metasyntactic variable.  See <a href="_0040var.html#g_t_0040var"><code>@var</code></a>.
</p>
</dd>
<dt><code>@env{<var>environment-variable</var>}</code></dt>
<dd><p>Indicate an environment variable.  See <a href="_0040env.html#g_t_0040env"><code>@env</code></a>.
</p>
</dd>
<dt><code>@file{<var>file-name</var>}</code></dt>
<dd><p>Indicate the name of a file.  See <a href="_0040file.html#g_t_0040file"><code>@file</code></a>.
</p>
</dd>
<dt><code>@command{<var>command-name</var>}</code></dt>
<dd><p>Indicate the name of a command.
See <a href="_0040command.html#g_t_0040command"><code>@command</code></a>.
</p>
</dd>
<dt><code>@option{<var>option</var>}</code></dt>
<dd><p>Indicate a command-line option.
See <a href="_0040option.html#g_t_0040option"><code>@option</code></a>.
</p>
</dd>
<dt><code>@dfn{<var>term</var>}</code></dt>
<dd><p>Indicate the introductory or defining use of a term.
See <a href="_0040dfn.html#g_t_0040dfn"><code>@dfn</code></a>.
</p>
</dd>
<dt><code>@cite{<var>reference</var>}</code></dt>
<dd><p>Indicate the name of a book.  See <a href="_0040cite.html#g_t_0040cite"><code>@cite</code></a>.
</p>
</dd>
<dt><code>@abbr{<var>abbreviation</var>}</code></dt>
<dd><p>Indicate an abbreviation, such as &lsquo;Comput.&rsquo;.
</p>
</dd>
<dt><code>@acronym{<var>acronym</var>}</code></dt>
<dd><p>Indicate an acronym.  See <a href="_0040acronym.html#g_t_0040acronym"><code>@acronym</code></a>.
</p>
</dd>
<dt><code>@indicateurl{<var>uniform-resource-locator</var>}</code></dt>
<dd><p>Indicate an example (that is, nonfunctional) uniform resource locator.
See <a href="_0040indicateurl.html#g_t_0040indicateurl"><code>@indicateurl</code></a>.  (Use <code>@url</code> (see <a href="_0040url.html#g_t_0040url"><code>@url</code></a>) for
live urls.)
</p>
</dd>
<dt><code>@email{<var>email-address</var>[, <var>displayed-text</var>]}</code></dt>
<dd><p>Indicate an electronic mail address.  See <a href="_0040email.html#g_t_0040email"><code>@email</code></a>.
</p>
</dd>
</dl>





</body>
</html>
texinfo-doc-nonfree 6.5.0-1 / usr / share / doc / texinfo / html / Useful-Highlighting.html
