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