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