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