Annotation of mandoc/mandoc.1, Revision 1.126
1.126 ! schwarze 1: .\" $Id: mandoc.1,v 1.125 2014/11/28 18:09:01 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.126 ! schwarze 18: .Dd $Mdocdate: November 28 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 "missing date, using today's date"
669: .Pq mdoc, man
670: The document was parsed as
671: .Xr mdoc 7
672: and it has no
673: .Ic \&Dd
674: macro, or the
675: .Ic \&Dd
676: macro has no arguments or only empty arguments;
677: or the document was parsed as
678: .Xr man 7
679: and it has no
680: .Ic \&TH
681: macro, or the
682: .Ic \&TH
683: macro has less than three arguments or its third argument is empty.
684: .It Sy "cannot parse date, using it verbatim"
685: .Pq mdoc , man
686: The date given in a
687: .Ic \&Dd
688: or
689: .Ic \&TH
690: macro does not follow the conventional format.
691: .It Sy "missing Os macro, using \(dq\(dq"
692: .Pq mdoc
693: The default or current system is not shown in this case.
694: .It Sy "duplicate prologue macro"
695: .Pq mdoc
696: One of the prologue macros occurs more than once.
697: The last instance overrides all previous ones.
698: .It Sy "late prologue macro"
699: .Pq mdoc
700: A
701: .Ic \&Dd
702: or
703: .Ic \&Os
704: macro occurs after some non-prologue macro, but still takes effect.
705: .It Sy "skipping late title macro"
706: .Pq mdoc
707: The
708: .Ic \&Dt
709: macro can only occur before the first non-prologue macro
710: because traditional formatters write the page header
711: before parsing the document body.
712: Even though this technical restriction does not apply to
713: .Nm ,
714: traditional semantics is preserved.
715: The late macro is discarded including its arguments.
716: .It Sy "prologue macros out of order"
717: .Pq mdoc
718: The prologue macros are not given in the conventional order
719: .Ic \&Dd ,
720: .Ic \&Dt ,
721: .Ic \&Os .
722: All three macros are used even when given in another order.
723: .El
724: .Ss Warnings regarding document structure
725: .Bl -ohang
726: .It Sy ".so is fragile, better use ln(1)"
727: .Pq roff
728: Including files only works when the parser program runs with the correct
729: current working directory.
730: .It Sy "no document body"
731: .Pq mdoc , man
732: The document body contains neither text nor macros.
733: An empty document is shown, consisting only of a header and a footer line.
734: .It Sy "content before first section header"
735: .Pq mdoc , man
736: Some macros or text precede the first
737: .Ic \&Sh
738: or
739: .Ic \&SH
740: section header.
741: The offending macros and text are parsed and added to the top level
742: of the syntax tree, outside any section block.
743: .It Sy "first section is not NAME"
744: .Pq mdoc
745: The argument of the first
746: .Ic \&Sh
747: macro is not
748: .Sq NAME .
749: This may confuse
750: .Xr makewhatis 8
751: and
752: .Xr apropos 1 .
753: .It Sy "bad NAME section contents"
754: .Pq mdoc
755: The last node in the NAME section is not an
756: .Ic \&Nd
757: macro, or any preceding macro is not
758: .Ic \&Nm ,
759: or the NAME section is completely empty.
760: This may confuse
761: .Xr makewhatis 8
762: and
763: .Xr apropos 1 .
764: .It Sy "sections out of conventional order"
765: .Pq mdoc
766: A standard section occurs after another section it usually precedes.
767: All section titles are used as given,
768: and the order of sections is not changed.
769: .It Sy "duplicate section title"
770: .Pq mdoc
771: The same standard section title occurs more than once.
772: .It Sy "unexpected section"
773: .Pq mdoc
774: A standard section header occurs in a section of the manual
775: where it normally isn't useful.
1.112 schwarze 776: .It Sy "unusual Xr order"
777: .Pq mdoc
778: In the SEE ALSO section, an
779: .Ic \&Xr
780: macro with a lower section number follows one with a higher number,
781: or two
782: .Ic \&Xr
783: macros refering to the same section are out of alphabetical order.
784: .It Sy "unusual Xr punctuation"
785: .Pq mdoc
786: In the SEE ALSO section, punctuation between two
787: .Ic \&Xr
788: macros differs from a single comma, or there is trailing punctuation
789: after the last
790: .Ic \&Xr
791: macro.
1.111 schwarze 792: .It Sy "AUTHORS section without An macro"
793: .Pq mdoc
794: An AUTHORS sections contains no
795: .Ic \&An
796: macros, or only empty ones.
797: Probably, there are author names lacking markup.
1.106 schwarze 798: .El
799: .Ss "Warnings related to macros and nesting"
800: .Bl -ohang
801: .It Sy "obsolete macro"
802: .Pq mdoc
803: See the
804: .Xr mdoc 7
805: manual for replacements.
1.126 ! schwarze 806: .It Sy "macro neither callable nor escaped"
! 807: .Pq mdoc
! 808: The name of a macro that is not callable appears on a macro line.
! 809: It is printed verbatim.
! 810: If the intention is to call it, move it to its own line;
! 811: otherwise, escape it by prepending
! 812: .Sq \e& .
1.106 schwarze 813: .It Sy "skipping paragraph macro"
814: In
815: .Xr mdoc 7
816: documents, this happens
817: .Bl -dash -compact
818: .It
819: at the beginning and end of sections and subsections
820: .It
821: right before non-compact lists and displays
822: .It
823: at the end of items in non-column, non-compact lists
824: .It
825: and for multiple consecutive paragraph macros.
826: .El
827: In
828: .Xr man 7
829: documents, it happens
830: .Bl -dash -compact
831: .It
832: for empty
833: .Ic \&P ,
834: .Ic \&PP ,
835: and
836: .Ic \&LP
837: macros
838: .It
839: for
840: .Ic \&IP
841: macros having neither head nor body arguments
842: .It
843: for
844: .Ic \&br
845: or
846: .Ic \&sp
847: right after
848: .Ic \&SH
849: or
850: .Ic \&SS
851: .El
852: .It Sy "moving paragraph macro out of list"
853: .Pq mdoc
854: A list item in a
855: .Ic \&Bl
856: list contains a trailing paragraph macro.
857: The paragraph macro is moved after the end of the list.
858: .It Sy "skipping no-space macro"
859: .Pq mdoc
860: An input line begins with an
861: .Ic \&Ns
862: macro.
863: The macro is ignored.
864: .It Sy "blocks badly nested"
865: .Pq mdoc
866: If two blocks intersect, one should completely contain the other.
867: Otherwise, rendered output is likely to look strange in any output
868: format, and rendering in SGML-based output formats is likely to be
869: outright wrong because such languages do not support badly nested
870: blocks at all.
871: Typical examples of badly nested blocks are
872: .Qq Ic \&Ao \&Bo \&Ac \&Bc
873: and
874: .Qq Ic \&Ao \&Bq \&Ac .
875: In these examples,
876: .Ic \&Ac
877: breaks
878: .Ic \&Bo
879: and
880: .Ic \&Bq ,
881: respectively.
882: .It Sy "nested displays are not portable"
883: .Pq mdoc
884: A
885: .Ic \&Bd ,
886: .Ic \&D1 ,
887: or
888: .Ic \&Dl
889: display occurs nested inside another
890: .Ic \&Bd
891: display.
892: This works with
893: .Nm ,
894: but fails with most other implementations.
895: .It Sy "moving content out of list"
896: .Pq mdoc
897: A
898: .Ic \&Bl
899: list block contains text or macros before the first
900: .Ic \&It
901: macro.
902: The offending children are moved before the beginning of the list.
903: .It Sy ".Vt block has child macro"
904: .Pq mdoc
905: The
906: .Ic \&Vt
907: macro supports plain text arguments only.
908: Formatting may be ugly and semantic searching
909: for the affected content might not work.
910: .It Sy "fill mode already enabled, skipping"
911: .Pq man
912: A
913: .Ic \&fi
914: request occurs even though the document is still in fill mode,
915: or already switched back to fill mode.
916: It has no effect.
917: .It Sy "fill mode already disabled, skipping"
918: .Pq man
919: An
920: .Ic \&nf
921: request occurs even though the document already switched to no-fill mode
922: and did not switch back to fill mode yet.
923: It has no effect.
924: .It Sy "line scope broken"
925: .Pq man
926: While parsing the next-line scope of the previous macro,
927: another macro is found that prematurely terminates the previous one.
928: The previous, interrupted macro is deleted from the parse tree.
929: .El
930: .Ss "Warnings related to missing arguments"
931: .Bl -ohang
932: .It Sy "skipping empty request"
1.118 schwarze 933: .Pq roff , eqn
934: The macro name is missing from a macro definition request,
935: or an
936: .Xr eqn 7
937: control statement or operation keyword lacks its required argument.
1.106 schwarze 938: .It Sy "conditional request controls empty scope"
939: .Pq roff
940: A conditional request is only useful if any of the following
941: follows it on the same logical input line:
942: .Bl -dash -compact
943: .It
944: The
945: .Sq \e{
946: keyword to open a multi-line scope.
947: .It
948: A request or macro or some text, resulting in a single-line scope.
949: .It
950: The immediate end of the logical line without any intervening whitespace,
951: resulting in next-line scope.
952: .El
953: Here, a conditional request is followed by trailing whitespace only,
954: and there is no other content on its logical input line.
955: Note that it doesn't matter whether the logical input line is split
956: across multiple physical input lines using
957: .Sq \e
958: line continuation characters.
959: This is one of the rare cases
960: where trailing whitespace is syntactically significant.
961: The conditional request controls a scope containing whitespace only,
962: so it is unlikely to have a significant effect,
963: except that it may control a following
964: .Ic \&el
965: clause.
966: .It Sy "skipping empty macro"
967: .Pq mdoc
968: The indicated macro has no arguments and hence no effect.
969: .It Sy "empty argument, using 0n"
970: .Pq mdoc
971: The required width is missing after
972: .Ic \&Bd
973: or
974: .Ic \&Bl
975: .Fl offset
976: or
977: .Fl width.
978: .It Sy "argument count wrong"
979: .Pq mdoc , man
980: The indicated macro has too few or too many arguments.
981: The syntax tree will contain the wrong number of arguments as given.
982: Formatting behaviour depends on the specific macro in question.
983: Note that the same message may also occur as an ERROR, see below.
984: .It Sy "missing display type, using -ragged"
985: .Pq mdoc
986: The
987: .Ic \&Bd
988: macro is invoked without the required display type.
989: .It Sy "list type is not the first argument"
990: .Pq mdoc
991: In a
992: .Ic \&Bl
993: macro, at least one other argument precedes the type argument.
994: The
995: .Nm
996: utility copes with any argument order, but some other
997: .Xr mdoc 7
998: implementations do not.
999: .It Sy "missing -width in -tag list, using 8n"
1000: .Pq mdoc
1001: Every
1002: .Ic \&Bl
1003: macro having the
1004: .Fl tag
1005: argument requires
1006: .Fl width ,
1007: too.
1008: .It Sy "missing utility name, using \(dq\(dq"
1009: .Pq mdoc
1010: The
1011: .Ic \&Ex Fl std
1012: macro is called without an argument before
1013: .Ic \&Nm
1014: has first been called with an argument.
1015: .It Sy "empty head in list item"
1016: .Pq mdoc
1017: In a
1018: .Ic \&Bl
1019: .Fl diag ,
1020: .Fl hang ,
1021: .Fl inset ,
1022: .Fl ohang ,
1023: or
1024: .Fl tag
1025: list, an
1026: .Ic \&It
1027: macro lacks the required argument.
1028: The item head is left empty.
1029: .It Sy "empty list item"
1030: .Pq mdoc
1031: In a
1032: .Ic \&Bl
1033: .Fl bullet ,
1034: .Fl dash ,
1035: .Fl enum ,
1036: or
1037: .Fl hyphen
1038: list, an
1039: .Ic \&It
1040: block is empty.
1041: An empty list item is shown.
1042: .It Sy "missing font type"
1043: .Pq mdoc
1044: A
1045: .Ic \&Bf
1046: macro has no argument.
1047: It switches to the default font,
1048: .Cm \efR .
1049: .It Sy "unknown font type"
1050: .Pq mdoc
1051: The
1052: .Ic \&Bf
1053: argument is invalid.
1054: The default font
1055: .Cm \efR
1056: is used instead.
1057: .It Sy "missing -std argument, adding it"
1058: .Pq mdoc
1059: An
1060: .Ic \&Ex
1061: or
1062: .Ic \&Rv
1063: macro lacks the required
1064: .Fl std
1065: argument.
1066: The
1067: .Nm
1068: utility assumes
1069: .Fl std
1070: even when it is not specified, but other implementations may not.
1.118 schwarze 1071: .It Sy "missing eqn box, using \(dq\(dq"
1072: .Pq eqn
1073: A diacritic mark or a binary operator is found,
1074: but there is nothing to the left of it.
1075: An empty box is inserted.
1.106 schwarze 1076: .El
1077: .Ss "Warnings related to bad macro arguments"
1078: .Bl -ohang
1079: .It Sy "unterminated quoted argument"
1080: .Pq roff
1081: Macro arguments can be enclosed in double quote characters
1082: such that space characters and macro names contained in the quoted
1083: argument need not be escaped.
1084: The closing quote of the last argument of a macro can be omitted.
1085: However, omitting it is not recommended because it makes the code
1086: harder to read.
1087: .It Sy "duplicate argument"
1088: .Pq mdoc
1089: A
1090: .Ic \&Bd
1091: or
1092: .Ic \&Bl
1093: macro has more than one
1094: .Fl compact ,
1095: more than one
1096: .Fl offset ,
1097: or more than one
1098: .Fl width
1099: argument.
1100: All but the last instances of these arguments are ignored.
1101: .It Sy "skipping duplicate argument"
1102: .Pq mdoc
1103: An
1104: .Ic \&An
1105: macro has more than one
1106: .Fl split
1107: or
1108: .Fl nosplit
1109: argument.
1110: All but the first of these arguments are ignored.
1111: .It Sy "skipping duplicate display type"
1112: .Pq mdoc
1113: A
1114: .Ic \&Bd
1115: macro has more than one type argument; the first one is used.
1116: .It Sy "skipping duplicate list type"
1117: .Pq mdoc
1118: A
1119: .Ic \&Bl
1120: macro has more than one type argument; the first one is used.
1121: .It Sy "skipping -width argument"
1122: .Pq mdoc
1123: A
1124: .Ic \&Bl
1125: .Fl column ,
1126: .Fl diag ,
1127: .Fl ohang ,
1128: .Fl inset ,
1129: or
1130: .Fl item
1131: list has a
1132: .Fl width
1133: argument.
1134: That has no effect.
1135: .It Sy "unknown AT&T UNIX version"
1136: .Pq mdoc
1137: An
1138: .Ic \&At
1139: macro has an invalid argument.
1140: It is used verbatim, with
1141: .Qq "AT&T UNIX "
1142: prefixed to it.
1.113 schwarze 1143: .It Sy "comma in function argument"
1144: .Pq mdoc
1145: An argument of an
1146: .Ic \&Fa
1147: or
1148: .Ic \&Fn
1149: macro contains a comma; it should probably be split into two arguments.
1.117 schwarze 1150: .It Sy "parenthesis in function name"
1151: .Pq mdoc
1152: The first argument of an
1153: .Ic \&Fc
1154: or
1155: .Ic \&Fn
1156: macro contains an opening or closing parenthesis; that's probably wrong,
1157: parentheses are added automatically.
1.106 schwarze 1158: .It Sy "invalid content in Rs block"
1159: .Pq mdoc
1160: An
1161: .Ic \&Rs
1162: block contains plain text or non-% macros.
1163: The bogus content is left in the syntax tree.
1164: Formatting may be poor.
1165: .It Sy "invalid Boolean argument"
1166: .Pq mdoc
1167: An
1168: .Ic \&Sm
1169: macro has an argument other than
1170: .Cm on
1171: or
1172: .Cm off .
1173: The invalid argument is moved out of the macro, which leaves the macro
1174: empty, causing it to toggle the spacing mode.
1175: .It Sy "unknown font, skipping request"
1.115 schwarze 1176: .Pq man , tbl
1.106 schwarze 1177: A
1178: .Xr roff 7
1179: .Ic \&ft
1.115 schwarze 1180: request or a
1181: .Xr tbl 7
1182: .Ic \&f
1183: layout modifier has an unknown
1184: .Ar font
1185: argument.
1.106 schwarze 1186: .El
1187: .Ss "Warnings related to plain text"
1188: .Bl -ohang
1189: .It Sy "blank line in fill mode, using .sp"
1190: .Pq mdoc
1191: The meaning of blank input lines is only well-defined in non-fill mode:
1192: In fill mode, line breaks of text input lines are not supposed to be
1193: significant.
1194: However, for compatibility with groff, blank lines in fill mode
1195: are replaced with
1196: .Ic \&sp
1197: requests.
1198: .It Sy "tab in filled text"
1199: .Pq mdoc , man
1200: The meaning of tab characters is only well-defined in non-fill mode:
1201: In fill mode, whitespace is not supposed to be significant
1202: on text input lines.
1203: As an implementation dependent choice, tab characters on text lines
1204: are passed through to the formatters in any case.
1205: Given that the text before the tab character will be filled,
1206: it is hard to predict which tab stop position the tab will advance to.
1207: .It Sy "whitespace at end of input line"
1208: .Pq mdoc , man , roff
1209: Whitespace at the end of input lines is almost never semantically
1210: significant \(em but in the odd case where it might be, it is
1211: extremely confusing when reviewing and maintaining documents.
1212: .It Sy "bad comment style"
1213: .Pq roff
1214: Comment lines start with a dot, a backslash, and a double-quote character.
1215: The
1216: .Nm
1217: utility treats the line as a comment line even without the backslash,
1218: but leaving out the backslash might not be portable.
1219: .It Sy "invalid escape sequence"
1220: .Pq roff
1221: An escape sequence has an invalid opening argument delimiter, lacks the
1222: closing argument delimiter, or the argument has too few characters.
1223: If the argument is incomplete,
1224: .Ic \e*
1225: and
1226: .Ic \en
1227: expand to an empty string,
1228: .Ic \eB
1229: to the digit
1230: .Sq 0 ,
1231: and
1232: .Ic \ew
1233: to the length of the incomplete argument.
1234: All other invalid escape sequences are ignored.
1235: .It Sy "undefined string, using \(dq\(dq"
1236: .Pq roff
1237: If a string is used without being defined before,
1238: its value is implicitly set to the empty string.
1239: However, defining strings explicitly before use
1240: keeps the code more readable.
1241: .El
1242: .Ss "Errors related to equations"
1243: .Bl -inset -compact
1244: .It "unexpected equation scope closure"
1245: .It "equation scope open on exit"
1246: .It "overlapping equation scopes"
1247: .It "unexpected end of equation"
1248: .El
1249: .Ss "Errors related to tables"
1250: .Bl -inset -compact
1251: .It "bad table syntax"
1252: .It "bad table option"
1253: .It "bad table layout"
1254: .It "no table layout cells specified"
1255: .It "no table data cells specified"
1256: .It "ignore data in cell"
1257: .It "data block still open"
1258: .It "ignoring extra data cells"
1259: .El
1260: .Ss "Errors related to roff, mdoc, and man code"
1261: .Bl -ohang
1262: .It Sy "input stack limit exceeded, infinite loop?"
1263: .Pq roff
1264: Explicit recursion limits are implemented for the following features,
1265: in order to prevent infinite loops:
1266: .Bl -dash -compact
1267: .It
1268: expansion of nested escape sequences
1269: including expansion of strings and number registers,
1270: .It
1271: expansion of nested user-defined macros,
1272: .It
1273: and
1274: .Ic \&so
1275: file inclusion.
1276: .El
1277: When a limit is hit, the output is incorrect, typically losing
1278: some content, but the parser can continue.
1279: .It Sy "skipping bad character"
1280: .Pq mdoc , man , roff
1281: The input file contains a byte that is not a printable
1282: .Xr ascii 7
1283: character.
1284: The message mentions the character number.
1285: The offending byte is replaced with a question mark
1286: .Pq Sq \&? .
1287: Consider editing the input file to replace the byte with an ASCII
1288: transliteration of the intended character.
1289: .It Sy "skipping unknown macro"
1290: .Pq mdoc , man , roff
1291: The first identifier on a request or macro line is neither recognized as a
1292: .Xr roff 7
1293: request, nor as a user-defined macro, nor, respectively, as an
1294: .Xr mdoc 7
1295: or
1296: .Xr man 7
1297: macro.
1298: It may be mistyped or unsupported.
1299: The request or macro is discarded including its arguments.
1300: .It Sy "skipping item outside list"
1.118 schwarze 1301: .Pq mdoc , eqn
1.106 schwarze 1302: An
1303: .Ic \&It
1304: macro occurs outside any
1305: .Ic \&Bl
1.118 schwarze 1306: list, or an
1307: .Xr eqn 7
1308: .Ic above
1309: delimiter occurs outside any pile.
1.106 schwarze 1310: It is discarded including its arguments.
1311: .It Sy "skipping column outside column list"
1312: .Pq mdoc
1313: A
1314: .Ic \&Ta
1315: macro occurs outside any
1316: .Ic \&Bl Fl column
1317: block.
1318: It is discarded including its arguments.
1319: .It Sy "skipping end of block that is not open"
1320: .Pq mdoc , man , eqn , tbl , roff
1321: Various syntax elements can only be used to explicitly close blocks
1322: that have previously been opened.
1323: An
1324: .Xr mdoc 7
1325: block closing macro, a
1326: .Xr man 7
1327: .Ic \&RE
1328: or
1329: .Ic \&UE
1.118 schwarze 1330: macro, an
1331: .Xr eqn 7
1332: right delimiter or closing brace, or the end of an equation, table, or
1.106 schwarze 1333: .Xr roff 7
1334: conditional request is encountered but no matching block is open.
1335: The offending request or macro is discarded.
1336: .It Sy "inserting missing end of block"
1337: .Pq mdoc , tbl
1338: Various
1339: .Xr mdoc 7
1340: macros as well as tables require explicit closing by dedicated macros.
1341: A block that doesn't support bad nesting
1342: ends before all of its children are properly closed.
1343: The open child nodes are closed implicitly.
1344: .It Sy "scope open on exit"
1345: .Pq mdoc , man , eqn , tbl , roff
1346: At the end of the document, an explicit
1347: .Xr mdoc 7
1348: block, a
1349: .Xr man 7
1350: next-line scope or
1351: .Ic \&RS
1352: or
1353: .Ic \&UR
1354: block, an equation, table, or
1355: .Xr roff 7
1356: conditional or ignore block is still open.
1357: The open block is closed implicitly.
1358: .It Sy "escaped character not allowed in a name"
1359: .Pq roff
1360: Macro, string and register identifiers consist of printable,
1361: non-whitespace ASCII characters.
1362: Escape sequences and characters and strings expressed in terms of them
1363: cannot form part of a name.
1364: The first argument of an
1365: .Ic \&am ,
1366: .Ic \&as ,
1367: .Ic \&de ,
1368: .Ic \&ds ,
1369: .Ic \&nr ,
1370: or
1371: .Ic \&rr
1372: request, or any argument of an
1373: .Ic \&rm
1374: request, or the name of a request or user defined macro being called,
1375: is terminated by an escape sequence.
1376: In the cases of
1377: .Ic \&as ,
1378: .Ic \&ds ,
1379: and
1380: .Ic \&nr ,
1381: the request has no effect at all.
1382: In the cases of
1383: .Ic \&am ,
1384: .Ic \&de ,
1385: .Ic \&rr ,
1386: and
1387: .Ic \&rm ,
1388: what was parsed up to this point is used as the arguments to the request,
1389: and the rest of the input line is discarded including the escape sequence.
1390: When parsing for a request or a user-defined macro name to be called,
1391: only the escape sequence is discarded.
1392: The characters preceding it are used as the request or macro name,
1393: the characters following it are used as the arguments to the request or macro.
1394: .It Sy "argument count wrong"
1395: .Pq mdoc , man , roff
1396: The indicated request or macro has too few or too many arguments.
1397: The syntax tree will contain the wrong number of arguments as given.
1398: Formatting behaviour depends on the specific request or macro in question.
1399: Note that the same message may also occur as a WARNING, see above.
1.124 schwarze 1400: .It Sy "NOT IMPLEMENTED: Bd -file"
1401: .Pq mdoc
1402: For security reasons, the
1403: .Ic \&Bd
1404: macro does not support the
1405: .Fl file
1406: argument.
1407: By requesting the inclusion of a sensitive file, a malicious document
1408: might otherwise trick a privileged user into inadvertently displaying
1409: the file on the screen, revealing the file content to bystanders.
1410: The argument is ignored including the file name following it.
1.106 schwarze 1411: .It Sy "missing list type, using -item"
1412: .Pq mdoc
1413: A
1414: .Ic \&Bl
1415: macro fails to specify the list type.
1416: .It Sy "missing manual name, using \(dq\(dq"
1417: .Pq mdoc
1418: The first call to
1419: .Ic \&Nm
1420: lacks the required argument.
1421: .It Sy "uname(3) system call failed, using UNKNOWN"
1422: .Pq mdoc
1423: The
1424: .Ic \&Os
1425: macro is called without arguments, and the
1426: .Xr uname 3
1427: system call failed.
1428: As a workaround,
1429: .Nm
1430: can be compiled with
1431: .Sm off
1432: .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
1433: .Sm on
1434: .It Sy "unknown standard specifier"
1435: .Pq mdoc
1436: An
1437: .Ic \&St
1438: macro has an unknown argument and is discarded.
1439: .It Sy "skipping request without numeric argument"
1.118 schwarze 1440: .Pq roff , eqn
1.106 schwarze 1441: An
1442: .Ic \&it
1.118 schwarze 1443: request or an
1444: .Xr eqn 7
1445: .Ic \&size
1446: or
1447: .Ic \&gsize
1448: statement has a non-numeric or negative argument or no argument at all.
1449: The invalid request or statement is ignored.
1.106 schwarze 1450: .It Sy "skipping all arguments"
1451: .Pq mdoc , man , eqn , roff
1452: An
1453: .Xr mdoc 7
1454: .Ic \&Bt ,
1455: .Ic \&Ed ,
1456: .Ic \&Ef ,
1457: .Ic \&Ek ,
1458: .Ic \&El ,
1459: .Ic \&Re ,
1460: or
1461: .Ic \&Ud
1462: macro, an
1463: .Ic \&It
1464: macro in a list that don't support item heads, a
1465: .Xr man 7
1466: .Ic \&LP ,
1467: .Ic \&P ,
1468: or
1469: .Ic \&PP
1470: macro, an
1471: .Xr eqn 7
1.120 schwarze 1472: .Ic \&EQ
1473: or
1.106 schwarze 1474: .Ic \&EN
1475: macro, or a
1476: .Xr roff 7
1477: .Sq \&..
1478: block closing request is invoked with at least one argument.
1479: All arguments are ignored.
1480: .It Sy "skipping excess arguments"
1481: .Pq mdoc , roff
1.77 schwarze 1482: The
1.106 schwarze 1483: .Ic \&Bf
1484: macro is invoked with more than one argument, or a request of the
1485: .Ic \&de
1486: family is invoked with more than two arguments.
1487: The excess arguments are ignored.
1488: .El
1489: .Ss FATAL errors
1490: .Bl -ohang
1491: .It Sy "input too large"
1492: .Pq mdoc , man
1493: Currently,
1494: .Nm
1495: cannot handle input files larger than its arbitrary size limit
1496: of 2^31 bytes (2 Gigabytes).
1497: Since useful manuals are always small, this is not a problem in practice.
1498: Parsing is aborted as soon as the condition is detected.
1499: .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
1500: .Pq roff
1501: For security reasons,
1.77 schwarze 1502: .Nm
1.106 schwarze 1503: allows
1504: .Ic \&so
1505: file inclusion requests only with relative paths
1506: and only without ascending to any parent directory.
1507: By requesting the inclusion of a sensitive file, a malicious document
1508: might otherwise trick a privileged user into inadvertently displaying
1509: the file on the screen, revealing the file content to bystanders.
1510: The parser exits immediately.
1511: .It Sy ".so request failed"
1512: .Pq roff
1513: Servicing a
1514: .Ic \&so
1515: request requires reading an external file.
1516: While trying to do so, an
1517: .Xr open 2 ,
1518: .Xr stat 2 ,
1519: or
1520: .Xr read 2
1521: system call failed.
1522: The parser exits immediately.
1523: Before showing this message,
1524: .Nm
1525: always shows another message explaining why the system call failed.
1526: .El
1.20 kristaps 1527: .Sh COMPATIBILITY
1.26 kristaps 1528: This section summarises
1.20 kristaps 1529: .Nm
1.76 kristaps 1530: compatibility with GNU troff.
1.32 kristaps 1531: Each input and output format is separately noted.
1.48 kristaps 1532: .Ss ASCII Compatibility
1.37 kristaps 1533: .Bl -bullet -compact
1.29 kristaps 1534: .It
1.87 kristaps 1535: Unrenderable unicode codepoints specified with
1.86 kristaps 1536: .Sq \e[uNNNN]
1537: escapes are printed as
1538: .Sq \&?
1539: in mandoc.
1540: In GNU troff, these raise an error.
1541: .It
1.49 kristaps 1542: The
1.33 kristaps 1543: .Sq \&Bd \-literal
1.49 kristaps 1544: and
1.32 kristaps 1545: .Sq \&Bd \-unfilled
1546: macros of
1547: .Xr mdoc 7
1548: in
1.58 kristaps 1549: .Fl T Ns Cm ascii
1.32 kristaps 1550: are synonyms, as are \-filled and \-ragged.
1.26 kristaps 1551: .It
1.86 kristaps 1552: In historic GNU troff, the
1.27 kristaps 1553: .Sq \&Pa
1.32 kristaps 1554: .Xr mdoc 7
1555: macro does not underline when scoped under an
1.30 kristaps 1556: .Sq \&It
1.57 kristaps 1557: in the FILES section.
1558: This behaves correctly in
1.27 kristaps 1559: .Nm .
1560: .It
1.58 kristaps 1561: A list or display following the
1.27 kristaps 1562: .Sq \&Ss
1.32 kristaps 1563: .Xr mdoc 7
1564: macro in
1.58 kristaps 1565: .Fl T Ns Cm ascii
1.20 kristaps 1566: does not assert a prior vertical break, just as it doesn't with
1.27 kristaps 1567: .Sq \&Sh .
1.20 kristaps 1568: .It
1.32 kristaps 1569: The
1570: .Sq \&na
1571: .Xr man 7
1.34 kristaps 1572: macro in
1.58 kristaps 1573: .Fl T Ns Cm ascii
1.34 kristaps 1574: has no effect.
1.20 kristaps 1575: .It
1576: Words aren't hyphenated.
1577: .El
1.114 kristaps 1578: .Ss HTML Compatibility
1.42 kristaps 1579: .Bl -bullet -compact
1580: .It
1581: The
1.47 kristaps 1582: .Sq \efP
1583: escape will revert the font to the previous
1584: .Sq \ef
1585: escape, not to the last rendered decoration, which is now dictated by
1.57 kristaps 1586: CSS instead of hard-coded.
1587: It also will not span past the current scope,
1588: for the same reason.
1589: Note that in
1.47 kristaps 1590: .Sx ASCII Output
1591: mode, this will work fine.
1592: .It
1593: The
1.42 kristaps 1594: .Xr mdoc 7
1595: .Sq \&Bl \-hang
1596: and
1597: .Sq \&Bl \-tag
1598: list types render similarly (no break following overreached left-hand
1599: side) due to the expressive constraints of HTML.
1600: .It
1601: The
1602: .Xr man 7
1603: .Sq IP
1604: and
1605: .Sq TP
1606: lists render similarly.
1607: .El
1.1 kristaps 1608: .Sh SEE ALSO
1.85 kristaps 1609: .Xr eqn 7 ,
1.57 kristaps 1610: .Xr man 7 ,
1.13 kristaps 1611: .Xr mandoc_char 7 ,
1.84 kristaps 1612: .Xr mdoc 7 ,
1613: .Xr roff 7 ,
1614: .Xr tbl 7
1.1 kristaps 1615: .Sh AUTHORS
1616: The
1617: .Nm
1.26 kristaps 1618: utility was written by
1.103 schwarze 1619: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1.39 kristaps 1620: .Sh CAVEATS
1621: In
1.58 kristaps 1622: .Fl T Ns Cm html
1.50 kristaps 1623: and
1.58 kristaps 1624: .Fl T Ns Cm xhtml ,
1.39 kristaps 1625: the maximum size of an element attribute is determined by
1626: .Dv BUFSIZ ,
1.57 kristaps 1627: which is usually 1024 bytes.
1628: Be aware of this when setting long link
1.58 kristaps 1629: formats such as
1630: .Fl O Ns Cm style Ns = Ns Ar really/long/link .
1.51 kristaps 1631: .Pp
1632: Nesting elements within next-line element scopes of
1.58 kristaps 1633: .Fl m Ns Cm an ,
1.51 kristaps 1634: such as
1635: .Sq br
1636: within an empty
1637: .Sq B ,
1638: will confuse
1.58 kristaps 1639: .Fl T Ns Cm html
1.51 kristaps 1640: and
1.58 kristaps 1641: .Fl T Ns Cm xhtml
1.52 kristaps 1642: and cause them to forget the formatting of the prior next-line scope.
1.53 kristaps 1643: .Pp
1.54 kristaps 1644: The
1645: .Sq \(aq
1.55 kristaps 1646: control character is an alias for the standard macro control character
1647: and does not emit a line-break as stipulated in GNU troff.
CVSweb