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