1 .\" $Id: mandoc.1,v 1.21 2009/06/18 08:13:34 kristaps Exp $
3 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 .Dd $Mdocdate: June 18 2009 $
23 .Nd format and display UNIX manuals
28 .Op Fl f Ns Ar option...
39 manual pages for display. The arguments are as follows:
42 .It Fl f Ns Ar option...
43 Override default compiler behaviour. See
50 for available formats. Defaults to
56 for available formats. Defaults to
60 Print version and exit.
63 Print warning messages. May be set to
67 for groff/troff-compatibility warnings, or
69 for syntax warnings. If
71 is specified, warnings are considered errors and cause utility
74 arguments may be comma-separated, such as
75 .Fl W Ns Ar error,all .
78 Read input from zero or more
80 If unspecified, reads from stdin. If multiple files are specified,
82 will halt with the first failed parse.
92 text from stdin, implying
94 and prints 78-column backspace-encoded output to stdout as if
102 If punctuation is set apart from words, such as in the phrase
103 .Dq to be \&, or not to be ,
106 according to the following rules. Opening punctuation
113 is not followed by a space. Closing punctuation
126 is not preceded by whitespace.
130 these rules are also applied to macro arguments when appropriate.
149 should only be used for legacy manuals.
153 which is also the default, determines encoding on-the-fly: if the first
160 parser is used; otherwise, the
165 files are specified with
167 each has its file-type determined this way. If multiple files are
172 is specified, then this format is used exclusively.
174 .\" The following escape sequences are recognised, although the per-format
175 .\" compiler may not allow certain sequences.
176 .\" .Bl -tag -width Ds -offset XXXX
178 .\" sets the font mode to X (B, I, R or P, where P resets the font)
179 .\" .It \eX, \e(XX, \e[XN]
180 .\" queries the special-character table for a corresponding symbol
181 .\" .It \e*X, \e*(XX, \e*[XN]
182 .\" deprecated special-character format
188 utility accepts the following
193 Produce 7-bit ASCII output, backspace-encoded for bold and underline
194 styles. This is the default.
196 Produce an indented parse tree.
198 Parse only: produce no output.
201 If multiple input files are specified, these will be processed by the
202 corresponding filter in-order.
205 Default compiler behaviour may be overriden with the
209 .It Fl f Ns Ar ign-scope
210 When rewinding the scope of a block macro, forces the compiler to ignore
211 scope violations. This can seriously mangle the resulting tree.
213 .It Fl f Ns Ar no-ign-escape
214 Don't ignore invalid escape sequences.
215 .It Fl f Ns Ar no-ign-macro
216 Do not ignore unknown macros at the start of input lines.
217 .It Fl f Ns Ar no-ign-chars
218 Do not ignore disallowed characters.
219 .It Fl f Ns Ar strict
221 .Fl f Ns Ar no-ign-escape ,
222 .Fl f Ns Ar no-ign-macro
224 .Fl f Ns Ar no-ign-chars .
232 options may be grouped and delimited with a comma. Using
233 .Fl f Ns Ar ign-scope,no-ign-escape ,
234 for example, will try to ignore scope and not ignore character-escape
238 To page manuals to the terminal:
241 .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less
242 .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less
245 This section summarises
252 A list or display following
254 does not assert a prior vertical break, just as it doesn't with
258 The \-literal and \-unfilled
260 displays types are synonyms, as are \-filled and \-ragged.
263 Words aren't hyphenated.
274 utility was written by
275 .An Kristaps Dzonsons Aq kristaps@kth.se .
280 utility doesn't yet know how to display \-hang lists.
282 Other macros still aren't supported by virtue of nobody complaining