summaryrefslogtreecommitdiff
path: root/usr.bin/mandoc/mandoc.1
blob: 01330eda16e17417da5d653ed03a5391cb07668f (plain)
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
.\"	$Id: mandoc.1,v 1.12 2009/08/22 14:56:03 schwarze Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: August 22 2009 $
.Dt MANDOC 1
.Os
.\" SECTION
.Sh NAME
.Nm mandoc
.Nd format and display UNIX manuals
.\" SECTION
.Sh SYNOPSIS
.Nm mandoc
.Op Fl V
.Op Fl f Ns Ar option...
.Op Fl m Ns Ar format
.Op Fl W Ns Ar err...
.Op Fl T Ns Ar output
.Op Ar infile...
.\" SECTION
.Sh DESCRIPTION
The
.Nm
utility formats
.Ux
manual pages for display.  The arguments are as follows:
.Bl -tag -width Ds
.\" ITEM
.It Fl f Ns Ar option...
Override default compiler behaviour.  See
.Sx Compiler Options
for details.
.\" ITEM
.It Fl m Ns Ar format
Input format.  See
.Sx Input Formats
for available formats.  Defaults to
.Fl m Ns Ar andoc .
.\" ITEM
.It Fl T Ns Ar output
Output format.  See
.Sx Output Formats
for available formats.  Defaults to
.Fl T Ns Ar ascii .
.\" ITEM
.It Fl V
Print version and exit.
.\" ITEM
.It Fl W Ns Ar err...
Configure warning messages.  Use
.Fl W Ns Ar all
to print warnings,
.Fl W Ns Ar error
for warnings to be considered errors and cause utility
termination.  Multiple
.Fl W
arguments may be comma-separated, such as
.Fl W Ns Ar error,all .
.\" ITEM
.It Ar infile...
Read input from zero or more
.Ar infile .
If unspecified, reads from stdin.  If multiple files are specified,
.Nm
will halt with the first failed parse.
.El
.\" PARAGRAPH
.Pp
By default,
.Nm
reads
.Xr mdoc 7
or
.Xr man 7
text from stdin, implying
.Fl m Ns Ar andoc ,
and prints 78-column backspace-encoded output to stdout as if
.Fl T Ns Ar ascii
were provided.
.\" PARAGRAPH
.Pp
.Ex -std mandoc
.\" SUB-SECTION
.Ss Punctuation and Spacing
If punctuation is set apart from words, such as in the phrase
.Dq to be \&, or not to be ,
it's processed by
.Nm
according to the following rules:  opening punctuation
.Po
.Sq \&( ,
.Sq \&[ ,
and
.Sq \&{
.Pc
is not followed by a space; closing punctuation
.Po
.Sq \&. ,
.Sq \&, ,
.Sq \&; ,
.Sq \&: ,
.Sq \&? ,
.Sq \&! ,
.Sq \&) ,
.Sq \&]
and
.Sq \&}
.Pc
is not preceded by whitespace.
.Pp
If the input is
.Xr mdoc 7 ,
these rules are also applied to macro arguments when appropriate.
.Pp
White-space, in non-literal (normal) mode, is stripped from input and
replaced on output by a single space.  Thus, if you wish to preserve
multiple spaces, they must be space-escaped
.Sq \e\
or used in a literal display mode, e.g.,
.Sq \&Bd \-literal
in
.Xr mdoc 7 .
.\" SUB-SECTION
.Ss Input Formats
The
.Nm
utility accepts
.Xr mdoc 7
and
.Xr man 7
input with
.Fl m Ns Ar doc
and
.Fl m Ns Ar an ,
respectively.  The
.Xr mdoc 7
format is
.Em strongly
recommended;
.Xr man 7
should only be used for legacy manuals.
.Pp
A third option,
.Fl m Ns Ar andoc ,
which is also the default, determines encoding on-the-fly: if the first
non-comment macro is
.Sq \&Dd
or
.Sq \&Dt ,
the
.Xr mdoc 7
parser is used; otherwise, the
.Xr man 7
parser is used.
.Pp
If multiple
files are specified with
.Fl m Ns Ar andoc ,
each has its file-type determined this way.  If multiple files are
specified and
.Fl m Ns Ar doc
or
.Fl m Ns Ar an
is specified, then this format is used exclusively.
.\" .Pp
.\" The following escape sequences are recognised, although the per-format
.\" compiler may not allow certain sequences.
.\" .Bl -tag -width Ds -offset XXXX
.\" .It \efX
.\" sets the font mode to X (B, I, R or P, where P resets the font)
.\" .It \eX, \e(XX, \e[XN]
.\" queries the special-character table for a corresponding symbol
.\" .It \e*X, \e*(XX, \e*[XN]
.\" deprecated special-character format
.\" .El
.\" SUB-SECTION
.Ss Output Formats
The
.Nm
utility accepts the following
.Fl T
arguments:
.Bl -tag -width Ds
.It Fl T Ns Ar ascii
Produce 7-bit ASCII output, backspace-encoded for bold and underline
styles.  This is the default.
.It Fl T Ns Ar tree
Produce an indented parse tree.
.It Fl T Ns Ar lint
Parse only: produce no output.
.El
.Pp
If multiple input files are specified, these will be processed by the
corresponding filter in-order.
.\" SUB-SECTION
.Ss Compiler Options
Default compiler behaviour may be overriden with the
.Fl f
flag.
.Bl -tag -width Ds
.It Fl f Ns Ar ign-scope
When rewinding the scope of a block macro, forces the compiler to ignore
scope violations.  This can seriously mangle the resulting tree.
.Pq mdoc only
.It Fl f Ns Ar no-ign-escape
Don't ignore invalid escape sequences.
.It Fl f Ns Ar no-ign-macro
Do not ignore unknown macros at the start of input lines.
.It Fl f Ns Ar no-ign-chars
Do not ignore disallowed characters.
.It Fl f Ns Ar strict
Implies
.Fl f Ns Ar no-ign-escape ,
.Fl f Ns Ar no-ign-macro
and
.Fl f Ns Ar no-ign-chars .
.It Fl f Ns Ar ign-errors
Don't halt when encountering parse errors.  Useful with
.Fl T Ns Ar lint
over a large set of manuals passed on the command line.
.El
.\" PARAGRAPH
.Pp
As with the
.Fl W
flag, multiple
.Fl f
options may be grouped and delimited with a comma.  Using
.Fl f Ns Ar ign-scope,no-ign-escape ,
for example, will try to ignore scope and not ignore character-escape
errors.
.\" SECTION
.Sh EXAMPLES
To page manuals to the terminal:
.\" PARAGRAPH
.Pp
.D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less
.D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less
.\" PARAGRAPH
.Pp
To check over a large set of manuals:
.\" PARAGRAPH
.Pp
.Dl % mandoc \-Tlint \-fign-errors `find /usr/src -name \e*\e.[1-9]`
.\" SECTION
.Sh COMPATIBILITY
This section summarises
.Nm
compatibility with
.Xr groff 1 .
.Pp
.Bl -bullet -compact
.It
A list or display following
.Sq \&Ss
does not assert a prior vertical break, just as it doesn't with
.Sq \&Sh .
.It
The \-literal and \-unfilled
.Sq \&Bd
displays types are synonyms, as are \-filled and \-ragged.
.It
Words aren't hyphenated.
.It
In normal mode (not a literal block), blocks of spaces aren't preserved,
so double spaces following sentence closure are reduced to a single space
.Pq Dq French spacing .
.El
.\" SECTION
.Sh SEE ALSO
.Xr mandoc_char 7 ,
.Xr mdoc 7 ,
.Xr man 7
.\" SECTION
.Sh AUTHORS
The
.Nm
utility was written by
.An Kristaps Dzonsons Aq kristaps@kth.se .