-
Notifications
You must be signed in to change notification settings - Fork 4
/
part3-1.xml
82 lines (82 loc) · 3.4 KB
/
part3-1.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
78
79
80
81
82
<?xml version="1.0" encoding="UTF-8"?>
<html>
<head>
<meta http-equiv="Content-Type" content="text/xml; charset=utf-8"/>
<title>Formatters</title>
<link rel="stylesheet" href="css/book.css" type="text/css"/>
</head>
<body>
<h2>
Formatters
</h2>
<p>
The most important part of the <span class="lang">mdoc</span> tools is the formatter, which compiles an <span
class="lang">mdoc</span> document into an output format.
</p>
<div class="mdocout">
<div class="mdoc-section">
<h1>NAME</h1>
<b class="mdoc-name">cat</b> — <span class="mdoc-desc">concatenate and print files</span></div>
<div class="mdoc-section">
<h1>SYNOPSIS</h1>
<table class="mdoc-synopsis">
<col style="width: 3.00ex;"/>
<col/>
<tbody>
<tr>
<td>
cat
</td>
<td>
[<span class="mdoc-opt"><b class="mdoc-flag">-benstuv</b></span>]
[<span class="mdoc-opt"><i class="mdoc-arg">file ...</i></span>]
</td>
</tr>
</tbody>
</table>
</div>
<div class="mdoc-section">
<h1>DESCRIPTION</h1>
The <b class="mdoc-name">cat</b> utility reads files sequentially, writing them to the standard output. The <i
class="mdoc-arg">file</i> operands are processed in command-line order. If <i class="mdoc-arg">file</i>
is a single dash (‘​-') or absent, <b class="mdoc-name">cat</b> reads from
the standard input.
</div>
</div>
<p>
All formatters must adhere to the general conventions set forth in the Version 1 AT&T UNIX <a class="term"
href="glossary.xml#unix_programmers_manual">Programmer's Manual</a>, which details the terms that are in bold
and those that are italicised (rendered with underlines in terminals).
</p>
<p>
Most formatters also support printer-friendly output, usually to <a href="glossary.xml#ps" class="term">PS</a> or <a
href="glossary.xml#pdf" class="term">PDF</a>. Some also include <a href="glossary.xml#html"
class="term">HTML</a> or <a href="glossary.xml#xhtml" class="term">XHTML</a> for web publication.
</p>
<p>
In this book, I'll focus only on contemporary formatters. Originally, <span class="lang">mdoc</span>, as a macro set
for the <a href="glossary.xml#roff" class="term lang">roff</a> language, was exclusively formatted by the <a
href="commands.xml#cmd_troff" class="cmd">troff</a> and <a href="commands.xml#cmd_nroff" class="cmd">nroff</a>
utilities as distributed with <a class="term" href="glossary.xml#bsd_unix">BSD UNIX</a>. Historically, <a
href="commands.xml#cmd_troff" class="cmd">troff</a> was tailored for printers and graphical output, while <a
href="commands.xml#cmd_nroff" class="cmd">nroff</a> focussed on <a href="glossary.xml#terminal"
class="term">terminal</a> output.
</p>
<p>
Most modern utilities, however, encompass both of these capabilities.
</p>
<table class="nav">
<tbody>
<tr>
<td class="nav-contents"><a href="toc.xml">Contents</a></td>
<td class="nav-next"><a href="part3-1-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/part3-1.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>