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
|
<html lang="en">
<head>
<title>Format of Descriptions - Untitled</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Untitled">
<meta name="generator" content="makeinfo 4.11">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Conventions.html#Conventions" title="Conventions">
<link rel="prev" href="Error-Messages.html#Error-Messages" title="Error Messages">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<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">
<p>
<a name="Format-of-Descriptions"></a>
Previous: <a rel="previous" accesskey="p" href="Error-Messages.html#Error-Messages">Error Messages</a>,
Up: <a rel="up" accesskey="u" href="Conventions.html#Conventions">Conventions</a>
<hr>
</div>
<h4 class="subsection">1.3.5 Format of Descriptions</h4>
<p><a name="index-description-format-15"></a>
Functions, commands, and variables are described in this manual in a
uniform format. The first line of a description contains the name of
the item followed by its arguments, if any.
The category—function, variable, or whatever—appears at the
beginning of the line.
The description follows on succeeding lines, sometimes with examples.
<ul class="menu">
<li><a accesskey="1" href="A-Sample-Function-Description.html#A-Sample-Function-Description">A Sample Function Description</a>
<li><a accesskey="2" href="A-Sample-Command-Description.html#A-Sample-Command-Description">A Sample Command Description</a>
<li><a accesskey="3" href="A-Sample-Variable-Description.html#A-Sample-Variable-Description">A Sample Variable Description</a>
</ul>
</body></html>
|
