-
Notifications
You must be signed in to change notification settings - Fork 4
/
part2-2-2.xml
77 lines (77 loc) · 2.7 KB
/
part2-2-2.xml
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
<?xml version="1.0" encoding="UTF-8"?>
<html>
<head>
<meta http-equiv="Content-Type" content="text/xml; charset=utf-8"/>
<title>Document Body</title>
<link rel="stylesheet" href="css/book.css" type="text/css"/>
</head>
<body>
<h3>
Document Body
</h3>
<p>
The document body begins with the first macro not in the prologue set (<a href="macros.xml#macro_dd"
class="macro">Dd</a>, <a href="macros.xml#macro_dt" class="macro">Dt</a>, and <a href="macros.xml#macro_os"
class="macro">Os</a>). The document body consists of the manual content itself, and varies significantly
between categories and, of course, the material itself.
</p>
<div class="mdocin">
.Sh NAME
<br />
.Nm mdoc
<br />
.Nd mdoc language reference
<br />
.Sh DESCRIPTION
<br />
The
<br />
.Nm mdoc
<br />
language is used to format
<br />
.Bx
<br />
.Ux
<br />
manuals.
</div>
<p>
The content of the document body is divided into sections. Sections are indicated by the <a
href="macros.xml#macro_sh" class="macro">Sh</a> macro.
</p>
<div class="mdocsyntax">
.<a href="macros.xml#macro_sh" class="macro">Sh</a> <span class="macroarg">SECTION NAME</span>
<br />
Text within the section...
</div>
<p>
As described in the introduction, a section consists of its line arguments and all subsequent lines until the end of
file or another <a href="macros.xml#macro_sh" class="macro">Sh</a> macro.
</p>
<p>
By convention, <a href="macros.xml#macro_sh" class="macro">Sh</a> arguments are capitalised. I'll describe
conventional sections at length in the next chapter, as for the most part follow long-standing document conventions.
</p>
<p>
In general, the document body requires at least the <span class="sec">NAME</span> and <span
class="sec">DESCRIPTION</span> sections, and usually the <span class="sec">SYNOPSIS</span> section as well. The
first section must be <span class="sec">NAME</span>, optionally followed by <span class="sec">SYNOPSIS</span>. The
<span class="sec">DESCRIPTION</span> section must follow either the <span class="sec">NAME</span> or <span
class="sec">SYNOPSIS</span>.
</p>
<table class="nav">
<tbody>
<tr>
<td class="nav-contents"><a href="toc.xml">Contents</a></td>
<td class="nav-next"><a href="part2-3.xml">Next</a></td>
<td class="nav-home"><a href="http://manpages.bsd.lv/index.html">Home</a></td>
<td class="nav-history"><a href="http://manpages.bsd.lv/cgi-bin/cvsweb/part2-2-2.xml?cvsroot=manpages">History</a></td>
</tr>
</tbody>
</table>
<p class="edits">
Last edited by $Author$ on $Date$. Copyright © 2011, Kristaps Dzonsons. CC BY-SA.
</p>
</body>
</html>