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