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