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