Annotation of src/usr.bin/mandoc/mandoc.1, Revision 1.101
1.101 ! schwarze 1: .\" $OpenBSD: mandoc.1,v 1.100 2017/03/04 17:17:17 schwarze Exp $
1.1 kristaps 2: .\"
1.44 schwarze 3: .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.92 schwarze 4: .\" Copyright (c) 2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: .\"
6: .\" Permission to use, copy, modify, and distribute this software for any
1.3 schwarze 7: .\" purpose with or without fee is hereby granted, provided that the above
8: .\" copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: .\"
1.3 schwarze 10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 17: .\"
1.101 ! schwarze 18: .Dd $Mdocdate: March 4 2017 $
1.2 deraadt 19: .Dt MANDOC 1
1.1 kristaps 20: .Os
21: .Sh NAME
22: .Nm mandoc
23: .Nd format and display UNIX manuals
24: .Sh SYNOPSIS
25: .Nm mandoc
1.77 schwarze 26: .Op Fl acfhkl
1.80 schwarze 27: .Op Fl I Cm os Ns = Ns Ar name
28: .Op Fl K Ar encoding
1.1 kristaps 29: .Op Fl m Ns Ar format
1.80 schwarze 30: .Op Fl O Ar option
31: .Op Fl T Ar output
32: .Op Fl W Ar level
1.45 schwarze 33: .Op Ar
1.1 kristaps 34: .Sh DESCRIPTION
35: The
36: .Nm
1.10 schwarze 37: utility formats
1.1 kristaps 38: .Ux
1.25 jmc 39: manual pages for display.
1.53 schwarze 40: .Pp
41: By default,
42: .Nm
43: reads
44: .Xr mdoc 7
45: or
46: .Xr man 7
47: text from stdin, implying
48: .Fl m Ns Cm andoc ,
49: and produces
1.80 schwarze 50: .Fl T Cm locale
1.53 schwarze 51: output.
52: .Pp
1.61 schwarze 53: The options are as follows:
1.5 schwarze 54: .Bl -tag -width Ds
1.60 schwarze 55: .It Fl a
56: If the standard output is a terminal device and
57: .Fl c
58: is not specified, use
59: .Xr more 1
60: to paginate the output, just like
61: .Xr man 1
62: would.
63: .It Fl c
64: Copy the formatted manual pages to the standard output without using
65: .Xr more 1
66: to paginate them.
67: This is the default.
68: It can be specified to override
69: .Fl a .
1.61 schwarze 70: .It Fl f
71: A synonym for
72: .Xr whatis 1 .
73: This overrides any earlier
74: .Fl k
75: and
76: .Fl l
77: options.
1.91 schwarze 78: .It Fl h
79: Display only the SYNOPSIS lines.
80: Implies
81: .Fl c .
1.80 schwarze 82: .It Fl I Cm os Ns = Ns Ar name
1.54 schwarze 83: Override the default operating system
84: .Ar name
85: for the
86: .Xr mdoc 7
87: .Sq \&Os
1.70 schwarze 88: and for the
89: .Xr man 7
90: .Sq \&TH
1.54 schwarze 91: macro.
1.80 schwarze 92: .It Fl K Ar encoding
1.64 schwarze 93: Specify the input encoding.
94: The supported
95: .Ar encoding
96: arguments are
97: .Cm us-ascii ,
98: .Cm iso-8859-1 ,
99: and
100: .Cm utf-8 .
1.100 schwarze 101: If not specified, autodetection uses the first match in the following
102: list:
103: .Bl -enum
104: .It
105: If the first three bytes of the input file are the UTF-8 byte order
106: mark (BOM, 0xefbbbf), input is interpreted as
107: .Cm utf-8 .
108: .It
109: If the first or second line of the input file matches the
1.64 schwarze 110: .Sy emacs
111: mode line format
112: .Pp
113: .D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-
1.100 schwarze 114: .Pp
115: then input is interpreted according to
116: .Ar encoding .
117: .It
118: If the first non-ASCII byte in the file introduces a valid UTF-8
119: sequence, input is interpreted as
120: .Cm utf-8 .
121: .It
122: Otherwise, input is interpreted as
123: .Cm iso-8859-1 .
1.64 schwarze 124: .El
1.61 schwarze 125: .It Fl k
126: A synonym for
127: .Xr apropos 1 .
128: This overrides any earlier
129: .Fl f
130: and
131: .Fl l
132: options.
133: .It Fl l
134: A synonym for
135: .Fl a .
136: Also reverts any earlier
137: .Fl f
138: and
139: .Fl k
140: options.
1.1 kristaps 141: .It Fl m Ns Ar format
1.25 jmc 142: Input format.
143: See
1.1 kristaps 144: .Sx Input Formats
1.25 jmc 145: for available formats.
146: Defaults to
1.26 jmc 147: .Fl m Ns Cm andoc .
1.80 schwarze 148: .It Fl O Ar option
1.25 jmc 149: Comma-separated output options.
1.80 schwarze 150: .It Fl T Ar output
1.25 jmc 151: Output format.
152: See
1.1 kristaps 153: .Sx Output Formats
1.25 jmc 154: for available formats.
155: Defaults to
1.80 schwarze 156: .Fl T Cm locale .
157: .It Fl W Ar level
1.38 schwarze 158: Specify the minimum message
159: .Ar level
160: to be reported on the standard error output and to affect the exit status.
161: The
162: .Ar level
163: can be
1.73 schwarze 164: .Cm warning ,
165: .Cm error ,
1.38 schwarze 166: or
1.73 schwarze 167: .Cm unsupp ;
1.72 schwarze 168: .Cm all
1.38 schwarze 169: is an alias for
1.72 schwarze 170: .Cm warning .
171: By default,
172: .Nm
173: is silent.
1.38 schwarze 174: See
175: .Sx EXIT STATUS
176: and
177: .Sx DIAGNOSTICS
178: for details.
179: .Pp
180: The special option
1.80 schwarze 181: .Fl W Cm stop
1.38 schwarze 182: tells
183: .Nm
184: to exit after parsing a file that causes warnings or errors of at least
185: the requested level.
186: No formatted output will be produced from that file.
187: If both a
188: .Ar level
189: and
190: .Cm stop
191: are requested, they can be joined with a comma, for example
1.80 schwarze 192: .Fl W Cm error , Ns Cm stop .
1.26 jmc 193: .It Ar file
194: Read input from zero or more files.
1.25 jmc 195: If unspecified, reads from stdin.
196: If multiple files are specified,
1.1 kristaps 197: .Nm
198: will halt with the first failed parse.
199: .El
1.61 schwarze 200: .Pp
201: In
202: .Fl f
203: and
204: .Fl k
205: mode,
206: .Nm
207: also supports the options
208: .Fl CMmOSsw
209: described in the
210: .Xr apropos 1
211: manual.
1.1 kristaps 212: .Ss Input Formats
213: The
214: .Nm
215: utility accepts
216: .Xr mdoc 7
217: and
218: .Xr man 7
219: input with
1.26 jmc 220: .Fl m Ns Cm doc
1.1 kristaps 221: and
1.26 jmc 222: .Fl m Ns Cm an ,
1.25 jmc 223: respectively.
224: The
1.1 kristaps 225: .Xr mdoc 7
226: format is
227: .Em strongly
1.10 schwarze 228: recommended;
1.1 kristaps 229: .Xr man 7
230: should only be used for legacy manuals.
231: .Pp
232: A third option,
1.26 jmc 233: .Fl m Ns Cm andoc ,
1.1 kristaps 234: which is also the default, determines encoding on-the-fly: if the first
1.10 schwarze 235: non-comment macro is
1.11 schwarze 236: .Sq \&Dd
1.1 kristaps 237: or
1.11 schwarze 238: .Sq \&Dt ,
1.10 schwarze 239: the
1.1 kristaps 240: .Xr mdoc 7
241: parser is used; otherwise, the
242: .Xr man 7
243: parser is used.
244: .Pp
245: If multiple
1.10 schwarze 246: files are specified with
1.26 jmc 247: .Fl m Ns Cm andoc ,
1.25 jmc 248: each has its file-type determined this way.
249: If multiple files are
1.1 kristaps 250: specified and
1.26 jmc 251: .Fl m Ns Cm doc
1.1 kristaps 252: or
1.26 jmc 253: .Fl m Ns Cm an
1.1 kristaps 254: is specified, then this format is used exclusively.
255: .Ss Output Formats
256: The
257: .Nm
258: utility accepts the following
259: .Fl T
1.34 schwarze 260: arguments, which correspond to output modes:
1.99 schwarze 261: .Bl -tag -width "-T markdown"
1.80 schwarze 262: .It Fl T Cm ascii
1.42 schwarze 263: Produce 7-bit ASCII output.
1.25 jmc 264: See
1.20 schwarze 265: .Sx ASCII Output .
1.80 schwarze 266: .It Fl T Cm html
1.69 schwarze 267: Produce HTML5, CSS1, and MathML output.
1.25 jmc 268: See
1.20 schwarze 269: .Sx HTML Output .
1.80 schwarze 270: .It Fl T Cm lint
1.26 jmc 271: Parse only: produce no output.
272: Implies
1.80 schwarze 273: .Fl W Cm warning .
274: .It Fl T Cm locale
1.48 jmc 275: Encode output using the current locale.
1.68 schwarze 276: This is the default.
1.48 jmc 277: See
278: .Sx Locale Output .
1.80 schwarze 279: .It Fl T Cm man
1.49 schwarze 280: Produce
1.46 schwarze 281: .Xr man 7
1.49 schwarze 282: format output.
283: See
284: .Sx Man Output .
1.99 schwarze 285: .It Fl T Cm markdown
286: Produce output in
287: .Sy markdown
288: format.
289: See
290: .Sx Markdown Output .
1.80 schwarze 291: .It Fl T Cm pdf
1.36 schwarze 292: Produce PDF output.
293: See
294: .Sx PDF Output .
1.80 schwarze 295: .It Fl T Cm ps
1.31 schwarze 296: Produce PostScript output.
297: See
298: .Sx PostScript Output .
1.80 schwarze 299: .It Fl T Cm tree
1.26 jmc 300: Produce an indented parse tree.
1.85 schwarze 301: See
302: .Sx Syntax tree output .
1.80 schwarze 303: .It Fl T Cm utf8
1.48 jmc 304: Encode output in the UTF\-8 multi-byte format.
305: See
306: .Sx UTF\-8 Output .
1.80 schwarze 307: .It Fl T Cm xhtml
1.63 schwarze 308: This is a synonym for
1.80 schwarze 309: .Fl T Cm html .
1.1 kristaps 310: .El
311: .Pp
312: If multiple input files are specified, these will be processed by the
313: corresponding filter in-order.
1.34 schwarze 314: .Ss ASCII Output
315: Output produced by
1.80 schwarze 316: .Fl T Cm ascii
1.68 schwarze 317: is rendered in standard 7-bit ASCII documented in
1.34 schwarze 318: .Xr ascii 7 .
319: .Pp
320: Font styles are applied by using back-spaced encoding such that an
321: underlined character
322: .Sq c
323: is rendered as
324: .Sq _ Ns \e[bs] Ns c ,
325: where
326: .Sq \e[bs]
327: is the back-space character number 8.
328: Emboldened characters are rendered as
329: .Sq c Ns \e[bs] Ns c .
330: .Pp
331: The special characters documented in
332: .Xr mandoc_char 7
333: are rendered best-effort in an ASCII equivalent.
334: .Pp
335: Output width is limited to 78 visible columns unless literal input lines
336: exceed this limit.
337: .Pp
338: The following
339: .Fl O
340: arguments are accepted:
1.5 schwarze 341: .Bl -tag -width Ds
1.51 schwarze 342: .It Cm indent Ns = Ns Ar indent
343: The left margin for normal text is set to
344: .Ar indent
345: blank characters instead of the default of five for
346: .Xr mdoc 7
347: and seven for
348: .Xr man 7 .
349: Increasing this is not recommended; it may result in degraded formatting,
1.52 jmc 350: for example overfull lines or ugly line breaks.
1.34 schwarze 351: .It Cm width Ns = Ns Ar width
352: The output width is set to
353: .Ar width ,
1.75 schwarze 354: which will normalise to \(>=58.
1.1 kristaps 355: .El
1.34 schwarze 356: .Ss HTML Output
357: Output produced by
1.80 schwarze 358: .Fl T Cm html
1.63 schwarze 359: conforms to HTML5 using optional self-closing tags.
1.69 schwarze 360: Default styles use only CSS1.
361: Equations rendered from
362: .Xr eqn 7
363: blocks use MathML.
1.34 schwarze 364: .Pp
1.30 schwarze 365: The
1.88 schwarze 366: .Pa mandoc.css
1.42 schwarze 367: file documents style-sheet classes available for customising output.
368: If a style-sheet is not specified with
1.80 schwarze 369: .Fl O Cm style ,
370: .Fl T Cm html
1.63 schwarze 371: defaults to simple output (via an embedded style-sheet)
372: readable in any graphical or text-based web
1.42 schwarze 373: browser.
1.34 schwarze 374: .Pp
1.45 schwarze 375: Special characters are rendered in decimal-encoded UTF\-8.
1.34 schwarze 376: .Pp
377: The following
1.33 schwarze 378: .Fl O
1.34 schwarze 379: arguments are accepted:
1.17 schwarze 380: .Bl -tag -width Ds
1.49 schwarze 381: .It Cm fragment
1.67 bentley 382: Omit the <!DOCTYPE> declaration and the <html>, <head>, and <body>
383: elements and only emit the subtree below the <body> element.
1.49 schwarze 384: The
385: .Cm style
1.50 schwarze 386: argument will be ignored.
1.49 schwarze 387: This is useful when embedding manual content within existing documents.
1.33 schwarze 388: .It Cm includes Ns = Ns Ar fmt
1.17 schwarze 389: The string
390: .Ar fmt ,
1.21 schwarze 391: for example,
1.17 schwarze 392: .Ar ../src/%I.html ,
393: is used as a template for linked header files (usually via the
394: .Sq \&In
1.25 jmc 395: macro).
396: Instances of
1.17 schwarze 397: .Sq \&%I
1.25 jmc 398: are replaced with the include filename.
399: The default is not to present a
1.17 schwarze 400: hyperlink.
1.33 schwarze 401: .It Cm man Ns = Ns Ar fmt
1.17 schwarze 402: The string
403: .Ar fmt ,
1.21 schwarze 404: for example,
1.17 schwarze 405: .Ar ../html%S/%N.%S.html ,
406: is used as a template for linked manuals (usually via the
407: .Sq \&Xr
1.25 jmc 408: macro).
409: Instances of
1.17 schwarze 410: .Sq \&%N
411: and
412: .Sq %S
413: are replaced with the linked manual's name and section, respectively.
1.25 jmc 414: If no section is included, section 1 is assumed.
415: The default is not to
1.17 schwarze 416: present a hyperlink.
1.33 schwarze 417: .It Cm style Ns = Ns Ar style.css
1.26 jmc 418: The file
419: .Ar style.css
420: is used for an external style-sheet.
421: This must be a valid absolute or
422: relative URI.
1.30 schwarze 423: .El
1.48 jmc 424: .Ss Locale Output
425: Locale-depending output encoding is triggered with
1.80 schwarze 426: .Fl T Cm locale .
1.68 schwarze 427: This is the default.
428: .Pp
1.48 jmc 429: This option is not available on all systems: systems without locale
430: support, or those whose internal representation is not natively UCS-4,
431: will fall back to
1.80 schwarze 432: .Fl T Cm ascii .
1.48 jmc 433: See
434: .Sx ASCII Output
435: for font style specification and available command-line arguments.
1.49 schwarze 436: .Ss Man Output
437: Translate input format into
438: .Xr man 7
439: output format.
1.55 jmc 440: This is useful for distributing manual sources to legacy systems
1.49 schwarze 441: lacking
442: .Xr mdoc 7
443: formatters.
444: .Pp
445: If
446: .Xr mdoc 7
447: is passed as input, it is translated into
1.50 schwarze 448: .Xr man 7 .
449: If the input format is
1.49 schwarze 450: .Xr man 7 ,
1.50 schwarze 451: the input is copied to the output, expanding any
1.49 schwarze 452: .Xr roff 7
453: .Sq so
1.50 schwarze 454: requests.
455: The parser is also run, and as usual, the
456: .Fl W
457: level controls which
458: .Sx DIAGNOSTICS
459: are displayed before copying the input to the output.
1.99 schwarze 460: .Ss Markdown Output
461: Translate
462: .Xr mdoc 7
463: input to the
464: .Sy markdown
465: format conforming to
466: .Lk http://daringfireball.net/projects/markdown/syntax.text\
467: "John Gruber's 2004 specification" .
468: .Pp
469: Markdown is a very weak markup language, so all semantic markup is
470: lost, and even part of the presentational markup may be lost.
471: Do not use this as an intermediate step in converting to HTML;
472: instead, use
473: .Fl T Cm html
474: directly.
475: .Pp
476: The
477: .Xr man 7 ,
478: .Xr tbl 7 ,
479: and
480: .Xr eqn 7
481: input languages are not supported by
482: .Fl T Cm markdown
483: output mode.
1.48 jmc 484: .Ss PDF Output
485: PDF-1.1 output may be generated by
1.80 schwarze 486: .Fl T Cm pdf .
1.48 jmc 487: See
488: .Sx PostScript Output
489: for
490: .Fl O
491: arguments and defaults.
1.31 schwarze 492: .Ss PostScript Output
1.33 schwarze 493: PostScript
494: .Qq Adobe-3.0
495: Level-2 pages may be generated by
1.80 schwarze 496: .Fl T Cm ps .
1.35 schwarze 497: Output pages default to letter sized and are rendered in the Times font
498: family, 11-point.
499: Margins are calculated as 1/9 the page length and width.
500: Line-height is 1.4m.
1.34 schwarze 501: .Pp
502: Special characters are rendered as in
503: .Sx ASCII Output .
504: .Pp
505: The following
506: .Fl O
507: arguments are accepted:
508: .Bl -tag -width Ds
509: .It Cm paper Ns = Ns Ar name
510: The paper size
511: .Ar name
512: may be one of
1.35 schwarze 513: .Ar a3 ,
514: .Ar a4 ,
515: .Ar a5 ,
516: .Ar legal ,
1.34 schwarze 517: or
518: .Ar letter .
1.35 schwarze 519: You may also manually specify dimensions as
520: .Ar NNxNN ,
521: width by height in millimetres.
522: If an unknown value is encountered,
523: .Ar letter
524: is used.
1.34 schwarze 525: .El
1.48 jmc 526: .Ss UTF\-8 Output
527: Use
1.80 schwarze 528: .Fl T Cm utf8
1.48 jmc 529: to force a UTF\-8 locale.
1.36 schwarze 530: See
1.48 jmc 531: .Sx Locale Output
532: for details and options.
1.85 schwarze 533: .Ss Syntax tree output
534: Use
535: .Fl T Cm tree
536: to show a human readable representation of the syntax tree.
537: It is useful for debugging the source code of manual pages.
1.86 jmc 538: The exact format is subject to change, so don't write parsers for it.
1.94 schwarze 539: .Pp
540: The first paragraph shows meta data found in the
541: .Xr mdoc 7
542: prologue, on the
543: .Xr man 7
544: .Ic \&TH
545: line, or the fallbacks used.
546: .Pp
547: In the tree dump, each output line shows one syntax tree node.
1.85 schwarze 548: Child nodes are indented with respect to their parent node.
549: The columns are:
550: .Pp
551: .Bl -enum -compact
552: .It
553: For macro nodes, the macro name; for text and
554: .Xr tbl 7
1.86 jmc 555: nodes, the content.
556: There is a special format for
1.85 schwarze 557: .Xr eqn 7
558: nodes.
559: .It
560: Node type (text, elem, block, head, body, body-end, tail, tbl, eqn).
561: .It
562: Flags:
563: .Bl -dash -compact
564: .It
565: An opening parenthesis if the node is an opening delimiter.
566: .It
567: An asterisk if the node starts a new input line.
568: .It
569: The input line number (starting at one).
570: .It
571: A colon.
572: .It
573: The input column number (starting at one).
574: .It
575: A closing parenthesis if the node is a closing delimiter.
576: .It
577: A full stop if the node ends a sentence.
1.93 schwarze 578: .It
1.98 schwarze 579: BROKEN if the node is a block broken by another block.
580: .It
1.93 schwarze 581: NOSRC if the node is not in the input file,
582: but automatically generated from macros.
583: .It
584: NOPRT if the node is not supposed to generate output
585: for any output format.
1.85 schwarze 586: .El
1.98 schwarze 587: .El
588: .Pp
589: The following
590: .Fl O
591: argument is accepted:
592: .Bl -tag -width Ds
593: .It Cm noval
594: Skip validation and show the unvalidated syntax tree.
595: This can help to find out whether a given behaviour is caused by
596: the parser or by the validator.
597: Meta data is not available in this case.
1.85 schwarze 598: .El
1.60 schwarze 599: .Sh ENVIRONMENT
600: .Bl -tag -width MANPAGER
601: .It Ev MANPAGER
602: Any non-empty value of the environment variable
603: .Ev MANPAGER
604: will be used instead of the standard pagination program,
605: .Xr more 1 .
606: .It Ev PAGER
607: Specifies the pagination program to use when
608: .Ev MANPAGER
609: is not defined.
610: If neither PAGER nor MANPAGER is defined,
1.83 schwarze 611: .Xr more 1
612: .Fl s
1.60 schwarze 613: will be used.
614: .El
1.38 schwarze 615: .Sh EXIT STATUS
616: The
617: .Nm
618: utility exits with one of the following values, controlled by the message
619: .Ar level
620: associated with the
621: .Fl W
622: option:
623: .Pp
624: .Bl -tag -width Ds -compact
625: .It 0
626: No warnings or errors occurred, or those that did were ignored because
627: they were lower than the requested
628: .Ar level .
629: .It 2
630: At least one warning occurred, but no error, and
1.80 schwarze 631: .Fl W Cm warning
1.38 schwarze 632: was specified.
633: .It 3
1.73 schwarze 634: At least one parsing error occurred,
635: but no unsupported feature was encountered, and
1.80 schwarze 636: .Fl W Cm error
1.73 schwarze 637: or
1.80 schwarze 638: .Fl W Cm warning
1.73 schwarze 639: was specified.
640: .It 4
1.74 jmc 641: At least one unsupported feature was encountered, and
1.80 schwarze 642: .Fl W Cm unsupp ,
643: .Fl W Cm error
1.38 schwarze 644: or
1.80 schwarze 645: .Fl W Cm warning
1.38 schwarze 646: was specified.
647: .It 5
648: Invalid command line arguments were specified.
649: No input files have been read.
650: .It 6
1.71 schwarze 651: An operating system error occurred, for example exhaustion
652: of memory, file descriptors, or process table entries.
1.38 schwarze 653: Such errors cause
654: .Nm
655: to exit at once, possibly in the middle of parsing or formatting a file.
656: .El
657: .Pp
658: Note that selecting
1.80 schwarze 659: .Fl T Cm lint
1.38 schwarze 660: output mode implies
1.80 schwarze 661: .Fl W Cm warning .
1.1 kristaps 662: .Sh EXAMPLES
663: To page manuals to the terminal:
664: .Pp
1.80 schwarze 665: .Dl $ mandoc \-W all,stop mandoc.1 2\*(Gt&1 | less
1.42 schwarze 666: .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
1.12 schwarze 667: .Pp
1.17 schwarze 668: To produce HTML manuals with
1.88 schwarze 669: .Pa mandoc.css
1.17 schwarze 670: as the style-sheet:
671: .Pp
1.88 schwarze 672: .Dl $ mandoc \-T html -O style=mandoc.css mdoc.7 \*(Gt mdoc.7.html
1.17 schwarze 673: .Pp
1.12 schwarze 674: To check over a large set of manuals:
675: .Pp
1.82 bentley 676: .Dl $ mandoc \-T lint \(gafind /usr/src -name \e*\e.[1-9]\(ga
1.34 schwarze 677: .Pp
678: To produce a series of PostScript manuals for A4 paper:
679: .Pp
1.80 schwarze 680: .Dl $ mandoc \-T ps \-O paper=a4 mdoc.7 man.7 \*(Gt manuals.ps
1.46 schwarze 681: .Pp
682: Convert a modern
683: .Xr mdoc 7
684: manual to the older
685: .Xr man 7
686: format, for use on systems lacking an
687: .Xr mdoc 7
688: parser:
689: .Pp
1.80 schwarze 690: .Dl $ mandoc \-T man foo.mdoc \*(Gt foo.man
1.38 schwarze 691: .Sh DIAGNOSTICS
1.59 schwarze 692: Messages displayed by
693: .Nm
694: follow this format:
1.38 schwarze 695: .Pp
1.59 schwarze 696: .D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args
1.38 schwarze 697: .Pp
1.59 schwarze 698: Line and column numbers start at 1.
699: Both are omitted for messages referring to an input file as a whole.
700: Macro names and arguments are omitted where meaningless.
701: Fatal messages about invalid command line arguments
702: or operating system errors, for example when memory is exhausted,
703: may also omit the
704: .Ar file
1.57 schwarze 705: and
1.59 schwarze 706: .Ar level
707: fields.
1.57 schwarze 708: .Pp
1.38 schwarze 709: Message levels have the following meanings:
710: .Bl -tag -width "warning"
1.73 schwarze 711: .It Cm unsupp
712: An input file uses unsupported low-level
713: .Xr roff 7
714: features.
715: The output may be incomplete and/or misformatted,
716: so using GNU troff instead of
717: .Nm
718: to process the file may be preferable.
1.38 schwarze 719: .It Cm error
1.73 schwarze 720: An input file contains invalid syntax that cannot be safely interpreted.
1.38 schwarze 721: By discarding part of the input or inserting missing tokens,
722: the parser is able to continue, and the error does not prevent
723: generation of formatted output, but typically, preparing that
724: output involves information loss, broken document structure
1.73 schwarze 725: or unintended formatting, no matter whether
726: .Nm
727: or GNU troff is used.
728: In many cases, the output of
729: .Nm
730: and GNU troff is identical, but in some,
731: .Nm
732: is more resilient than GNU troff with respect to malformed input.
1.71 schwarze 733: .Pp
734: Non-existent or unreadable input files are also reported on the
735: .Cm error
736: level.
737: In that case, the parser cannot even be started and no output
738: is produced from those input files.
1.38 schwarze 739: .It Cm warning
740: An input file uses obsolete, discouraged or non-portable syntax.
741: All the same, the meaning of the input is unambiguous and a correct
742: rendering can be produced.
743: Documents causing warnings may render poorly when using other
744: formatting tools instead of
745: .Nm .
746: .El
747: .Pp
748: Messages of the
1.73 schwarze 749: .Cm warning ,
750: .Cm error ,
1.38 schwarze 751: and
1.73 schwarze 752: .Cm unsupp
1.71 schwarze 753: levels except those about non-existent or unreadable input files
754: are hidden unless their level, or a lower level, is requested using a
1.38 schwarze 755: .Fl W
756: option or
1.80 schwarze 757: .Fl T Cm lint
1.38 schwarze 758: output mode.
1.76 schwarze 759: .Ss Warnings related to the document prologue
760: .Bl -ohang
761: .It Sy "missing manual title, using UNTITLED"
762: .Pq mdoc
763: A
764: .Ic \&Dt
765: macro has no arguments, or there is no
766: .Ic \&Dt
767: macro before the first non-prologue macro.
768: .It Sy "missing manual title, using \(dq\(dq"
769: .Pq man
770: There is no
771: .Ic \&TH
772: macro, or it has no arguments.
773: .It Sy "lower case character in document title"
774: .Pq mdoc , man
775: The title is still used as given in the
776: .Ic \&Dt
777: or
778: .Ic \&TH
779: macro.
780: .It Sy "missing manual section, using \(dq\(dq"
781: .Pq mdoc , man
782: A
783: .Ic \&Dt
784: or
785: .Ic \&TH
786: macro lacks the mandatory section argument.
787: .It Sy "unknown manual section"
788: .Pq mdoc
789: The section number in a
790: .Ic \&Dt
791: line is invalid, but still used.
792: .It Sy "missing date, using today's date"
793: .Pq mdoc, man
794: The document was parsed as
795: .Xr mdoc 7
796: and it has no
797: .Ic \&Dd
798: macro, or the
799: .Ic \&Dd
800: macro has no arguments or only empty arguments;
801: or the document was parsed as
802: .Xr man 7
803: and it has no
804: .Ic \&TH
805: macro, or the
806: .Ic \&TH
807: macro has less than three arguments or its third argument is empty.
808: .It Sy "cannot parse date, using it verbatim"
809: .Pq mdoc , man
810: The date given in a
811: .Ic \&Dd
812: or
813: .Ic \&TH
814: macro does not follow the conventional format.
815: .It Sy "missing Os macro, using \(dq\(dq"
816: .Pq mdoc
817: The default or current system is not shown in this case.
818: .It Sy "duplicate prologue macro"
819: .Pq mdoc
820: One of the prologue macros occurs more than once.
821: The last instance overrides all previous ones.
822: .It Sy "late prologue macro"
823: .Pq mdoc
824: A
825: .Ic \&Dd
826: or
827: .Ic \&Os
828: macro occurs after some non-prologue macro, but still takes effect.
829: .It Sy "skipping late title macro"
830: .Pq mdoc
831: The
832: .Ic \&Dt
833: macro appears after the first non-prologue macro.
834: Traditional formatters cannot handle this because
835: they write the page header before parsing the document body.
836: Even though this technical restriction does not apply to
837: .Nm ,
838: traditional semantics is preserved.
839: The late macro is discarded including its arguments.
840: .It Sy "prologue macros out of order"
841: .Pq mdoc
842: The prologue macros are not given in the conventional order
843: .Ic \&Dd ,
844: .Ic \&Dt ,
845: .Ic \&Os .
846: All three macros are used even when given in another order.
847: .El
848: .Ss Warnings regarding document structure
849: .Bl -ohang
850: .It Sy ".so is fragile, better use ln(1)"
851: .Pq roff
852: Including files only works when the parser program runs with the correct
853: current working directory.
854: .It Sy "no document body"
855: .Pq mdoc , man
856: The document body contains neither text nor macros.
857: An empty document is shown, consisting only of a header and a footer line.
858: .It Sy "content before first section header"
859: .Pq mdoc , man
860: Some macros or text precede the first
861: .Ic \&Sh
862: or
863: .Ic \&SH
864: section header.
865: The offending macros and text are parsed and added to the top level
866: of the syntax tree, outside any section block.
867: .It Sy "first section is not NAME"
868: .Pq mdoc
869: The argument of the first
870: .Ic \&Sh
871: macro is not
872: .Sq NAME .
873: This may confuse
874: .Xr makewhatis 8
875: and
876: .Xr apropos 1 .
1.92 schwarze 877: .It Sy "NAME section without Nm before Nd"
1.76 schwarze 878: .Pq mdoc
1.79 schwarze 879: The NAME section does not contain any
880: .Ic \&Nm
1.92 schwarze 881: child macro before the first
882: .Ic \&Nd
883: macro.
1.79 schwarze 884: .It Sy "NAME section without description"
885: .Pq mdoc
886: The NAME section lacks the mandatory
887: .Ic \&Nd
888: child macro.
889: .It Sy "description not at the end of NAME"
890: .Pq mdoc
891: The NAME section does contain an
1.76 schwarze 892: .Ic \&Nd
1.79 schwarze 893: child macro, but other content follows it.
894: .It Sy "bad NAME section content"
895: .Pq mdoc
896: The NAME section contains plain text or macros other than
897: .Ic \&Nm
1.76 schwarze 898: and
1.79 schwarze 899: .Ic \&Nd .
1.92 schwarze 900: .It Sy "missing comma before name"
901: .Pq mdoc
902: The NAME section contains an
903: .Ic \&Nm
904: macro that is neither the first one nor preceded by a comma.
1.76 schwarze 905: .It Sy "missing description line, using \(dq\(dq"
906: .Pq mdoc
907: The
908: .Ic \&Nd
909: macro lacks the required argument.
910: The title line of the manual will end after the dash.
1.101 ! schwarze 911: .It Sy "description line outside NAME section"
! 912: .Pq mdoc
! 913: An
! 914: .Ic \&Nd
! 915: macro appears outside the NAME section.
! 916: The arguments are printed anyway and the following text is used for
! 917: .Xr apropos 1 ,
! 918: but none of that behaviour is portable.
1.76 schwarze 919: .It Sy "sections out of conventional order"
920: .Pq mdoc
921: A standard section occurs after another section it usually precedes.
922: All section titles are used as given,
923: and the order of sections is not changed.
924: .It Sy "duplicate section title"
925: .Pq mdoc
926: The same standard section title occurs more than once.
927: .It Sy "unexpected section"
928: .Pq mdoc
929: A standard section header occurs in a section of the manual
930: where it normally isn't useful.
931: .It Sy "unusual Xr order"
932: .Pq mdoc
933: In the SEE ALSO section, an
934: .Ic \&Xr
935: macro with a lower section number follows one with a higher number,
936: or two
937: .Ic \&Xr
1.81 jmc 938: macros referring to the same section are out of alphabetical order.
1.76 schwarze 939: .It Sy "unusual Xr punctuation"
940: .Pq mdoc
941: In the SEE ALSO section, punctuation between two
942: .Ic \&Xr
943: macros differs from a single comma, or there is trailing punctuation
944: after the last
945: .Ic \&Xr
946: macro.
947: .It Sy "AUTHORS section without An macro"
948: .Pq mdoc
949: An AUTHORS sections contains no
950: .Ic \&An
951: macros, or only empty ones.
952: Probably, there are author names lacking markup.
953: .El
954: .Ss "Warnings related to macros and nesting"
955: .Bl -ohang
956: .It Sy "obsolete macro"
957: .Pq mdoc
958: See the
959: .Xr mdoc 7
960: manual for replacements.
961: .It Sy "macro neither callable nor escaped"
962: .Pq mdoc
963: The name of a macro that is not callable appears on a macro line.
964: It is printed verbatim.
965: If the intention is to call it, move it to its own input line;
966: otherwise, escape it by prepending
967: .Sq \e& .
968: .It Sy "skipping paragraph macro"
969: In
970: .Xr mdoc 7
971: documents, this happens
972: .Bl -dash -compact
973: .It
974: at the beginning and end of sections and subsections
975: .It
976: right before non-compact lists and displays
977: .It
978: at the end of items in non-column, non-compact lists
979: .It
980: and for multiple consecutive paragraph macros.
981: .El
982: In
983: .Xr man 7
984: documents, it happens
985: .Bl -dash -compact
986: .It
987: for empty
988: .Ic \&P ,
989: .Ic \&PP ,
990: and
991: .Ic \&LP
992: macros
993: .It
994: for
995: .Ic \&IP
996: macros having neither head nor body arguments
997: .It
998: for
999: .Ic \&br
1000: or
1001: .Ic \&sp
1002: right after
1003: .Ic \&SH
1004: or
1005: .Ic \&SS
1006: .El
1007: .It Sy "moving paragraph macro out of list"
1008: .Pq mdoc
1009: A list item in a
1010: .Ic \&Bl
1011: list contains a trailing paragraph macro.
1012: The paragraph macro is moved after the end of the list.
1013: .It Sy "skipping no-space macro"
1014: .Pq mdoc
1015: An input line begins with an
1016: .Ic \&Ns
1017: macro.
1018: The macro is ignored.
1019: .It Sy "blocks badly nested"
1020: .Pq mdoc
1021: If two blocks intersect, one should completely contain the other.
1022: Otherwise, rendered output is likely to look strange in any output
1023: format, and rendering in SGML-based output formats is likely to be
1024: outright wrong because such languages do not support badly nested
1025: blocks at all.
1026: Typical examples of badly nested blocks are
1027: .Qq Ic \&Ao \&Bo \&Ac \&Bc
1028: and
1029: .Qq Ic \&Ao \&Bq \&Ac .
1030: In these examples,
1031: .Ic \&Ac
1032: breaks
1033: .Ic \&Bo
1034: and
1035: .Ic \&Bq ,
1036: respectively.
1037: .It Sy "nested displays are not portable"
1038: .Pq mdoc
1039: A
1040: .Ic \&Bd ,
1041: .Ic \&D1 ,
1042: or
1043: .Ic \&Dl
1044: display occurs nested inside another
1045: .Ic \&Bd
1046: display.
1047: This works with
1048: .Nm ,
1049: but fails with most other implementations.
1050: .It Sy "moving content out of list"
1051: .Pq mdoc
1052: A
1053: .Ic \&Bl
1054: list block contains text or macros before the first
1055: .Ic \&It
1056: macro.
1057: The offending children are moved before the beginning of the list.
1058: .It Sy "fill mode already enabled, skipping"
1059: .Pq man
1060: A
1061: .Ic \&fi
1062: request occurs even though the document is still in fill mode,
1063: or already switched back to fill mode.
1064: It has no effect.
1065: .It Sy "fill mode already disabled, skipping"
1066: .Pq man
1067: An
1068: .Ic \&nf
1069: request occurs even though the document already switched to no-fill mode
1070: and did not switch back to fill mode yet.
1071: It has no effect.
1072: .It Sy "line scope broken"
1073: .Pq man
1074: While parsing the next-line scope of the previous macro,
1075: another macro is found that prematurely terminates the previous one.
1076: The previous, interrupted macro is deleted from the parse tree.
1077: .El
1078: .Ss "Warnings related to missing arguments"
1079: .Bl -ohang
1080: .It Sy "skipping empty request"
1081: .Pq roff , eqn
1082: The macro name is missing from a macro definition request,
1083: or an
1084: .Xr eqn 7
1085: control statement or operation keyword lacks its required argument.
1086: .It Sy "conditional request controls empty scope"
1087: .Pq roff
1088: A conditional request is only useful if any of the following
1089: follows it on the same logical input line:
1090: .Bl -dash -compact
1091: .It
1092: The
1093: .Sq \e{
1094: keyword to open a multi-line scope.
1095: .It
1096: A request or macro or some text, resulting in a single-line scope.
1097: .It
1098: The immediate end of the logical line without any intervening whitespace,
1099: resulting in next-line scope.
1100: .El
1101: Here, a conditional request is followed by trailing whitespace only,
1102: and there is no other content on its logical input line.
1103: Note that it doesn't matter whether the logical input line is split
1104: across multiple physical input lines using
1105: .Sq \e
1106: line continuation characters.
1107: This is one of the rare cases
1108: where trailing whitespace is syntactically significant.
1109: The conditional request controls a scope containing whitespace only,
1110: so it is unlikely to have a significant effect,
1111: except that it may control a following
1112: .Ic \&el
1113: clause.
1114: .It Sy "skipping empty macro"
1115: .Pq mdoc
1116: The indicated macro has no arguments and hence no effect.
1117: .It Sy "empty block"
1118: .Pq mdoc , man
1119: A
1120: .Ic \&Bd ,
1121: .Ic \&Bk ,
1122: .Ic \&Bl ,
1123: .Ic \&D1 ,
1124: .Ic \&Dl ,
1125: .Ic \&RS ,
1126: or
1127: .Ic \&UR
1128: block contains nothing in its body and will produce no output.
1129: .It Sy "empty argument, using 0n"
1130: .Pq mdoc
1131: The required width is missing after
1132: .Ic \&Bd
1133: or
1134: .Ic \&Bl
1135: .Fl offset
1136: or
1137: .Fl width.
1138: .It Sy "missing display type, using -ragged"
1139: .Pq mdoc
1140: The
1141: .Ic \&Bd
1142: macro is invoked without the required display type.
1143: .It Sy "list type is not the first argument"
1144: .Pq mdoc
1145: In a
1146: .Ic \&Bl
1147: macro, at least one other argument precedes the type argument.
1148: The
1149: .Nm
1150: utility copes with any argument order, but some other
1151: .Xr mdoc 7
1152: implementations do not.
1153: .It Sy "missing -width in -tag list, using 8n"
1154: .Pq mdoc
1155: Every
1156: .Ic \&Bl
1157: macro having the
1158: .Fl tag
1159: argument requires
1160: .Fl width ,
1161: too.
1162: .It Sy "missing utility name, using \(dq\(dq"
1163: .Pq mdoc
1164: The
1165: .Ic \&Ex Fl std
1166: macro is called without an argument before
1167: .Ic \&Nm
1168: has first been called with an argument.
1169: .It Sy "missing function name, using \(dq\(dq"
1170: .Pq mdoc
1171: The
1172: .Ic \&Fo
1173: macro is called without an argument.
1174: No function name is printed.
1175: .It Sy "empty head in list item"
1176: .Pq mdoc
1177: In a
1178: .Ic \&Bl
1179: .Fl diag ,
1180: .Fl hang ,
1181: .Fl inset ,
1182: .Fl ohang ,
1183: or
1184: .Fl tag
1185: list, an
1186: .Ic \&It
1187: macro lacks the required argument.
1188: The item head is left empty.
1189: .It Sy "empty list item"
1190: .Pq mdoc
1191: In a
1192: .Ic \&Bl
1193: .Fl bullet ,
1194: .Fl dash ,
1195: .Fl enum ,
1196: or
1197: .Fl hyphen
1198: list, an
1199: .Ic \&It
1200: block is empty.
1201: An empty list item is shown.
1202: .It Sy "missing font type, using \efR"
1203: .Pq mdoc
1204: A
1205: .Ic \&Bf
1206: macro has no argument.
1207: It switches to the default font.
1208: .It Sy "unknown font type, using \efR"
1209: .Pq mdoc
1210: The
1211: .Ic \&Bf
1212: argument is invalid.
1213: The default font is used instead.
1214: .It Sy "nothing follows prefix"
1215: .Pq mdoc
1216: A
1217: .Ic \&Pf
1218: macro has no argument, or only one argument and no macro follows
1219: on the same input line.
1220: This defeats its purpose; in particular, spacing is not suppressed
1221: before the text or macros following on the next input line.
1222: .It Sy "empty reference block"
1223: .Pq mdoc
1224: An
1225: .Ic \&Rs
1226: macro is immediately followed by an
1227: .Ic \&Re
1228: macro on the next input line.
1229: Such an empty block does not produce any output.
1.89 schwarze 1230: .It Sy "missing section argument"
1231: .Pq mdoc
1232: An
1233: .Ic \&Xr
1234: macro lacks its second, section number argument.
1235: The first argument, i.e. the name, is printed, but without subsequent
1.90 jmc 1236: parentheses.
1.76 schwarze 1237: .It Sy "missing -std argument, adding it"
1238: .Pq mdoc
1239: An
1240: .Ic \&Ex
1241: or
1242: .Ic \&Rv
1243: macro lacks the required
1244: .Fl std
1245: argument.
1246: The
1247: .Nm
1248: utility assumes
1249: .Fl std
1250: even when it is not specified, but other implementations may not.
1251: .It Sy "missing option string, using \(dq\(dq"
1252: .Pq man
1253: The
1254: .Ic \&OP
1255: macro is invoked without any argument.
1256: An empty pair of square brackets is shown.
1257: .It Sy "missing resource identifier, using \(dq\(dq"
1258: .Pq man
1259: The
1260: .Ic \&UR
1261: macro is invoked without any argument.
1262: An empty pair of angle brackets is shown.
1263: .It Sy "missing eqn box, using \(dq\(dq"
1264: .Pq eqn
1265: A diacritic mark or a binary operator is found,
1266: but there is nothing to the left of it.
1267: An empty box is inserted.
1268: .El
1269: .Ss "Warnings related to bad macro arguments"
1270: .Bl -ohang
1271: .It Sy "unterminated quoted argument"
1272: .Pq roff
1273: Macro arguments can be enclosed in double quote characters
1274: such that space characters and macro names contained in the quoted
1275: argument need not be escaped.
1276: The closing quote of the last argument of a macro can be omitted.
1277: However, omitting it is not recommended because it makes the code
1278: harder to read.
1279: .It Sy "duplicate argument"
1280: .Pq mdoc
1281: A
1282: .Ic \&Bd
1283: or
1284: .Ic \&Bl
1285: macro has more than one
1286: .Fl compact ,
1287: more than one
1288: .Fl offset ,
1289: or more than one
1290: .Fl width
1291: argument.
1292: All but the last instances of these arguments are ignored.
1293: .It Sy "skipping duplicate argument"
1294: .Pq mdoc
1295: An
1296: .Ic \&An
1297: macro has more than one
1298: .Fl split
1299: or
1300: .Fl nosplit
1301: argument.
1302: All but the first of these arguments are ignored.
1303: .It Sy "skipping duplicate display type"
1304: .Pq mdoc
1305: A
1306: .Ic \&Bd
1307: macro has more than one type argument; the first one is used.
1308: .It Sy "skipping duplicate list type"
1309: .Pq mdoc
1310: A
1311: .Ic \&Bl
1312: macro has more than one type argument; the first one is used.
1313: .It Sy "skipping -width argument"
1314: .Pq mdoc
1315: A
1316: .Ic \&Bl
1317: .Fl column ,
1318: .Fl diag ,
1319: .Fl ohang ,
1320: .Fl inset ,
1321: or
1322: .Fl item
1323: list has a
1324: .Fl width
1325: argument.
1326: That has no effect.
1327: .It Sy "wrong number of cells"
1328: In a line of a
1329: .Ic \&Bl Fl column
1330: list, the number of tabs or
1331: .Ic \&Ta
1332: macros is less than the number expected from the list header line
1333: or exceeds the expected number by more than one.
1334: Missing cells remain empty, and all cells exceeding the number of
1335: columns are joined into one single cell.
1336: .It Sy "unknown AT&T UNIX version"
1337: .Pq mdoc
1338: An
1339: .Ic \&At
1340: macro has an invalid argument.
1341: It is used verbatim, with
1342: .Qq "AT&T UNIX "
1343: prefixed to it.
1344: .It Sy "comma in function argument"
1345: .Pq mdoc
1346: An argument of an
1347: .Ic \&Fa
1348: or
1349: .Ic \&Fn
1350: macro contains a comma; it should probably be split into two arguments.
1351: .It Sy "parenthesis in function name"
1352: .Pq mdoc
1353: The first argument of an
1354: .Ic \&Fc
1355: or
1356: .Ic \&Fn
1357: macro contains an opening or closing parenthesis; that's probably wrong,
1358: parentheses are added automatically.
1359: .It Sy "invalid content in Rs block"
1360: .Pq mdoc
1361: An
1362: .Ic \&Rs
1363: block contains plain text or non-% macros.
1364: The bogus content is left in the syntax tree.
1365: Formatting may be poor.
1366: .It Sy "invalid Boolean argument"
1367: .Pq mdoc
1368: An
1369: .Ic \&Sm
1370: macro has an argument other than
1371: .Cm on
1372: or
1373: .Cm off .
1374: The invalid argument is moved out of the macro, which leaves the macro
1375: empty, causing it to toggle the spacing mode.
1376: .It Sy "unknown font, skipping request"
1377: .Pq man , tbl
1378: A
1379: .Xr roff 7
1380: .Ic \&ft
1381: request or a
1382: .Xr tbl 7
1383: .Ic \&f
1384: layout modifier has an unknown
1385: .Ar font
1386: argument.
1387: .It Sy "odd number of characters in request"
1388: .Pq roff
1389: A
1390: .Ic \&tr
1391: request contains an odd number of characters.
1392: The last character is mapped to the blank character.
1393: .El
1394: .Ss "Warnings related to plain text"
1395: .Bl -ohang
1396: .It Sy "blank line in fill mode, using .sp"
1397: .Pq mdoc
1398: The meaning of blank input lines is only well-defined in non-fill mode:
1399: In fill mode, line breaks of text input lines are not supposed to be
1400: significant.
1401: However, for compatibility with groff, blank lines in fill mode
1402: are replaced with
1403: .Ic \&sp
1404: requests.
1405: .It Sy "tab in filled text"
1406: .Pq mdoc , man
1407: The meaning of tab characters is only well-defined in non-fill mode:
1408: In fill mode, whitespace is not supposed to be significant
1409: on text input lines.
1410: As an implementation dependent choice, tab characters on text lines
1411: are passed through to the formatters in any case.
1412: Given that the text before the tab character will be filled,
1413: it is hard to predict which tab stop position the tab will advance to.
1414: .It Sy "whitespace at end of input line"
1415: .Pq mdoc , man , roff
1416: Whitespace at the end of input lines is almost never semantically
1417: significant \(em but in the odd case where it might be, it is
1418: extremely confusing when reviewing and maintaining documents.
1.96 schwarze 1419: .It Sy "new sentence, new line"
1420: .Pq mdoc
1421: A new sentence starts in the middle of a text line.
1422: Start it on a new input line to help formatters produce correct spacing.
1.76 schwarze 1423: .It Sy "bad comment style"
1424: .Pq roff
1425: Comment lines start with a dot, a backslash, and a double-quote character.
1426: The
1427: .Nm
1428: utility treats the line as a comment line even without the backslash,
1429: but leaving out the backslash might not be portable.
1430: .It Sy "invalid escape sequence"
1431: .Pq roff
1432: An escape sequence has an invalid opening argument delimiter, lacks the
1433: closing argument delimiter, or the argument has too few characters.
1434: If the argument is incomplete,
1435: .Ic \e*
1436: and
1437: .Ic \en
1438: expand to an empty string,
1439: .Ic \eB
1440: to the digit
1441: .Sq 0 ,
1442: and
1443: .Ic \ew
1444: to the length of the incomplete argument.
1445: All other invalid escape sequences are ignored.
1446: .It Sy "undefined string, using \(dq\(dq"
1447: .Pq roff
1448: If a string is used without being defined before,
1449: its value is implicitly set to the empty string.
1450: However, defining strings explicitly before use
1451: keeps the code more readable.
1452: .El
1453: .Ss "Warnings related to tables"
1454: .Bl -ohang
1455: .It Sy "tbl line starts with span"
1456: .Pq tbl
1457: The first cell in a table layout line is a horizontal span
1458: .Pq Sq Cm s .
1459: Data provided for this cell is ignored, and nothing is printed in the cell.
1460: .It Sy "tbl column starts with span"
1461: .Pq tbl
1462: The first line of a table layout specification
1463: requests a vertical span
1464: .Pq Sq Cm ^ .
1465: Data provided for this cell is ignored, and nothing is printed in the cell.
1466: .It Sy "skipping vertical bar in tbl layout"
1467: .Pq tbl
1468: A table layout specification contains more than two consecutive vertical bars.
1469: A double bar is printed, all additional bars are discarded.
1470: .El
1471: .Ss "Errors related to tables"
1472: .Bl -ohang
1473: .It Sy "non-alphabetic character in tbl options"
1474: .Pq tbl
1475: The table options line contains a character other than a letter,
1476: blank, or comma where the beginning of an option name is expected.
1477: The character is ignored.
1478: .It Sy "skipping unknown tbl option"
1479: .Pq tbl
1480: The table options line contains a string of letters that does not
1481: match any known option name.
1482: The word is ignored.
1483: .It Sy "missing tbl option argument"
1484: .Pq tbl
1485: A table option that requires an argument is not followed by an
1486: opening parenthesis, or the opening parenthesis is immediately
1487: followed by a closing parenthesis.
1488: The option is ignored.
1489: .It Sy "wrong tbl option argument size"
1490: .Pq tbl
1491: A table option argument contains an invalid number of characters.
1492: Both the option and the argument are ignored.
1493: .It Sy "empty tbl layout"
1494: .Pq tbl
1495: A table layout specification is completely empty,
1496: specifying zero lines and zero columns.
1497: As a fallback, a single left-justified column is used.
1498: .It Sy "invalid character in tbl layout"
1499: .Pq tbl
1500: A table layout specification contains a character that can neither
1501: be interpreted as a layout key character nor as a layout modifier,
1502: or a modifier precedes the first key.
1503: The invalid character is discarded.
1504: .It Sy "unmatched parenthesis in tbl layout"
1505: .Pq tbl
1506: A table layout specification contains an opening parenthesis,
1507: but no matching closing parenthesis.
1508: The rest of the input line, starting from the parenthesis, has no effect.
1509: .It Sy "tbl without any data cells"
1510: .Pq tbl
1511: A table does not contain any data cells.
1512: It will probably produce no output.
1513: .It Sy "ignoring data in spanned tbl cell"
1514: .Pq tbl
1515: A table cell is marked as a horizontal span
1516: .Pq Sq Cm s
1517: or vertical span
1518: .Pq Sq Cm ^
1519: in the table layout, but it contains data.
1520: The data is ignored.
1521: .It Sy "ignoring extra tbl data cells"
1522: .Pq tbl
1523: A data line contains more cells than the corresponding layout line.
1524: The data in the extra cells is ignored.
1525: .It Sy "data block open at end of tbl"
1526: .Pq tbl
1527: A data block is opened with
1528: .Cm T{ ,
1529: but never closed with a matching
1530: .Cm T} .
1531: The remaining data lines of the table are all put into one cell,
1532: and any remaining cells stay empty.
1533: .El
1534: .Ss "Errors related to roff, mdoc, and man code"
1535: .Bl -ohang
1536: .It Sy "input stack limit exceeded, infinite loop?"
1537: .Pq roff
1538: Explicit recursion limits are implemented for the following features,
1539: in order to prevent infinite loops:
1540: .Bl -dash -compact
1541: .It
1542: expansion of nested escape sequences
1543: including expansion of strings and number registers,
1544: .It
1545: expansion of nested user-defined macros,
1546: .It
1547: and
1548: .Ic \&so
1549: file inclusion.
1550: .El
1551: When a limit is hit, the output is incorrect, typically losing
1552: some content, but the parser can continue.
1553: .It Sy "skipping bad character"
1554: .Pq mdoc , man , roff
1555: The input file contains a byte that is not a printable
1556: .Xr ascii 7
1557: character.
1558: The message mentions the character number.
1559: The offending byte is replaced with a question mark
1560: .Pq Sq \&? .
1561: Consider editing the input file to replace the byte with an ASCII
1562: transliteration of the intended character.
1563: .It Sy "skipping unknown macro"
1564: .Pq mdoc , man , roff
1565: The first identifier on a request or macro line is neither recognized as a
1566: .Xr roff 7
1567: request, nor as a user-defined macro, nor, respectively, as an
1568: .Xr mdoc 7
1569: or
1570: .Xr man 7
1571: macro.
1572: It may be mistyped or unsupported.
1573: The request or macro is discarded including its arguments.
1574: .It Sy "skipping insecure request"
1575: .Pq roff
1576: An input file attempted to run a shell command
1577: or to read or write an external file.
1578: Such attempts are denied for security reasons.
1579: .It Sy "skipping item outside list"
1580: .Pq mdoc , eqn
1581: An
1582: .Ic \&It
1583: macro occurs outside any
1584: .Ic \&Bl
1585: list, or an
1586: .Xr eqn 7
1587: .Ic above
1588: delimiter occurs outside any pile.
1589: It is discarded including its arguments.
1590: .It Sy "skipping column outside column list"
1591: .Pq mdoc
1592: A
1593: .Ic \&Ta
1594: macro occurs outside any
1595: .Ic \&Bl Fl column
1596: block.
1597: It is discarded including its arguments.
1598: .It Sy "skipping end of block that is not open"
1599: .Pq mdoc , man , eqn , tbl , roff
1600: Various syntax elements can only be used to explicitly close blocks
1601: that have previously been opened.
1602: An
1603: .Xr mdoc 7
1604: block closing macro, a
1605: .Xr man 7
1606: .Ic \&RE
1607: or
1608: .Ic \&UE
1609: macro, an
1610: .Xr eqn 7
1611: right delimiter or closing brace, or the end of an equation, table, or
1612: .Xr roff 7
1613: conditional request is encountered but no matching block is open.
1614: The offending request or macro is discarded.
1615: .It Sy "fewer RS blocks open, skipping"
1616: .Pq man
1617: The
1618: .Ic \&RE
1619: macro is invoked with an argument, but less than the specified number of
1620: .Ic \&RS
1621: blocks is open.
1622: The
1623: .Ic \&RE
1624: macro is discarded.
1625: .It Sy "inserting missing end of block"
1626: .Pq mdoc , tbl
1627: Various
1628: .Xr mdoc 7
1629: macros as well as tables require explicit closing by dedicated macros.
1630: A block that doesn't support bad nesting
1631: ends before all of its children are properly closed.
1632: The open child nodes are closed implicitly.
1633: .It Sy "appending missing end of block"
1634: .Pq mdoc , man , eqn , tbl , roff
1635: At the end of the document, an explicit
1636: .Xr mdoc 7
1637: block, a
1638: .Xr man 7
1639: next-line scope or
1640: .Ic \&RS
1641: or
1642: .Ic \&UR
1643: block, an equation, table, or
1644: .Xr roff 7
1645: conditional or ignore block is still open.
1646: The open block is closed implicitly.
1647: .It Sy "escaped character not allowed in a name"
1648: .Pq roff
1649: Macro, string and register identifiers consist of printable,
1650: non-whitespace ASCII characters.
1651: Escape sequences and characters and strings expressed in terms of them
1652: cannot form part of a name.
1653: The first argument of an
1654: .Ic \&am ,
1655: .Ic \&as ,
1656: .Ic \&de ,
1657: .Ic \&ds ,
1658: .Ic \&nr ,
1659: or
1660: .Ic \&rr
1661: request, or any argument of an
1662: .Ic \&rm
1663: request, or the name of a request or user defined macro being called,
1664: is terminated by an escape sequence.
1665: In the cases of
1666: .Ic \&as ,
1667: .Ic \&ds ,
1668: and
1669: .Ic \&nr ,
1670: the request has no effect at all.
1671: In the cases of
1672: .Ic \&am ,
1673: .Ic \&de ,
1674: .Ic \&rr ,
1675: and
1676: .Ic \&rm ,
1677: what was parsed up to this point is used as the arguments to the request,
1678: and the rest of the input line is discarded including the escape sequence.
1679: When parsing for a request or a user-defined macro name to be called,
1680: only the escape sequence is discarded.
1681: The characters preceding it are used as the request or macro name,
1682: the characters following it are used as the arguments to the request or macro.
1683: .It Sy "NOT IMPLEMENTED: Bd -file"
1684: .Pq mdoc
1685: For security reasons, the
1686: .Ic \&Bd
1687: macro does not support the
1688: .Fl file
1689: argument.
1690: By requesting the inclusion of a sensitive file, a malicious document
1691: might otherwise trick a privileged user into inadvertently displaying
1692: the file on the screen, revealing the file content to bystanders.
1693: The argument is ignored including the file name following it.
1.87 schwarze 1694: .It Sy "skipping display without arguments"
1695: .Pq mdoc
1696: A
1697: .Ic \&Bd
1698: block macro does not have any arguments.
1699: The block is discarded, and the block content is displayed in
1700: whatever mode was active before the block.
1.76 schwarze 1701: .It Sy "missing list type, using -item"
1702: .Pq mdoc
1703: A
1704: .Ic \&Bl
1705: macro fails to specify the list type.
1706: .It Sy "missing manual name, using \(dq\(dq"
1707: .Pq mdoc
1708: The first call to
1.92 schwarze 1709: .Ic \&Nm ,
1710: or any call in the NAME section, lacks the required argument.
1.76 schwarze 1711: .It Sy "uname(3) system call failed, using UNKNOWN"
1712: .Pq mdoc
1713: The
1714: .Ic \&Os
1715: macro is called without arguments, and the
1716: .Xr uname 3
1717: system call failed.
1718: As a workaround,
1719: .Nm
1720: can be compiled with
1721: .Sm off
1722: .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
1723: .Sm on
1724: .It Sy "unknown standard specifier"
1725: .Pq mdoc
1726: An
1727: .Ic \&St
1728: macro has an unknown argument and is discarded.
1729: .It Sy "skipping request without numeric argument"
1730: .Pq roff , eqn
1731: An
1732: .Ic \&it
1733: request or an
1734: .Xr eqn 7
1735: .Ic \&size
1736: or
1737: .Ic \&gsize
1738: statement has a non-numeric or negative argument or no argument at all.
1739: The invalid request or statement is ignored.
1740: .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
1741: .Pq roff
1742: For security reasons,
1743: .Nm
1744: allows
1745: .Ic \&so
1746: file inclusion requests only with relative paths
1747: and only without ascending to any parent directory.
1748: By requesting the inclusion of a sensitive file, a malicious document
1749: might otherwise trick a privileged user into inadvertently displaying
1750: the file on the screen, revealing the file content to bystanders.
1751: .Nm
1752: only shows the path as it appears behind
1753: .Ic \&so .
1754: .It Sy ".so request failed"
1755: .Pq roff
1756: Servicing a
1757: .Ic \&so
1758: request requires reading an external file, but the file could not be
1759: opened.
1760: .Nm
1761: only shows the path as it appears behind
1762: .Ic \&so .
1763: .It Sy "skipping all arguments"
1764: .Pq mdoc , man , eqn , roff
1765: An
1766: .Xr mdoc 7
1767: .Ic \&Bt ,
1768: .Ic \&Ed ,
1769: .Ic \&Ef ,
1770: .Ic \&Ek ,
1771: .Ic \&El ,
1772: .Ic \&Lp ,
1773: .Ic \&Pp ,
1774: .Ic \&Re ,
1775: .Ic \&Rs ,
1776: or
1777: .Ic \&Ud
1778: macro, an
1779: .Ic \&It
1780: macro in a list that don't support item heads, a
1781: .Xr man 7
1782: .Ic \&LP ,
1783: .Ic \&P ,
1784: or
1785: .Ic \&PP
1786: macro, an
1787: .Xr eqn 7
1788: .Ic \&EQ
1789: or
1790: .Ic \&EN
1791: macro, or a
1792: .Xr roff 7
1793: .Ic \&br ,
1794: .Ic \&fi ,
1795: or
1796: .Ic \&nf
1797: request or
1798: .Sq \&..
1799: block closing request is invoked with at least one argument.
1800: All arguments are ignored.
1801: .It Sy "skipping excess arguments"
1802: .Pq mdoc , man , roff
1803: A macro or request is invoked with too many arguments:
1804: .Bl -dash -offset 2n -width 2n -compact
1805: .It
1806: .Ic \&Fo ,
1807: .Ic \&PD ,
1808: .Ic \&RS ,
1809: .Ic \&UR ,
1810: .Ic \&ft ,
1811: or
1812: .Ic \&sp
1813: with more than one argument
1814: .It
1815: .Ic \&An
1816: with another argument after
1817: .Fl split
1818: or
1819: .Fl nosplit
1820: .It
1821: .Ic \&RE
1822: with more than one argument or with a non-integer argument
1823: .It
1824: .Ic \&OP
1825: or a request of the
1826: .Ic \&de
1827: family with more than two arguments
1.78 schwarze 1828: .It
1829: .Ic \&Dt
1830: with more than three arguments
1.76 schwarze 1831: .It
1832: .Ic \&TH
1833: with more than five arguments
1834: .It
1835: .Ic \&Bd ,
1836: .Ic \&Bk ,
1837: or
1838: .Ic \&Bl
1839: with invalid arguments
1840: .El
1841: The excess arguments are ignored.
1842: .El
1843: .Ss Unsupported features
1844: .Bl -ohang
1845: .It Sy "input too large"
1846: .Pq mdoc , man
1847: Currently,
1848: .Nm
1849: cannot handle input files larger than its arbitrary size limit
1850: of 2^31 bytes (2 Gigabytes).
1851: Since useful manuals are always small, this is not a problem in practice.
1852: Parsing is aborted as soon as the condition is detected.
1853: .It Sy "unsupported control character"
1854: .Pq roff
1855: An ASCII control character supported by other
1856: .Xr roff 7
1857: implementations but not by
1858: .Nm
1859: was found in an input file.
1860: It is replaced by a question mark.
1861: .It Sy "unsupported roff request"
1862: .Pq roff
1863: An input file contains a
1864: .Xr roff 7
1865: request supported by GNU troff or Heirloom troff but not by
1866: .Nm ,
1867: and it is likely that this will cause information loss
1868: or considerable misformatting.
1869: .It Sy "eqn delim option in tbl"
1870: .Pq eqn , tbl
1871: The options line of a table defines equation delimiters.
1872: Any equation source code contained in the table will be printed unformatted.
1873: .It Sy "unsupported table layout modifier"
1874: .Pq tbl
1875: A table layout specification contains an
1876: .Sq Cm m
1877: modifier.
1878: The modifier is discarded.
1879: .It Sy "ignoring macro in table"
1880: .Pq tbl , mdoc , man
1881: A table contains an invocation of an
1882: .Xr mdoc 7
1883: or
1884: .Xr man 7
1885: macro or of an undefined macro.
1886: The macro is ignored, and its arguments are handled
1887: as if they were a text line.
1888: .El
1.1 kristaps 1889: .Sh SEE ALSO
1.75 schwarze 1890: .Xr apropos 1 ,
1891: .Xr man 1 ,
1.47 schwarze 1892: .Xr eqn 7 ,
1.25 jmc 1893: .Xr man 7 ,
1.1 kristaps 1894: .Xr mandoc_char 7 ,
1.43 schwarze 1895: .Xr mdoc 7 ,
1896: .Xr roff 7 ,
1897: .Xr tbl 7
1.97 schwarze 1898: .Sh HISTORY
1899: The
1900: .Nm
1901: utility first appeared in
1902: .Ox 4.8 .
1903: The option
1904: .Fl I
1905: appeared in
1906: .Ox 5.2 ,
1907: and
1908: .Fl aCcfhKklMSsw
1909: in
1910: .Ox 5.7 .
1.1 kristaps 1911: .Sh AUTHORS
1.80 schwarze 1912: .An -nosplit
1.1 kristaps 1913: The
1914: .Nm
1.10 schwarze 1915: utility was written by
1.75 schwarze 1916: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
1917: and is maintained by
1918: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
![[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