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