-
Notifications
You must be signed in to change notification settings - Fork 4
/
part1.xml
45 lines (45 loc) · 2.03 KB
/
part1.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
<?xml version="1.0" encoding="UTF-8"?>
<html>
<head>
<meta http-equiv="Content-Type" content="text/xml; charset=utf-8"/>
<title>Tutorial Introduction</title>
<link rel="stylesheet" href="css/book.css" type="text/css"/>
</head>
<body>
<h1>
Tutorial Introduction
</h1>
<p>
Let's begin with practical examples of <span class="lang">mdoc</span>.
</p>
<p>
The intended audience of this part is somebody who has never written a <span class="lang">mdoc</span> manual. Although
you may be tempted to jump to the chapter relevant to your manual type (for example, a command or function library),
it's best to read the chapters in order. I'll explain <span class="lang">mdoc</span> syntax as we go.
</p>
<p>
If you've already written a few manuals, you may want to read this part anyway: beyond explaining technical <span
class="lang">mdoc</span> language concepts by example, I'll also introduce some best practises and discuss
portability between various <span class="lang">mdoc</span> environments.
</p>
<p>
I'll frequently refer to the screen output of <span class="lang">mdoc</span> documents as displayed with the UNIX <a
href="commands.xml#cmd_man" class="cmd">man</a> utility. Furthermore, I'll refer to command invocation in the
traditional UNIX way — on the <a class="term" href="glossary.xml#command_line">command line</a>. In short, a bit
of UNIX knowledge will help to avoid confusion. But I'll briefly introduce invocation syntaxes as the need arises.
</p>
<table class="nav">
<tbody>
<tr>
<td class="nav-contents"><a href="toc.xml">Contents</a></td>
<td class="nav-next"><a href="part1-1.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/part1.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>