Annotation of src/usr.bin/mandoc/mandoc.1, Revision 1.45
1.45 ! schwarze 1: .\" $OpenBSD: mandoc.1,v 1.44 2011/05/29 21:22:18 schwarze Exp $
1.1 kristaps 2: .\"
1.44 schwarze 3: .\" Copyright (c) 2009, 2010, 2011 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.45 ! schwarze 17: .Dd $Mdocdate: May 29 2011 $
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
1.1 kristaps 26: .Op Fl m Ns Ar format
1.26 jmc 27: .Op Fl O Ns Ar option
1.17 schwarze 28: .Op Fl T Ns Ar output
1.38 schwarze 29: .Op Fl W Ns Ar level
1.45 ! schwarze 30: .Op Ar
1.1 kristaps 31: .Sh DESCRIPTION
32: The
33: .Nm
1.10 schwarze 34: utility formats
1.1 kristaps 35: .Ux
1.25 jmc 36: manual pages for display.
37: The arguments are as follows:
1.5 schwarze 38: .Bl -tag -width Ds
1.1 kristaps 39: .It Fl m Ns Ar format
1.25 jmc 40: Input format.
41: See
1.1 kristaps 42: .Sx Input Formats
1.25 jmc 43: for available formats.
44: Defaults to
1.26 jmc 45: .Fl m Ns Cm andoc .
46: .It Fl O Ns Ar option
1.25 jmc 47: Comma-separated output options.
1.1 kristaps 48: .It Fl T Ns Ar output
1.25 jmc 49: Output format.
50: See
1.1 kristaps 51: .Sx Output Formats
1.25 jmc 52: for available formats.
53: Defaults to
1.26 jmc 54: .Fl T Ns Cm ascii .
1.4 schwarze 55: .It Fl V
56: Print version and exit.
1.38 schwarze 57: .It Fl W Ns Ar level
58: Specify the minimum message
59: .Ar level
60: to be reported on the standard error output and to affect the exit status.
61: The
62: .Ar level
63: can be
64: .Cm warning ,
65: .Cm error ,
66: or
67: .Cm fatal .
68: The default is
69: .Fl W Ns Cm fatal ;
1.26 jmc 70: .Fl W Ns Cm all
1.38 schwarze 71: is an alias for
72: .Fl W Ns Cm warning .
73: See
74: .Sx EXIT STATUS
75: and
76: .Sx DIAGNOSTICS
77: for details.
78: .Pp
79: The special option
80: .Fl W Ns Cm stop
81: tells
82: .Nm
83: to exit after parsing a file that causes warnings or errors of at least
84: the requested level.
85: No formatted output will be produced from that file.
86: If both a
87: .Ar level
88: and
89: .Cm stop
90: are requested, they can be joined with a comma, for example
91: .Fl W Ns Cm error , Ns Cm stop .
1.26 jmc 92: .It Ar file
93: Read input from zero or more files.
1.25 jmc 94: If unspecified, reads from stdin.
95: If multiple files are specified,
1.1 kristaps 96: .Nm
97: will halt with the first failed parse.
98: .El
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.1 kristaps 111: .Ss Input Formats
112: The
113: .Nm
114: utility accepts
115: .Xr mdoc 7
116: and
117: .Xr man 7
118: input with
1.26 jmc 119: .Fl m Ns Cm doc
1.1 kristaps 120: and
1.26 jmc 121: .Fl m Ns Cm an ,
1.25 jmc 122: respectively.
123: The
1.1 kristaps 124: .Xr mdoc 7
125: format is
126: .Em strongly
1.10 schwarze 127: recommended;
1.1 kristaps 128: .Xr man 7
129: should only be used for legacy manuals.
130: .Pp
131: A third option,
1.26 jmc 132: .Fl m Ns Cm andoc ,
1.1 kristaps 133: which is also the default, determines encoding on-the-fly: if the first
1.10 schwarze 134: non-comment macro is
1.11 schwarze 135: .Sq \&Dd
1.1 kristaps 136: or
1.11 schwarze 137: .Sq \&Dt ,
1.10 schwarze 138: the
1.1 kristaps 139: .Xr mdoc 7
140: parser is used; otherwise, the
141: .Xr man 7
142: parser is used.
143: .Pp
144: If multiple
1.10 schwarze 145: files are specified with
1.26 jmc 146: .Fl m Ns Cm andoc ,
1.25 jmc 147: each has its file-type determined this way.
148: If multiple files are
1.1 kristaps 149: specified and
1.26 jmc 150: .Fl m Ns Cm doc
1.1 kristaps 151: or
1.26 jmc 152: .Fl m Ns Cm an
1.1 kristaps 153: is specified, then this format is used exclusively.
154: .Ss Output Formats
155: The
156: .Nm
157: utility accepts the following
158: .Fl T
1.34 schwarze 159: arguments, which correspond to output modes:
1.5 schwarze 160: .Bl -tag -width Ds
1.44 schwarze 161: .It Fl T Ns Cm utf8
1.45 ! schwarze 162: Encode output in the UTF\-8 multi-byte format.
1.44 schwarze 163: See
1.45 ! schwarze 164: .Sx UTF\-8 Output .
1.44 schwarze 165: .It Fl T Ns Cm locale
1.45 ! schwarze 166: Encode output using the current locale.
1.44 schwarze 167: See
168: .Sx Locale Output .
1.26 jmc 169: .It Fl T Ns Cm ascii
1.42 schwarze 170: Produce 7-bit ASCII output.
1.25 jmc 171: This is the default.
172: See
1.20 schwarze 173: .Sx ASCII Output .
1.26 jmc 174: .It Fl T Ns Cm html
1.42 schwarze 175: Produce strict CSS1/HTML-4.01 output.
1.25 jmc 176: See
1.20 schwarze 177: .Sx HTML Output .
1.26 jmc 178: .It Fl T Ns Cm lint
179: Parse only: produce no output.
180: Implies
1.38 schwarze 181: .Fl W Ns Cm warning .
1.36 schwarze 182: .It Fl T Ns Cm pdf
183: Produce PDF output.
184: See
185: .Sx PDF Output .
1.31 schwarze 186: .It Fl T Ns Cm ps
187: Produce PostScript output.
188: See
189: .Sx PostScript Output .
1.26 jmc 190: .It Fl T Ns Cm tree
191: Produce an indented parse tree.
192: .It Fl T Ns Cm xhtml
1.42 schwarze 193: Produce strict CSS1/XHTML-1.0 output.
1.25 jmc 194: See
1.21 schwarze 195: .Sx XHTML Output .
1.1 kristaps 196: .El
197: .Pp
198: If multiple input files are specified, these will be processed by the
199: corresponding filter in-order.
1.45 ! schwarze 200: .Ss UTF\-8 Output
1.44 schwarze 201: Use
202: .Fl T Ns Cm utf8
1.45 ! schwarze 203: to force a UTF\-8 locale.
1.44 schwarze 204: See
205: .Sx Locale Output
206: for details and options.
207: .Ss Locale Output
208: Locale-depending output encoding is triggered with
209: .Fl T Ns Cm locale .
210: This option is not available on all systems: systems without locale
211: support, or those whose internal representation is not natively UCS-4,
212: will fall back to
213: .Fl T Ns Cm ascii .
214: See
215: .Sx ASCII Output
216: for font style specification and available command-line arguments.
1.34 schwarze 217: .Ss ASCII Output
218: Output produced by
219: .Fl T Ns Cm ascii ,
220: which is the default, is rendered in standard 7-bit ASCII documented in
221: .Xr ascii 7 .
222: .Pp
223: Font styles are applied by using back-spaced encoding such that an
224: underlined character
225: .Sq c
226: is rendered as
227: .Sq _ Ns \e[bs] Ns c ,
228: where
229: .Sq \e[bs]
230: is the back-space character number 8.
231: Emboldened characters are rendered as
232: .Sq c Ns \e[bs] Ns c .
233: .Pp
234: The special characters documented in
235: .Xr mandoc_char 7
236: are rendered best-effort in an ASCII equivalent.
1.44 schwarze 237: If no equivalent is found,
238: .Sq \&?
239: is used instead.
1.34 schwarze 240: .Pp
241: Output width is limited to 78 visible columns unless literal input lines
242: exceed this limit.
243: .Pp
244: The following
245: .Fl O
246: arguments are accepted:
1.5 schwarze 247: .Bl -tag -width Ds
1.34 schwarze 248: .It Cm width Ns = Ns Ar width
249: The output width is set to
250: .Ar width ,
251: which will normalise to \(>=60.
1.1 kristaps 252: .El
1.34 schwarze 253: .Ss HTML Output
254: Output produced by
255: .Fl T Ns Cm html
256: conforms to HTML-4.01 strict.
257: .Pp
1.30 schwarze 258: The
1.34 schwarze 259: .Pa example.style.css
1.42 schwarze 260: file documents style-sheet classes available for customising output.
261: If a style-sheet is not specified with
262: .Fl O Ns Ar style ,
263: .Fl T Ns Cm html
264: defaults to simple output readable in any graphical or text-based web
265: browser.
1.34 schwarze 266: .Pp
1.45 ! schwarze 267: Special characters are rendered in decimal-encoded UTF\-8.
1.34 schwarze 268: .Pp
269: The following
1.33 schwarze 270: .Fl O
1.34 schwarze 271: arguments are accepted:
1.17 schwarze 272: .Bl -tag -width Ds
1.33 schwarze 273: .It Cm includes Ns = Ns Ar fmt
1.17 schwarze 274: The string
275: .Ar fmt ,
1.21 schwarze 276: for example,
1.17 schwarze 277: .Ar ../src/%I.html ,
278: is used as a template for linked header files (usually via the
279: .Sq \&In
1.25 jmc 280: macro).
281: Instances of
1.17 schwarze 282: .Sq \&%I
1.25 jmc 283: are replaced with the include filename.
284: The default is not to present a
1.17 schwarze 285: hyperlink.
1.33 schwarze 286: .It Cm man Ns = Ns Ar fmt
1.17 schwarze 287: The string
288: .Ar fmt ,
1.21 schwarze 289: for example,
1.17 schwarze 290: .Ar ../html%S/%N.%S.html ,
291: is used as a template for linked manuals (usually via the
292: .Sq \&Xr
1.25 jmc 293: macro).
294: Instances of
1.17 schwarze 295: .Sq \&%N
296: and
297: .Sq %S
298: are replaced with the linked manual's name and section, respectively.
1.25 jmc 299: If no section is included, section 1 is assumed.
300: The default is not to
1.17 schwarze 301: present a hyperlink.
1.33 schwarze 302: .It Cm style Ns = Ns Ar style.css
1.26 jmc 303: The file
304: .Ar style.css
305: is used for an external style-sheet.
306: This must be a valid absolute or
307: relative URI.
1.30 schwarze 308: .El
1.31 schwarze 309: .Ss PostScript Output
1.33 schwarze 310: PostScript
311: .Qq Adobe-3.0
312: Level-2 pages may be generated by
1.31 schwarze 313: .Fl T Ns Cm ps .
1.35 schwarze 314: Output pages default to letter sized and are rendered in the Times font
315: family, 11-point.
316: Margins are calculated as 1/9 the page length and width.
317: Line-height is 1.4m.
1.34 schwarze 318: .Pp
319: Special characters are rendered as in
320: .Sx ASCII Output .
321: .Pp
322: The following
323: .Fl O
324: arguments are accepted:
325: .Bl -tag -width Ds
326: .It Cm paper Ns = Ns Ar name
327: The paper size
328: .Ar name
329: may be one of
1.35 schwarze 330: .Ar a3 ,
331: .Ar a4 ,
332: .Ar a5 ,
333: .Ar legal ,
1.34 schwarze 334: or
335: .Ar letter .
1.35 schwarze 336: You may also manually specify dimensions as
337: .Ar NNxNN ,
338: width by height in millimetres.
339: If an unknown value is encountered,
340: .Ar letter
341: is used.
1.34 schwarze 342: .El
1.36 schwarze 343: .Ss PDF Output
344: PDF-1.1 output may be generated by
345: .Fl T Ns Cm pdf .
346: See
347: .Sx PostScript Output
348: for
349: .Fl O
350: arguments and defaults.
1.21 schwarze 351: .Ss XHTML Output
352: Output produced by
1.26 jmc 353: .Fl T Ns Cm xhtml
1.21 schwarze 354: conforms to XHTML-1.0 strict.
355: .Pp
356: See
357: .Sx HTML Output
358: for details; beyond generating XHTML tags instead of HTML tags, these
359: output modes are identical.
1.38 schwarze 360: .Sh EXIT STATUS
361: The
362: .Nm
363: utility exits with one of the following values, controlled by the message
364: .Ar level
365: associated with the
366: .Fl W
367: option:
368: .Pp
369: .Bl -tag -width Ds -compact
370: .It 0
371: No warnings or errors occurred, or those that did were ignored because
372: they were lower than the requested
373: .Ar level .
374: .It 2
375: At least one warning occurred, but no error, and
376: .Fl W Ns Cm warning
377: was specified.
378: .It 3
379: At least one parsing error occurred, but no fatal error, and
380: .Fl W Ns Cm error
381: or
382: .Fl W Ns Cm warning
383: was specified.
384: .It 4
385: A fatal parsing error occurred.
386: .It 5
387: Invalid command line arguments were specified.
388: No input files have been read.
389: .It 6
390: An operating system error occurred, for example memory exhaustion or an
391: error accessing input files.
392: Such errors cause
393: .Nm
394: to exit at once, possibly in the middle of parsing or formatting a file.
395: .El
396: .Pp
397: Note that selecting
398: .Fl T Ns Cm lint
399: output mode implies
400: .Fl W Ns Cm warning .
1.1 kristaps 401: .Sh EXAMPLES
402: To page manuals to the terminal:
403: .Pp
1.42 schwarze 404: .Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less
405: .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
1.12 schwarze 406: .Pp
1.17 schwarze 407: To produce HTML manuals with
408: .Ar style.css
409: as the style-sheet:
410: .Pp
1.42 schwarze 411: .Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html
1.17 schwarze 412: .Pp
1.12 schwarze 413: To check over a large set of manuals:
414: .Pp
1.38 schwarze 415: .Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`
1.34 schwarze 416: .Pp
417: To produce a series of PostScript manuals for A4 paper:
418: .Pp
1.42 schwarze 419: .Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps
1.38 schwarze 420: .Sh DIAGNOSTICS
421: Standard error messages reporting parsing errors are prefixed by
422: .Pp
423: .Sm off
424: .D1 Ar file : line : column : \ level :
425: .Sm on
426: .Pp
427: where the fields have the following meanings:
428: .Bl -tag -width "column"
429: .It Ar file
430: The name of the input file causing the message.
431: .It Ar line
432: The line number in that input file.
433: Line numbering starts at 1.
434: .It Ar column
435: The column number in that input file.
436: Column numbering starts at 1.
437: If the issue is caused by a word, the column number usually
438: points to the first character of the word.
439: .It Ar level
440: The message level, printed in capital letters.
441: .El
442: .Pp
443: Message levels have the following meanings:
444: .Bl -tag -width "warning"
445: .It Cm fatal
446: The parser is unable to parse a given input file at all.
447: No formatted output is produced from that input file.
448: .It Cm error
449: An input file contains syntax that cannot be safely interpreted,
450: either because it is invalid or because
451: .Nm
452: does not implement it yet.
453: By discarding part of the input or inserting missing tokens,
454: the parser is able to continue, and the error does not prevent
455: generation of formatted output, but typically, preparing that
456: output involves information loss, broken document structure
457: or unintended formatting.
458: .It Cm warning
459: An input file uses obsolete, discouraged or non-portable syntax.
460: All the same, the meaning of the input is unambiguous and a correct
461: rendering can be produced.
462: Documents causing warnings may render poorly when using other
463: formatting tools instead of
464: .Nm .
465: .El
466: .Pp
467: Messages of the
468: .Cm warning
469: and
470: .Cm error
471: levels are hidden unless their level, or a lower level, is requested using a
472: .Fl W
473: option or
474: .Fl T Ns Cm lint
475: output mode.
476: .Pp
477: The
478: .Nm
479: utility may also print messages related to invalid command line arguments
480: or operating system errors, for example when memory is exhausted or
1.40 jmc 481: input files cannot be read.
482: Such messages do not carry the prefix described above.
1.6 schwarze 483: .Sh COMPATIBILITY
1.10 schwarze 484: This section summarises
1.6 schwarze 485: .Nm
1.39 schwarze 486: compatibility with GNU troff.
1.14 schwarze 487: Each input and output format is separately noted.
1.20 schwarze 488: .Ss ASCII Compatibility
1.6 schwarze 489: .Bl -bullet -compact
1.13 schwarze 490: .It
1.44 schwarze 491: Unrenderable unicode codepoints specified with
492: .Sq \e[uNNNN]
493: escapes are printed as
494: .Sq \&?
495: in mandoc.
496: In GNU troff, these raise an error.
497: .It
1.21 schwarze 498: The
1.14 schwarze 499: .Sq \&Bd \-literal
1.21 schwarze 500: and
1.14 schwarze 501: .Sq \&Bd \-unfilled
502: macros of
503: .Xr mdoc 7
504: in
1.26 jmc 505: .Fl T Ns Cm ascii
1.14 schwarze 506: are synonyms, as are \-filled and \-ragged.
507: .It
1.44 schwarze 508: In historic GNU troff, the
1.14 schwarze 509: .Sq \&Pa
510: .Xr mdoc 7
511: macro does not underline when scoped under an
512: .Sq \&It
1.25 jmc 513: in the FILES section.
514: This behaves correctly in
1.14 schwarze 515: .Nm .
1.10 schwarze 516: .It
1.26 jmc 517: A list or display following the
1.11 schwarze 518: .Sq \&Ss
1.14 schwarze 519: .Xr mdoc 7
520: macro in
1.26 jmc 521: .Fl T Ns Cm ascii
1.6 schwarze 522: does not assert a prior vertical break, just as it doesn't with
1.11 schwarze 523: .Sq \&Sh .
1.6 schwarze 524: .It
1.14 schwarze 525: The
526: .Sq \&na
527: .Xr man 7
1.16 schwarze 528: macro in
1.26 jmc 529: .Fl T Ns Cm ascii
1.16 schwarze 530: has no effect.
1.6 schwarze 531: .It
532: Words aren't hyphenated.
533: .El
1.21 schwarze 534: .Ss HTML/XHTML Compatibility
1.17 schwarze 535: .Bl -bullet -compact
536: .It
537: The
1.20 schwarze 538: .Sq \efP
539: escape will revert the font to the previous
540: .Sq \ef
541: escape, not to the last rendered decoration, which is now dictated by
1.25 jmc 542: CSS instead of hard-coded.
543: It also will not span past the current scope,
544: for the same reason.
545: Note that in
1.20 schwarze 546: .Sx ASCII Output
547: mode, this will work fine.
548: .It
549: The
1.17 schwarze 550: .Xr mdoc 7
551: .Sq \&Bl \-hang
552: and
553: .Sq \&Bl \-tag
554: list types render similarly (no break following overreached left-hand
555: side) due to the expressive constraints of HTML.
556: .It
557: The
558: .Xr man 7
559: .Sq IP
560: and
561: .Sq TP
562: lists render similarly.
563: .El
1.1 kristaps 564: .Sh SEE ALSO
1.25 jmc 565: .Xr man 7 ,
1.1 kristaps 566: .Xr mandoc_char 7 ,
1.43 schwarze 567: .Xr mdoc 7 ,
568: .Xr roff 7 ,
569: .Xr tbl 7
1.1 kristaps 570: .Sh AUTHORS
571: The
572: .Nm
1.10 schwarze 573: utility was written by
1.29 schwarze 574: .An Kristaps Dzonsons Aq kristaps@bsd.lv .
1.17 schwarze 575: .Sh CAVEATS
576: In
1.26 jmc 577: .Fl T Ns Cm html
1.21 schwarze 578: and
1.26 jmc 579: .Fl T Ns Cm xhtml ,
1.17 schwarze 580: the maximum size of an element attribute is determined by
581: .Dv BUFSIZ ,
1.25 jmc 582: which is usually 1024 bytes.
583: Be aware of this when setting long link
1.26 jmc 584: formats such as
585: .Fl O Ns Cm style Ns = Ns Ar really/long/link .
1.22 schwarze 586: .Pp
587: Nesting elements within next-line element scopes of
1.26 jmc 588: .Fl m Ns Cm an ,
1.22 schwarze 589: such as
590: .Sq br
591: within an empty
592: .Sq B ,
593: will confuse
1.26 jmc 594: .Fl T Ns Cm html
1.22 schwarze 595: and
1.26 jmc 596: .Fl T Ns Cm xhtml
1.23 schwarze 597: and cause them to forget the formatting of the prior next-line scope.
598: .Pp
1.24 schwarze 599: The
600: .Sq \(aq
601: control character is an alias for the standard macro control character
602: 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