/usr/share/doc/texinfo/html/Useful-Highlighting.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>Useful Highlighting - 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="next" href="code.html#code" title="code">
<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="Useful-Highlighting"></a>
<p>
Next: <a rel="next" accesskey="n" href="code.html#code">code</a>,
Up: <a rel="up" accesskey="u" href="Indicating.html#Indicating">Indicating</a>
<hr>
</div>
<h4 class="subsection">9.1.1 Highlighting Commands are Useful</h4>
<p>The highlighting commands can be used to extract useful information
from the file, such as lists of functions or file names. It is
possible, for example, to write a program in Emacs Lisp (or a keyboard
macro) to insert an index entry after every paragraph that contains
words or phrases marked by a specified command. You could do this to
construct an index of functions if you had not already made the
entries.
<p>The commands serve a variety of purposes:
<dl>
<dt><code>@code{</code><var>sample-code</var><code>}</code><dd>Indicate text that is a literal example of a piece of a program.
See <a href="code.html#code"><code>@code</code></a>.
<br><dt><code>@kbd{</code><var>keyboard-characters</var><code>}</code><dd>Indicate keyboard input.
See <a href="kbd.html#kbd"><code>@kbd</code></a>.
<br><dt><code>@key{</code><var>key-name</var><code>}</code><dd>Indicate the conventional name for a key on a keyboard.
See <a href="key.html#key"><code>@key</code></a>.
<br><dt><code>@samp{</code><var>text</var><code>}</code><dd>Indicate text that is a literal example of a sequence of characters.
See <a href="samp.html#samp"><code>@samp</code></a>.
<br><dt><code>@verb{</code><var>text</var><code>}</code><dd>Write a verbatim sequence of characters.
See <a href="verb.html#verb"><code>@verb</code></a>.
<br><dt><code>@var{</code><var>metasyntactic-variable</var><code>}</code><dd>Indicate a metasyntactic variable.
See <a href="var.html#var"><code>@var</code></a>.
<br><dt><code>@env{</code><var>environment-variable</var><code>}</code><dd>Indicate an environment variable.
See <a href="env.html#env"><code>@env</code></a>.
<br><dt><code>@file{</code><var>file-name</var><code>}</code><dd>Indicate the name of a file.
See <a href="file.html#file"><code>@file</code></a>.
<br><dt><code>@command{</code><var>command-name</var><code>}</code><dd>Indicate the name of a command.
See <a href="command.html#command"><code>@command</code></a>.
<br><dt><code>@option{</code><var>option</var><code>}</code><dd>Indicate a command-line option.
See <a href="option.html#option"><code>@option</code></a>.
<br><dt><code>@dfn{</code><var>term</var><code>}</code><dd>Indicate the introductory or defining use of a term.
See <a href="dfn.html#dfn"><code>@dfn</code></a>.
<br><dt><code>@cite{</code><var>reference</var><code>}</code><dd>Indicate the name of a book.
See <a href="cite.html#cite"><code>@cite</code></a>.
<br><dt><code>@abbr{</code><var>abbreviation</var><code>}</code><dd>Indicate an abbreviation, such as `Comput.'.
<br><dt><code>@acronym{</code><var>acronym</var><code>}</code><dd>Indicate an acronym.
See <a href="acronym.html#acronym"><code>@acronym</code></a>.
<br><dt><code>@indicateurl{</code><var>uniform-resource-locator</var><code>}</code><dd>Indicate an example (that is, nonfunctional) uniform resource locator.
See <a href="indicateurl.html#indicateurl"><code>@indicateurl</code></a>. (Use <code>@url</code>
(see <a href="uref.html#uref"><code>@url</code></a>) for live url's.)
<br><dt><code>@email{</code><var>email-address</var><code>[, </code><var>displayed-text</var><code>]}</code><dd>Indicate an electronic mail address.
See <a href="email.html#email"><code>@email</code></a>.
</dl>
</body></html>
|