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