JezK
Edit File: Useful-Highlighting.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>Useful Highlighting (GNU Texinfo 6.8)</title> <meta name="description" content="Useful Highlighting (GNU Texinfo 6.8)"> <meta name="keywords" content="Useful Highlighting (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="_0040code.html" rel="next" title="@code"> <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="Useful-Highlighting"> <div class="header"> <p> Next: <a href="_0040code.html" accesskey="n" rel="next"><code>@code</code>{<var>sample-code</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="Highlighting-Commands-are-Useful"></span><h4 class="subsection">6.1.1 Highlighting Commands are Useful</h4> <p>The commands serve a variety of purposes: </p> <dl compact="compact"> <dt><span><code>@code{<var>sample-code</var>}</code></span></dt> <dd><p>Indicate text that is a literal example of a piece of a program. See <a href="_0040code.html"><code>@code</code>{<var>sample-code</var>}</a>. </p> </dd> <dt><span><code>@kbd{<var>keyboard-characters</var>}</code></span></dt> <dd><p>Indicate keyboard input. See <a href="_0040kbd.html"><code>@kbd</code>{<var>keyboard-characters</var>}</a>. </p> </dd> <dt><span><code>@key{<var>key-name</var>}</code></span></dt> <dd><p>Indicate the conventional name for a key on a keyboard. See <a href="_0040key.html"><code>@key</code>{<var>key-name</var>}</a>. </p> </dd> <dt><span><code>@samp{<var>text</var>}</code></span></dt> <dd><p>Indicate text that is a literal example of a sequence of characters. See <a href="_0040samp.html"><code>@samp</code>{<var>text</var>}</a>. </p> </dd> <dt><span><code>@verb{<var>text</var>}</code></span></dt> <dd><p>Write a verbatim sequence of characters. See <a href="_0040verb.html"><code>@verb</code>{<var>char</var><var>text</var><var>char</var>}</a>. </p> </dd> <dt><span><code>@var{<var>metasyntactic-variable</var>}</code></span></dt> <dd><p>Indicate a metasyntactic variable. See <a href="_0040var.html"><code>@var</code>{<var>metasyntactic-variable</var>}</a>. </p> </dd> <dt><span><code>@env{<var>environment-variable</var>}</code></span></dt> <dd><p>Indicate an environment variable. See <a href="_0040env.html"><code>@env</code>{<var>environment-variable</var>}</a>. </p> </dd> <dt><span><code>@file{<var>file-name</var>}</code></span></dt> <dd><p>Indicate the name of a file. See <a href="_0040file.html"><code>@file</code>{<var>file-name</var>}</a>. </p> </dd> <dt><span><code>@command{<var>command-name</var>}</code></span></dt> <dd><p>Indicate the name of a command. See <a href="_0040command.html"><code>@command</code>{<var>command-name</var>}</a>. </p> </dd> <dt><span><code>@option{<var>option</var>}</code></span></dt> <dd><p>Indicate a command-line option. See <a href="_0040option.html"><code>@option</code>{<var>option-name</var>}</a>. </p> </dd> <dt><span><code>@dfn{<var>term</var>}</code></span></dt> <dd><p>Indicate the introductory or defining use of a term. See <a href="_0040dfn.html"><code>@dfn</code>{<var>term</var>}</a>. </p> </dd> <dt><span><code>@cite{<var>reference</var>}</code></span></dt> <dd><p>Indicate the name of a book. See <a href="_0040cite.html"><code>@cite</code>{<var>reference</var>}</a>. </p> </dd> <dt><span><code>@abbr{<var>abbreviation</var>}</code></span></dt> <dd><p>Indicate an abbreviation, such as ‘Comput.’. </p> </dd> <dt><span><code>@acronym{<var>acronym</var>}</code></span></dt> <dd><p>Indicate an acronym. See <a href="_0040acronym.html"><code>@acronym</code>{<var>acronym</var>[, <var>meaning</var>]}</a>. </p> </dd> <dt><span><code>@indicateurl{<var>uniform-resource-locator</var>}</code></span></dt> <dd><p>Indicate an example (that is, nonfunctional) uniform resource locator. See <a href="_0040indicateurl.html"><code>@indicateurl</code>{<var>uniform-resource-locator</var>}</a>. (Use <code>@url</code> (see <a href="_0040url.html"><code>@url</code>, <code>@uref{<var>url</var>[, <var>text</var>][, <var>replacement</var>]}</code></a>) for live urls.) </p> </dd> <dt><span><code>@email{<var>email-address</var>[, <var>displayed-text</var>]}</code></span></dt> <dd><p>Indicate an electronic mail address. See <a href="_0040email.html"><code>@email</code>{<var>email-address</var>[, <var>displayed-text</var>]}</a>. </p> </dd> </dl> </div> </body> </html>