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