Annotation of mandoc/mandoc.1, Revision 1.49
1.49 ! kristaps 1: .\" $Id: mandoc.1,v 1.48 2009/11/16 09:52:47 kristaps Exp $
1.1 kristaps 2: .\"
1.17 kristaps 3: .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: .\"
5: .\" Permission to use, copy, modify, and distribute this software for any
1.16 kristaps 6: .\" purpose with or without fee is hereby granted, provided that the above
7: .\" copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: .\"
1.16 kristaps 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.
1.1 kristaps 16: .\"
17: .Dd $Mdocdate$
1.14 kristaps 18: .Dt MANDOC 1
1.1 kristaps 19: .Os
1.32 kristaps 20: .
21: .
1.1 kristaps 22: .Sh NAME
23: .Nm mandoc
1.8 kristaps 24: .Nd format and display UNIX manuals
1.32 kristaps 25: .
26: .
1.1 kristaps 27: .Sh SYNOPSIS
28: .Nm mandoc
29: .Op Fl f Ns Ar option...
1.8 kristaps 30: .Op Fl m Ns Ar format
1.44 kristaps 31: .Op Fl O Ns Ar option...
1.37 kristaps 32: .Op Fl T Ns Ar output
33: .Op Fl V
1.1 kristaps 34: .Op Fl W Ns Ar err...
35: .Op Ar infile...
1.32 kristaps 36: .
37: .
1.1 kristaps 38: .Sh DESCRIPTION
39: The
40: .Nm
1.26 kristaps 41: utility formats
1.8 kristaps 42: .Ux
43: manual pages for display. The arguments are as follows:
1.32 kristaps 44: .
1.19 kristaps 45: .Bl -tag -width Ds
1.1 kristaps 46: .It Fl f Ns Ar option...
1.37 kristaps 47: Comma-separated compiler options. See
1.1 kristaps 48: .Sx Compiler Options
49: for details.
1.32 kristaps 50: .
1.19 kristaps 51: .It Fl m Ns Ar format
1.8 kristaps 52: Input format. See
53: .Sx Input Formats
54: for available formats. Defaults to
1.12 kristaps 55: .Fl m Ns Ar andoc .
1.32 kristaps 56: .
1.44 kristaps 57: .It Fl O Ns Ar option...
1.37 kristaps 58: Comma-separated output options. See
59: .Sx Output Options
60: for details.
61: .
1.19 kristaps 62: .It Fl T Ns Ar output
1.1 kristaps 63: Output format. See
64: .Sx Output Formats
65: for available formats. Defaults to
66: .Fl T Ns Ar ascii .
1.32 kristaps 67: .
1.1 kristaps 68: .It Fl V
69: Print version and exit.
1.32 kristaps 70: .
1.1 kristaps 71: .It Fl W Ns Ar err...
1.37 kristaps 72: Comma-separated warning options. Use
1.1 kristaps 73: .Fl W Ns Ar all
1.24 kristaps 74: to print warnings,
1.26 kristaps 75: .Fl W Ns Ar error
1.24 kristaps 76: for warnings to be considered errors and cause utility
1.26 kristaps 77: termination. Multiple
1.1 kristaps 78: .Fl W
79: arguments may be comma-separated, such as
80: .Fl W Ns Ar error,all .
1.32 kristaps 81: .
1.1 kristaps 82: .It Ar infile...
83: Read input from zero or more
84: .Ar infile .
1.2 kristaps 85: If unspecified, reads from stdin. If multiple files are specified,
86: .Nm
87: will halt with the first failed parse.
1.1 kristaps 88: .El
1.32 kristaps 89: .
1.1 kristaps 90: .Pp
1.26 kristaps 91: By default,
92: .Nm
93: reads
1.8 kristaps 94: .Xr mdoc 7
1.12 kristaps 95: or
96: .Xr man 7
1.8 kristaps 97: text from stdin, implying
1.12 kristaps 98: .Fl m Ns Ar andoc ,
1.48 kristaps 99: and produces
1.1 kristaps 100: .Fl T Ns Ar ascii
1.48 kristaps 101: output.
1.32 kristaps 102: .
1.1 kristaps 103: .Pp
104: .Ex -std mandoc
1.32 kristaps 105: .
106: .
1.8 kristaps 107: .Ss Input Formats
108: The
109: .Nm
110: utility accepts
111: .Xr mdoc 7
112: and
113: .Xr man 7
114: input with
1.10 kristaps 115: .Fl m Ns Ar doc
1.8 kristaps 116: and
1.10 kristaps 117: .Fl m Ns Ar an ,
1.8 kristaps 118: respectively. The
119: .Xr mdoc 7
120: format is
121: .Em strongly
1.26 kristaps 122: recommended;
1.8 kristaps 123: .Xr man 7
124: should only be used for legacy manuals.
1.32 kristaps 125: .
1.11 kristaps 126: .Pp
1.12 kristaps 127: A third option,
128: .Fl m Ns Ar andoc ,
1.13 kristaps 129: which is also the default, determines encoding on-the-fly: if the first
1.26 kristaps 130: non-comment macro is
1.27 kristaps 131: .Sq \&Dd
1.13 kristaps 132: or
1.27 kristaps 133: .Sq \&Dt ,
1.26 kristaps 134: the
1.13 kristaps 135: .Xr mdoc 7
136: parser is used; otherwise, the
137: .Xr man 7
138: parser is used.
1.32 kristaps 139: .
1.13 kristaps 140: .Pp
141: If multiple
1.26 kristaps 142: files are specified with
143: .Fl m Ns Ar andoc ,
1.13 kristaps 144: each has its file-type determined this way. If multiple files are
145: specified and
1.12 kristaps 146: .Fl m Ns Ar doc
147: or
148: .Fl m Ns Ar an
149: is specified, then this format is used exclusively.
1.32 kristaps 150: .
151: .
1.1 kristaps 152: .Ss Output Formats
153: The
154: .Nm
155: utility accepts the following
156: .Fl T
1.48 kristaps 157: arguments (see
158: .Sx OUTPUT ) :
1.32 kristaps 159: .
1.19 kristaps 160: .Bl -tag -width Ds
1.13 kristaps 161: .It Fl T Ns Ar ascii
1.1 kristaps 162: Produce 7-bit ASCII output, backspace-encoded for bold and underline
1.48 kristaps 163: styles. This is the default. See
164: .Sx ASCII Output .
1.32 kristaps 165: .
1.37 kristaps 166: .It Fl T Ns Ar html
1.48 kristaps 167: Produce strict HTML-4.01 output, with a sane default style. See
168: .Sx HTML Output .
1.37 kristaps 169: .
1.13 kristaps 170: .It Fl T Ns Ar tree
1.1 kristaps 171: Produce an indented parse tree.
1.32 kristaps 172: .
1.13 kristaps 173: .It Fl T Ns Ar lint
1.1 kristaps 174: Parse only: produce no output.
175: .El
1.32 kristaps 176: .
1.13 kristaps 177: .Pp
178: If multiple input files are specified, these will be processed by the
179: corresponding filter in-order.
1.32 kristaps 180: .
181: .
1.1 kristaps 182: .Ss Compiler Options
1.35 kristaps 183: Default compiler behaviour may be overridden with the
1.1 kristaps 184: .Fl f
185: flag.
1.32 kristaps 186: .
1.19 kristaps 187: .Bl -tag -width Ds
1.1 kristaps 188: .It Fl f Ns Ar ign-scope
189: When rewinding the scope of a block macro, forces the compiler to ignore
190: scope violations. This can seriously mangle the resulting tree.
1.8 kristaps 191: .Pq mdoc only
1.32 kristaps 192: .
1.45 kristaps 193: .It Fl f Ns Ar ign-escape
194: Ignore invalid escape sequences.
195: This is the default, but the option can be used to override an earlier
196: .Fl f Ns Ar strict .
197: .
1.21 kristaps 198: .It Fl f Ns Ar no-ign-escape
199: Don't ignore invalid escape sequences.
1.32 kristaps 200: .
1.12 kristaps 201: .It Fl f Ns Ar no-ign-macro
1.21 kristaps 202: Do not ignore unknown macros at the start of input lines.
1.32 kristaps 203: .
1.21 kristaps 204: .It Fl f Ns Ar no-ign-chars
205: Do not ignore disallowed characters.
1.32 kristaps 206: .
1.21 kristaps 207: .It Fl f Ns Ar strict
1.26 kristaps 208: Implies
1.21 kristaps 209: .Fl f Ns Ar no-ign-escape ,
1.26 kristaps 210: .Fl f Ns Ar no-ign-macro
1.21 kristaps 211: and
1.26 kristaps 212: .Fl f Ns Ar no-ign-chars .
1.32 kristaps 213: .
1.28 kristaps 214: .It Fl f Ns Ar ign-errors
215: Don't halt when encountering parse errors. Useful with
216: .Fl T Ns Ar lint
217: over a large set of manuals passed on the command line.
1.1 kristaps 218: .El
1.32 kristaps 219: .
1.48 kristaps 220: .
1.37 kristaps 221: .Ss Output Options
222: For the time being, only
223: .Fl T Ns Ar html
1.48 kristaps 224: accepts output options:
1.37 kristaps 225: .Bl -tag -width Ds
1.44 kristaps 226: .It Fl O Ns Ar style=style.css
1.37 kristaps 227: The file
228: .Ar style.css
229: is used for an external style-sheet. This must be a valid absolute or
230: relative URI.
1.44 kristaps 231: .It Fl O Ns Ar includes=fmt
1.40 kristaps 232: The string
233: .Ar fmt ,
1.49 ! kristaps 234: for example,
1.40 kristaps 235: .Ar ../src/%I.html ,
236: is used as a template for linked header files (usually via the
237: .Sq \&In
238: macro). Instances of
1.43 kristaps 239: .Sq \&%I
1.40 kristaps 240: are replaced with the include filename. The default is not to present a
241: hyperlink.
1.44 kristaps 242: .It Fl O Ns Ar man=fmt
1.39 kristaps 243: The string
244: .Ar fmt ,
1.49 ! kristaps 245: for example,
1.39 kristaps 246: .Ar ../html%S/%N.%S.html ,
247: is used as a template for linked manuals (usually via the
1.37 kristaps 248: .Sq \&Xr
1.40 kristaps 249: macro). Instances of
1.43 kristaps 250: .Sq \&%N
1.40 kristaps 251: and
252: .Sq %S
253: are replaced with the linked manual's name and section, respectively.
254: If no section is included, section 1 is assumed. The default is not to
255: present a hyperlink.
1.37 kristaps 256: .El
1.32 kristaps 257: .
1.48 kristaps 258: .
259: .Sh OUTPUT
260: This section documents output details of
261: .Nm .
262: In general, output conforms to the traditional manual style of a header,
1.49 ! kristaps 263: a body composed of sections and sub-sections, and a footer.
1.48 kristaps 264: .Pp
265: The text style of output characters (non-macro characters, punctuation,
266: and white-space) is dictated by context.
267: .Pp
268: White-space is generally stripped from input. This can be changed with
269: character escapes (specified in
270: .Xr mandoc_char 7 )
271: or literal modes (specified in
272: .Xr mdoc 7
273: and
274: .Xr man 7 ) .
275: .Pp
276: If non-macro punctuation is set apart from words, such as in the phrase
277: .Dq to be \&, or not to be ,
278: it's processed by
279: .Nm ,
280: regardless of output format, according to the following rules: opening
281: punctuation
282: .Po
283: .Sq \&( ,
284: .Sq \&[ ,
285: and
286: .Sq \&{
287: .Pc
288: is not followed by a space; closing punctuation
289: .Po
290: .Sq \&. ,
291: .Sq \&, ,
292: .Sq \&; ,
293: .Sq \&: ,
294: .Sq \&? ,
295: .Sq \&! ,
296: .Sq \&) ,
297: .Sq \&]
298: and
299: .Sq \&}
300: .Pc
301: is not preceded by white-space.
302: .
303: .Pp
304: If the input is
305: .Xr mdoc 7 ,
306: however, these rules are also applied to macro arguments when appropriate.
307: .
308: .
309: .Ss ASCII Output
1.49 ! kristaps 310: Output produced by
1.48 kristaps 311: .Fl T Ns Ar ascii ,
312: which is the default, is rendered in standard 7-bit ASCII documented in
313: .Xr ascii 7 .
314: .Pp
315: Font styles are applied by using back-spaced encoding such that an
316: underlined character
317: .Sq c
318: is rendered as
319: .Sq _ Ns \e[bs] Ns c ,
320: where
321: .Sq \e[bs]
322: is the back-space character number 8. Emboldened characters are rendered as
323: .Sq c Ns \e[bs] Ns c .
324: .Pp
325: The special characters documented in
326: .Xr mandoc_char 7
327: are rendered best-effort in an ASCII equivalent.
328: .Pp
329: Output width is limited to 78 visible columns unless literal input lines
330: exceed this limit.
331: .
332: .
333: .Ss HTML Output
334: Output produced by
335: .Fl T Ns Ar html
336: comforms to HTML-4.01 strict.
337: .Pp
338: Font styles and page structure are applied using CSS2. By default, no
339: font style is applied to any text, although CSS2 is hard-coded to format
340: the basic structure of output.
341: .Pp
342: The
343: .Pa example.style.css
344: file documents the range of styles applied to output and, if used, will
345: cause rendered documents to appear as they do in
346: .Fl T Ns Ar ascii .
347: .Pp
348: Special characters are rendered in decimal-encoded UTF-8.
349: .
350: .
1.1 kristaps 351: .Sh EXAMPLES
1.13 kristaps 352: To page manuals to the terminal:
1.32 kristaps 353: .
1.1 kristaps 354: .Pp
1.21 kristaps 355: .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less
1.13 kristaps 356: .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less
1.32 kristaps 357: .
1.28 kristaps 358: .Pp
1.41 kristaps 359: To produce HTML manuals with
360: .Ar style.css
361: as the style-sheet:
1.38 kristaps 362: .Pp
1.48 kristaps 363: .D1 % mandoc \-Thtml -Ostyle=style.css mdoc.7 > mdoc.7.html
1.38 kristaps 364: .Pp
1.28 kristaps 365: To check over a large set of manuals:
1.32 kristaps 366: .
1.28 kristaps 367: .Pp
368: .Dl % mandoc \-Tlint \-fign-errors `find /usr/src -name \e*\e.[1-9]`
1.32 kristaps 369: .
370: .
1.20 kristaps 371: .Sh COMPATIBILITY
1.26 kristaps 372: This section summarises
1.20 kristaps 373: .Nm
1.26 kristaps 374: compatibility with
1.20 kristaps 375: .Xr groff 1 .
1.32 kristaps 376: Each input and output format is separately noted.
377: .
378: .
1.48 kristaps 379: .Ss ASCII Compatibility
1.37 kristaps 380: .Bl -bullet -compact
1.29 kristaps 381: .It
1.49 ! kristaps 382: The
1.29 kristaps 383: .Sq \e~
1.49 ! kristaps 384: special character doesn't produce expected behaviour in
1.32 kristaps 385: .Fl T Ns Ar ascii .
386: .
387: .It
1.49 ! kristaps 388: The
1.33 kristaps 389: .Sq \&Bd \-literal
1.49 ! kristaps 390: and
1.32 kristaps 391: .Sq \&Bd \-unfilled
392: macros of
393: .Xr mdoc 7
394: in
395: .Fl T Ns Ar ascii
396: are synonyms, as are \-filled and \-ragged.
397: .
1.26 kristaps 398: .It
1.49 ! kristaps 399: In
1.27 kristaps 400: .Xr groff 1 ,
401: the
402: .Sq \&Pa
1.32 kristaps 403: .Xr mdoc 7
404: macro does not underline when scoped under an
1.30 kristaps 405: .Sq \&It
406: in the FILES section. This behaves correctly in
1.27 kristaps 407: .Nm .
1.32 kristaps 408: .
1.27 kristaps 409: .It
1.20 kristaps 410: A list or display following
1.27 kristaps 411: .Sq \&Ss
1.32 kristaps 412: .Xr mdoc 7
413: macro in
414: .Fl T Ns Ar ascii
1.20 kristaps 415: does not assert a prior vertical break, just as it doesn't with
1.27 kristaps 416: .Sq \&Sh .
1.32 kristaps 417: .
1.20 kristaps 418: .It
1.32 kristaps 419: The
420: .Sq \&na
421: .Xr man 7
1.34 kristaps 422: macro in
1.32 kristaps 423: .Fl T Ns Ar ascii
1.34 kristaps 424: has no effect.
1.32 kristaps 425: .
1.20 kristaps 426: .It
427: Words aren't hyphenated.
1.32 kristaps 428: .
1.22 kristaps 429: .It
430: In normal mode (not a literal block), blocks of spaces aren't preserved,
1.32 kristaps 431: so double spaces following sentence closure are reduced to a single space;
432: .Xr groff 1
433: retains spaces.
434: .
435: .It
436: Sentences are unilaterally monospaced.
1.20 kristaps 437: .El
1.42 kristaps 438: .
1.48 kristaps 439: .
440: .Ss HTML Compatibility
1.42 kristaps 441: .Bl -bullet -compact
442: .It
443: The
1.47 kristaps 444: .Sq \efP
445: escape will revert the font to the previous
446: .Sq \ef
447: escape, not to the last rendered decoration, which is now dictated by
448: CSS instead of hard-coded. It also will not span past the current
1.49 ! kristaps 449: scope, for the same reason. Note that in
1.47 kristaps 450: .Sx ASCII Output
451: mode, this will work fine.
452: .It
453: The
1.42 kristaps 454: .Xr mdoc 7
455: .Sq \&Bl \-hang
456: and
457: .Sq \&Bl \-tag
458: list types render similarly (no break following overreached left-hand
459: side) due to the expressive constraints of HTML.
460: .
461: .It
462: The
463: .Xr man 7
464: .Sq IP
465: and
466: .Sq TP
467: lists render similarly.
468: .El
1.48 kristaps 469: .
470: .
1.1 kristaps 471: .Sh SEE ALSO
1.13 kristaps 472: .Xr mandoc_char 7 ,
1.9 kristaps 473: .Xr mdoc 7 ,
474: .Xr man 7
1.39 kristaps 475: .
1.1 kristaps 476: .Sh AUTHORS
477: The
478: .Nm
1.26 kristaps 479: utility was written by
1.18 kristaps 480: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.39 kristaps 481: .
1.48 kristaps 482: .
1.39 kristaps 483: .Sh CAVEATS
1.48 kristaps 484: The
485: .Fl T Ns Ar html
486: CSS2 styling used for
487: .Fl m Ns Ar doc
488: input lists does not render properly in brain-dead browsers, such as
489: Internet Explorer 6 and earlier.
490: .Pp
1.39 kristaps 491: In
492: .Fl T Ns Ar html ,
493: the maximum size of an element attribute is determined by
494: .Dv BUFSIZ ,
495: which is usually 1024 bytes. Be aware of this when setting long link
1.48 kristaps 496: formats, e.g.,
497: .Fl O Ns Ar style=really/long/link .
1.46 kristaps 498: .Pp
499: The
500: .Fl T Ns Ar html
1.48 kristaps 501: output mode doesn't render the
1.46 kristaps 502: .Sq \es
1.47 kristaps 503: font size escape documented in
1.46 kristaps 504: .Xr mdoc 7
505: and
506: .Xr man 7 .
CVSweb