Annotation of mandoc/mandoc.1, Revision 1.215
1.215 ! schwarze 1: .\" $Id: mandoc.1,v 1.214 2017/07/04 14:40:38 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.215 ! schwarze 18: .Dd $Mdocdate: July 4 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.214 schwarze 765: Messages of the
766: .Cm base
767: level are printed with the more intuitive
768: .Cm style
769: .Ar level
770: tag.
1.77 schwarze 771: .El
772: .Pp
773: Messages of the
1.202 schwarze 774: .Cm base ,
1.185 schwarze 775: .Cm style ,
1.133 schwarze 776: .Cm warning ,
777: .Cm error ,
1.77 schwarze 778: and
1.133 schwarze 779: .Cm unsupp
1.131 schwarze 780: levels except those about non-existent or unreadable input files
781: are hidden unless their level, or a lower level, is requested using a
1.77 schwarze 782: .Fl W
783: option or
1.156 schwarze 784: .Fl T Cm lint
1.77 schwarze 785: output mode.
1.202 schwarze 786: .Pp
787: As indicated below, all
788: .Cm base
789: and some
790: .Cm style
791: checks are only performed if a specific operating system name occurs
792: in the arguments of the
793: .Fl W
794: command line option, of the
1.195 schwarze 795: .Ic \&Os
796: macro, of the
797: .Fl Ios
798: command line option, or, if neither are present, in the return value
799: of the
800: .Xr uname 3
801: function.
1.202 schwarze 802: .Ss Conventions for base system manuals
1.189 schwarze 803: .Bl -ohang
1.200 schwarze 804: .It Sy "Mdocdate found"
805: .Pq mdoc , Nx
806: The
807: .Ic \&Dd
808: macro uses CVS
809: .Ic Mdocdate
810: keyword substitution, which is not supported by the
811: .Nx
812: base system.
813: Consider using the conventional
814: .Dq "Month dd, yyyy"
815: format instead.
816: .It Sy "Mdocdate missing"
817: .Pq mdoc , Ox
818: The
819: .Ic \&Dd
820: macro does not use CVS
821: .Ic Mdocdate
822: keyword substitution, but using it is conventionally expected in the
823: .Ox
824: base system.
1.204 schwarze 825: .It Sy "unknown architecture"
826: .Pq mdoc , Ox , Nx
827: The third argument of the
828: .Ic \&Dt
829: macro does not match any of the architectures this operating system
830: is running on.
1.203 schwarze 831: .It Sy "operating system explicitly specified"
832: .Pq mdoc , Ox , Nx
833: The
834: .Ic \&Os
835: macro has an argument.
836: In the base system, it is conventionally left blank.
1.202 schwarze 837: .It Sy "RCS id missing"
838: .Pq Ox , Nx
839: The manual page lacks the comment line with the RCS identifier
840: generated by CVS
841: .Ic OpenBSD
842: or
843: .Ic NetBSD
844: keyword substitution as conventionally used in these operating systems.
1.210 schwarze 845: .It Sy "referenced manual not found"
846: .Pq mdoc
847: An
848: .Ic \&Xr
849: macro references a manual page that is not found in the base system.
850: The path to look for base system manuals is configurable at compile
851: time and defaults to
852: .Pa /usr/share/man : /usr/X11R6/man .
1.202 schwarze 853: .El
854: .Ss Style suggestions
855: .Bl -ohang
1.200 schwarze 856: .It Sy "legacy man(7) date format"
857: .Pq mdoc
858: The
859: .Ic \&Dd
860: macro uses the legacy
861: .Xr man 7
862: date format
863: .Dq yyyy-dd-mm .
864: Consider using the conventional
865: .Xr mdoc 7
866: date format
867: .Dq "Month dd, yyyy"
868: instead.
1.215 ! schwarze 869: .It Sy "lower case character in document title"
! 870: .Pq mdoc , man
! 871: The title is still used as given in the
! 872: .Ic \&Dt
! 873: or
! 874: .Ic \&TH
! 875: macro.
1.201 schwarze 876: .It Sy "duplicate RCS id"
877: A single manual page contains two copies of the RCS identifier for
878: the same operating system.
879: Consider deleting the later instance and moving the first one up
880: to the top of the page.
1.207 schwarze 881: .It Sy "typo in section name"
882: .Pq mdoc
883: Fuzzy string matching revealed that the argument of an
884: .Ic \&Sh
885: macro is similar, but not identical to a standard section name.
1.215 ! schwarze 886: .It Sy "unterminated quoted argument"
! 887: .Pq roff
! 888: Macro arguments can be enclosed in double quote characters
! 889: such that space characters and macro names contained in the quoted
! 890: argument need not be escaped.
! 891: The closing quote of the last argument of a macro can be omitted.
! 892: However, omitting it is not recommended because it makes the code
! 893: harder to read.
1.189 schwarze 894: .It Sy "useless macro"
895: .Pq mdoc
896: A
897: .Ic \&Bt ,
898: .Ic \&Tn ,
899: or
1.190 schwarze 900: .Ic \&Ud
1.189 schwarze 901: macro was found.
1.190 schwarze 902: Simply delete it: it serves no useful purpose.
1.191 schwarze 903: .It Sy "consider using OS macro"
904: .Pq mdoc
905: A string was found in plain text or in a
906: .Ic \&Bx
907: macro that could be represented using
908: .Ic \&Ox ,
909: .Ic \&Nx ,
910: .Ic \&Fx ,
911: or
912: .Ic \&Dx .
1.195 schwarze 913: .It Sy "errnos out of order"
914: .Pq mdoc, Nx
915: The
916: .Ic \&Er
917: items in a
918: .Ic \&Bl
919: list are not in alphabetical order.
920: .It Sy "duplicate errno"
921: .Pq mdoc, Nx
922: A
923: .Ic \&Bl
924: list contains two consecutive
925: .Ic \&It
926: entries describing the same
927: .Ic \&Er
928: number.
1.213 schwarze 929: .It Sy "trailing delimiter"
1.192 schwarze 930: .Pq mdoc
1.213 schwarze 931: The last argument of an
932: .Ic \&Ex , \&Fo , \&Nd , \&Nm , \&Os , \&Sh , \&Ss , \&St ,
933: or
934: .Ic \&Sx
935: macro ends with a trailing delimiter.
936: This is usually bad style and often indicates typos.
937: Most likely, the delimiter can be removed.
1.197 schwarze 938: .It Sy "no blank before trailing delimiter"
1.198 schwarze 939: .Pq mdoc
1.197 schwarze 940: The last argument of a macro that supports trailing delimiter
941: arguments is longer than one byte and ends with a trailing delimiter.
942: Consider inserting a blank such that the delimiter becomes a separate
943: argument, thus moving it out of the scope of the macro.
1.215 ! schwarze 944: .It Sy "fill mode already enabled, skipping"
! 945: .Pq man
! 946: A
! 947: .Ic \&fi
! 948: request occurs even though the document is still in fill mode,
! 949: or already switched back to fill mode.
! 950: It has no effect.
! 951: .It Sy "fill mode already disabled, skipping"
! 952: .Pq man
! 953: An
! 954: .Ic \&nf
! 955: request occurs even though the document already switched to no-fill mode
! 956: and did not switch back to fill mode yet.
! 957: It has no effect.
1.198 schwarze 958: .It Sy "function name without markup"
959: .Pq mdoc
960: A word followed by an empty pair of parentheses occurs on a text line.
961: Consider using an
962: .Ic \&Fn
963: or
964: .Ic \&Xr
965: macro.
1.215 ! schwarze 966: .It Sy "whitespace at end of input line"
! 967: .Pq mdoc , man , roff
! 968: Whitespace at the end of input lines is almost never semantically
! 969: significant \(em but in the odd case where it might be, it is
! 970: extremely confusing when reviewing and maintaining documents.
! 971: .It Sy "bad comment style"
! 972: .Pq roff
! 973: Comment lines start with a dot, a backslash, and a double-quote character.
! 974: The
! 975: .Nm
! 976: utility treats the line as a comment line even without the backslash,
! 977: but leaving out the backslash might not be portable.
1.189 schwarze 978: .El
1.106 schwarze 979: .Ss Warnings related to the document prologue
980: .Bl -ohang
981: .It Sy "missing manual title, using UNTITLED"
982: .Pq mdoc
983: A
984: .Ic \&Dt
985: macro has no arguments, or there is no
986: .Ic \&Dt
987: macro before the first non-prologue macro.
988: .It Sy "missing manual title, using \(dq\(dq"
989: .Pq man
990: There is no
991: .Ic \&TH
992: macro, or it has no arguments.
993: .It Sy "missing manual section, using \(dq\(dq"
994: .Pq mdoc , man
995: A
996: .Ic \&Dt
997: or
998: .Ic \&TH
999: macro lacks the mandatory section argument.
1000: .It Sy "unknown manual section"
1001: .Pq mdoc
1002: The section number in a
1003: .Ic \&Dt
1004: line is invalid, but still used.
1005: .It Sy "missing date, using today's date"
1006: .Pq mdoc, man
1007: The document was parsed as
1008: .Xr mdoc 7
1009: and it has no
1010: .Ic \&Dd
1011: macro, or the
1012: .Ic \&Dd
1013: macro has no arguments or only empty arguments;
1014: or the document was parsed as
1015: .Xr man 7
1016: and it has no
1017: .Ic \&TH
1018: macro, or the
1019: .Ic \&TH
1020: macro has less than three arguments or its third argument is empty.
1021: .It Sy "cannot parse date, using it verbatim"
1022: .Pq mdoc , man
1023: The date given in a
1024: .Ic \&Dd
1025: or
1026: .Ic \&TH
1027: macro does not follow the conventional format.
1.212 schwarze 1028: .It Sy "date in the future, using it anyway"
1029: .Pq mdoc , man
1030: The date given in a
1031: .Ic \&Dd
1032: or
1033: .Ic \&TH
1034: macro is more than a day ahead of the current system
1035: .Xr time 3 .
1.106 schwarze 1036: .It Sy "missing Os macro, using \(dq\(dq"
1037: .Pq mdoc
1038: The default or current system is not shown in this case.
1039: .It Sy "late prologue macro"
1040: .Pq mdoc
1041: A
1042: .Ic \&Dd
1043: or
1044: .Ic \&Os
1045: macro occurs after some non-prologue macro, but still takes effect.
1046: .It Sy "prologue macros out of order"
1047: .Pq mdoc
1048: The prologue macros are not given in the conventional order
1049: .Ic \&Dd ,
1050: .Ic \&Dt ,
1051: .Ic \&Os .
1052: All three macros are used even when given in another order.
1053: .El
1054: .Ss Warnings regarding document structure
1055: .Bl -ohang
1056: .It Sy ".so is fragile, better use ln(1)"
1057: .Pq roff
1058: Including files only works when the parser program runs with the correct
1059: current working directory.
1060: .It Sy "no document body"
1061: .Pq mdoc , man
1062: The document body contains neither text nor macros.
1063: An empty document is shown, consisting only of a header and a footer line.
1064: .It Sy "content before first section header"
1065: .Pq mdoc , man
1066: Some macros or text precede the first
1067: .Ic \&Sh
1068: or
1069: .Ic \&SH
1070: section header.
1071: The offending macros and text are parsed and added to the top level
1072: of the syntax tree, outside any section block.
1073: .It Sy "first section is not NAME"
1074: .Pq mdoc
1075: The argument of the first
1076: .Ic \&Sh
1077: macro is not
1078: .Sq NAME .
1079: This may confuse
1080: .Xr makewhatis 8
1081: and
1082: .Xr apropos 1 .
1.168 schwarze 1083: .It Sy "NAME section without Nm before Nd"
1.106 schwarze 1084: .Pq mdoc
1.155 schwarze 1085: The NAME section does not contain any
1086: .Ic \&Nm
1.168 schwarze 1087: child macro before the first
1088: .Ic \&Nd
1089: macro.
1.155 schwarze 1090: .It Sy "NAME section without description"
1091: .Pq mdoc
1092: The NAME section lacks the mandatory
1093: .Ic \&Nd
1094: child macro.
1095: .It Sy "description not at the end of NAME"
1096: .Pq mdoc
1097: The NAME section does contain an
1.106 schwarze 1098: .Ic \&Nd
1.155 schwarze 1099: child macro, but other content follows it.
1100: .It Sy "bad NAME section content"
1101: .Pq mdoc
1102: The NAME section contains plain text or macros other than
1103: .Ic \&Nm
1.106 schwarze 1104: and
1.155 schwarze 1105: .Ic \&Nd .
1.168 schwarze 1106: .It Sy "missing comma before name"
1107: .Pq mdoc
1108: The NAME section contains an
1109: .Ic \&Nm
1110: macro that is neither the first one nor preceded by a comma.
1.142 schwarze 1111: .It Sy "missing description line, using \(dq\(dq"
1112: .Pq mdoc
1113: The
1114: .Ic \&Nd
1115: macro lacks the required argument.
1116: The title line of the manual will end after the dash.
1.177 schwarze 1117: .It Sy "description line outside NAME section"
1118: .Pq mdoc
1119: An
1120: .Ic \&Nd
1121: macro appears outside the NAME section.
1122: The arguments are printed anyway and the following text is used for
1123: .Xr apropos 1 ,
1124: but none of that behaviour is portable.
1.106 schwarze 1125: .It Sy "sections out of conventional order"
1126: .Pq mdoc
1127: A standard section occurs after another section it usually precedes.
1128: All section titles are used as given,
1129: and the order of sections is not changed.
1130: .It Sy "duplicate section title"
1131: .Pq mdoc
1132: The same standard section title occurs more than once.
1133: .It Sy "unexpected section"
1134: .Pq mdoc
1135: A standard section header occurs in a section of the manual
1136: where it normally isn't useful.
1.211 schwarze 1137: .It Sy "cross reference to self"
1138: .Pq mdoc
1139: An
1140: .Ic \&Xr
1141: macro refers to a name and section matching the section of the present
1142: manual page and a name mentioned in an
1143: .Ic \&Nm
1144: macro in the NAME or SYNOPSIS section, or in an
1145: .Ic \&Fn
1146: or
1147: .Ic \&Fo
1148: macro in the SYNOPSIS.
1149: Consider using
1150: .Ic \&Nm
1151: or
1152: .Ic \&Fn
1153: instead of
1154: .Ic \&Xr .
1.112 schwarze 1155: .It Sy "unusual Xr order"
1156: .Pq mdoc
1157: In the SEE ALSO section, an
1158: .Ic \&Xr
1159: macro with a lower section number follows one with a higher number,
1160: or two
1161: .Ic \&Xr
1.157 schwarze 1162: macros referring to the same section are out of alphabetical order.
1.112 schwarze 1163: .It Sy "unusual Xr punctuation"
1164: .Pq mdoc
1165: In the SEE ALSO section, punctuation between two
1166: .Ic \&Xr
1167: macros differs from a single comma, or there is trailing punctuation
1168: after the last
1169: .Ic \&Xr
1170: macro.
1.111 schwarze 1171: .It Sy "AUTHORS section without An macro"
1172: .Pq mdoc
1173: An AUTHORS sections contains no
1174: .Ic \&An
1175: macros, or only empty ones.
1176: Probably, there are author names lacking markup.
1.106 schwarze 1177: .El
1178: .Ss "Warnings related to macros and nesting"
1179: .Bl -ohang
1180: .It Sy "obsolete macro"
1181: .Pq mdoc
1182: See the
1183: .Xr mdoc 7
1184: manual for replacements.
1.126 schwarze 1185: .It Sy "macro neither callable nor escaped"
1186: .Pq mdoc
1187: The name of a macro that is not callable appears on a macro line.
1188: It is printed verbatim.
1.152 schwarze 1189: If the intention is to call it, move it to its own input line;
1.126 schwarze 1190: otherwise, escape it by prepending
1191: .Sq \e& .
1.106 schwarze 1192: .It Sy "skipping paragraph macro"
1193: In
1194: .Xr mdoc 7
1195: documents, this happens
1196: .Bl -dash -compact
1197: .It
1198: at the beginning and end of sections and subsections
1199: .It
1200: right before non-compact lists and displays
1201: .It
1202: at the end of items in non-column, non-compact lists
1203: .It
1204: and for multiple consecutive paragraph macros.
1205: .El
1206: In
1207: .Xr man 7
1208: documents, it happens
1209: .Bl -dash -compact
1210: .It
1211: for empty
1212: .Ic \&P ,
1213: .Ic \&PP ,
1214: and
1215: .Ic \&LP
1216: macros
1217: .It
1218: for
1219: .Ic \&IP
1220: macros having neither head nor body arguments
1221: .It
1222: for
1223: .Ic \&br
1224: or
1225: .Ic \&sp
1226: right after
1227: .Ic \&SH
1228: or
1229: .Ic \&SS
1230: .El
1231: .It Sy "moving paragraph macro out of list"
1232: .Pq mdoc
1233: A list item in a
1234: .Ic \&Bl
1235: list contains a trailing paragraph macro.
1236: The paragraph macro is moved after the end of the list.
1237: .It Sy "skipping no-space macro"
1238: .Pq mdoc
1239: An input line begins with an
1240: .Ic \&Ns
1.208 schwarze 1241: macro, or the next argument after an
1242: .Ic \&Ns
1243: macro is an isolated closing delimiter.
1.106 schwarze 1244: The macro is ignored.
1245: .It Sy "blocks badly nested"
1246: .Pq mdoc
1247: If two blocks intersect, one should completely contain the other.
1248: Otherwise, rendered output is likely to look strange in any output
1249: format, and rendering in SGML-based output formats is likely to be
1250: outright wrong because such languages do not support badly nested
1251: blocks at all.
1252: Typical examples of badly nested blocks are
1253: .Qq Ic \&Ao \&Bo \&Ac \&Bc
1254: and
1255: .Qq Ic \&Ao \&Bq \&Ac .
1256: In these examples,
1257: .Ic \&Ac
1258: breaks
1259: .Ic \&Bo
1260: and
1261: .Ic \&Bq ,
1262: respectively.
1263: .It Sy "nested displays are not portable"
1264: .Pq mdoc
1265: A
1266: .Ic \&Bd ,
1267: .Ic \&D1 ,
1268: or
1269: .Ic \&Dl
1270: display occurs nested inside another
1271: .Ic \&Bd
1272: display.
1273: This works with
1274: .Nm ,
1275: but fails with most other implementations.
1276: .It Sy "moving content out of list"
1277: .Pq mdoc
1278: A
1279: .Ic \&Bl
1280: list block contains text or macros before the first
1281: .Ic \&It
1282: macro.
1283: The offending children are moved before the beginning of the list.
1.209 schwarze 1284: .It Sy "first macro on line"
1285: Inside a
1286: .Ic \&Bl Fl column
1287: list, a
1288: .Ic \&Ta
1289: macro occurs as the first macro on a line, which is not portable.
1.106 schwarze 1290: .It Sy "line scope broken"
1291: .Pq man
1292: While parsing the next-line scope of the previous macro,
1293: another macro is found that prematurely terminates the previous one.
1294: The previous, interrupted macro is deleted from the parse tree.
1295: .El
1296: .Ss "Warnings related to missing arguments"
1297: .Bl -ohang
1298: .It Sy "skipping empty request"
1.118 schwarze 1299: .Pq roff , eqn
1300: The macro name is missing from a macro definition request,
1301: or an
1302: .Xr eqn 7
1303: control statement or operation keyword lacks its required argument.
1.106 schwarze 1304: .It Sy "conditional request controls empty scope"
1305: .Pq roff
1306: A conditional request is only useful if any of the following
1307: follows it on the same logical input line:
1308: .Bl -dash -compact
1309: .It
1310: The
1311: .Sq \e{
1312: keyword to open a multi-line scope.
1313: .It
1314: A request or macro or some text, resulting in a single-line scope.
1315: .It
1316: The immediate end of the logical line without any intervening whitespace,
1317: resulting in next-line scope.
1318: .El
1319: Here, a conditional request is followed by trailing whitespace only,
1320: and there is no other content on its logical input line.
1321: Note that it doesn't matter whether the logical input line is split
1322: across multiple physical input lines using
1323: .Sq \e
1324: line continuation characters.
1325: This is one of the rare cases
1326: where trailing whitespace is syntactically significant.
1327: The conditional request controls a scope containing whitespace only,
1328: so it is unlikely to have a significant effect,
1329: except that it may control a following
1330: .Ic \&el
1331: clause.
1332: .It Sy "skipping empty macro"
1333: .Pq mdoc
1.147 schwarze 1334: The indicated macro has no arguments and hence no effect.
1335: .It Sy "empty block"
1336: .Pq mdoc , man
1337: A
1338: .Ic \&Bd ,
1339: .Ic \&Bk ,
1340: .Ic \&Bl ,
1341: .Ic \&D1 ,
1342: .Ic \&Dl ,
1.206 schwarze 1343: .Ic \&MT ,
1.147 schwarze 1344: .Ic \&RS ,
1345: or
1346: .Ic \&UR
1347: block contains nothing in its body and will produce no output.
1.106 schwarze 1348: .It Sy "empty argument, using 0n"
1349: .Pq mdoc
1350: The required width is missing after
1351: .Ic \&Bd
1352: or
1353: .Ic \&Bl
1354: .Fl offset
1355: or
1.186 schwarze 1356: .Fl width .
1.106 schwarze 1357: .It Sy "missing display type, using -ragged"
1358: .Pq mdoc
1359: The
1360: .Ic \&Bd
1361: macro is invoked without the required display type.
1362: .It Sy "list type is not the first argument"
1363: .Pq mdoc
1364: In a
1365: .Ic \&Bl
1366: macro, at least one other argument precedes the type argument.
1367: The
1368: .Nm
1369: utility copes with any argument order, but some other
1370: .Xr mdoc 7
1371: implementations do not.
1372: .It Sy "missing -width in -tag list, using 8n"
1373: .Pq mdoc
1374: Every
1375: .Ic \&Bl
1376: macro having the
1377: .Fl tag
1378: argument requires
1379: .Fl width ,
1380: too.
1381: .It Sy "missing utility name, using \(dq\(dq"
1382: .Pq mdoc
1383: The
1384: .Ic \&Ex Fl std
1385: macro is called without an argument before
1386: .Ic \&Nm
1387: has first been called with an argument.
1.146 schwarze 1388: .It Sy "missing function name, using \(dq\(dq"
1389: .Pq mdoc
1390: The
1391: .Ic \&Fo
1392: macro is called without an argument.
1393: No function name is printed.
1.106 schwarze 1394: .It Sy "empty head in list item"
1395: .Pq mdoc
1396: In a
1397: .Ic \&Bl
1398: .Fl diag ,
1399: .Fl hang ,
1400: .Fl inset ,
1401: .Fl ohang ,
1402: or
1403: .Fl tag
1404: list, an
1405: .Ic \&It
1406: macro lacks the required argument.
1407: The item head is left empty.
1408: .It Sy "empty list item"
1409: .Pq mdoc
1410: In a
1411: .Ic \&Bl
1412: .Fl bullet ,
1413: .Fl dash ,
1414: .Fl enum ,
1415: or
1416: .Fl hyphen
1417: list, an
1418: .Ic \&It
1419: block is empty.
1420: An empty list item is shown.
1.209 schwarze 1421: .It Sy "missing argument, using next line"
1422: .Pq mdoc
1423: An
1424: .Ic \&It
1425: macro in a
1426: .Ic \&Bd Fl column
1427: list has no arguments.
1428: While
1429: .Nm
1430: uses the text or macros of the following line, if any, for the cell,
1431: other formatters may misformat the list.
1.152 schwarze 1432: .It Sy "missing font type, using \efR"
1.106 schwarze 1433: .Pq mdoc
1434: A
1435: .Ic \&Bf
1436: macro has no argument.
1.152 schwarze 1437: It switches to the default font.
1438: .It Sy "unknown font type, using \efR"
1.106 schwarze 1439: .Pq mdoc
1440: The
1441: .Ic \&Bf
1442: argument is invalid.
1.152 schwarze 1443: The default font is used instead.
1.127 schwarze 1444: .It Sy "nothing follows prefix"
1445: .Pq mdoc
1446: A
1447: .Ic \&Pf
1448: macro has no argument, or only one argument and no macro follows
1449: on the same input line.
1450: This defeats its purpose; in particular, spacing is not suppressed
1451: before the text or macros following on the next input line.
1.143 schwarze 1452: .It Sy "empty reference block"
1453: .Pq mdoc
1454: An
1455: .Ic \&Rs
1456: macro is immediately followed by an
1457: .Ic \&Re
1458: macro on the next input line.
1459: Such an empty block does not produce any output.
1.165 schwarze 1460: .It Sy "missing section argument"
1461: .Pq mdoc
1462: An
1463: .Ic \&Xr
1464: macro lacks its second, section number argument.
1465: The first argument, i.e. the name, is printed, but without subsequent
1.166 schwarze 1466: parentheses.
1.106 schwarze 1467: .It Sy "missing -std argument, adding it"
1468: .Pq mdoc
1469: An
1470: .Ic \&Ex
1471: or
1472: .Ic \&Rv
1473: macro lacks the required
1474: .Fl std
1475: argument.
1476: The
1477: .Nm
1478: utility assumes
1479: .Fl std
1480: even when it is not specified, but other implementations may not.
1.150 schwarze 1481: .It Sy "missing option string, using \(dq\(dq"
1482: .Pq man
1483: The
1484: .Ic \&OP
1485: macro is invoked without any argument.
1486: An empty pair of square brackets is shown.
1487: .It Sy "missing resource identifier, using \(dq\(dq"
1488: .Pq man
1489: The
1.206 schwarze 1490: .Ic \&MT
1491: or
1.150 schwarze 1492: .Ic \&UR
1493: macro is invoked without any argument.
1494: An empty pair of angle brackets is shown.
1.118 schwarze 1495: .It Sy "missing eqn box, using \(dq\(dq"
1496: .Pq eqn
1497: A diacritic mark or a binary operator is found,
1498: but there is nothing to the left of it.
1499: An empty box is inserted.
1.106 schwarze 1500: .El
1501: .Ss "Warnings related to bad macro arguments"
1502: .Bl -ohang
1503: .It Sy "duplicate argument"
1504: .Pq mdoc
1505: A
1506: .Ic \&Bd
1507: or
1508: .Ic \&Bl
1509: macro has more than one
1510: .Fl compact ,
1511: more than one
1512: .Fl offset ,
1513: or more than one
1514: .Fl width
1515: argument.
1516: All but the last instances of these arguments are ignored.
1517: .It Sy "skipping duplicate argument"
1518: .Pq mdoc
1519: An
1520: .Ic \&An
1521: macro has more than one
1522: .Fl split
1523: or
1524: .Fl nosplit
1525: argument.
1526: All but the first of these arguments are ignored.
1527: .It Sy "skipping duplicate display type"
1528: .Pq mdoc
1529: A
1530: .Ic \&Bd
1531: macro has more than one type argument; the first one is used.
1532: .It Sy "skipping duplicate list type"
1533: .Pq mdoc
1534: A
1535: .Ic \&Bl
1536: macro has more than one type argument; the first one is used.
1537: .It Sy "skipping -width argument"
1538: .Pq mdoc
1539: A
1540: .Ic \&Bl
1541: .Fl column ,
1542: .Fl diag ,
1543: .Fl ohang ,
1544: .Fl inset ,
1545: or
1546: .Fl item
1547: list has a
1548: .Fl width
1549: argument.
1550: That has no effect.
1.151 schwarze 1551: .It Sy "wrong number of cells"
1552: In a line of a
1553: .Ic \&Bl Fl column
1554: list, the number of tabs or
1555: .Ic \&Ta
1556: macros is less than the number expected from the list header line
1557: or exceeds the expected number by more than one.
1558: Missing cells remain empty, and all cells exceeding the number of
1559: columns are joined into one single cell.
1.106 schwarze 1560: .It Sy "unknown AT&T UNIX version"
1561: .Pq mdoc
1562: An
1563: .Ic \&At
1564: macro has an invalid argument.
1565: It is used verbatim, with
1566: .Qq "AT&T UNIX "
1567: prefixed to it.
1.113 schwarze 1568: .It Sy "comma in function argument"
1569: .Pq mdoc
1570: An argument of an
1571: .Ic \&Fa
1572: or
1573: .Ic \&Fn
1574: macro contains a comma; it should probably be split into two arguments.
1.117 schwarze 1575: .It Sy "parenthesis in function name"
1576: .Pq mdoc
1577: The first argument of an
1578: .Ic \&Fc
1579: or
1580: .Ic \&Fn
1581: macro contains an opening or closing parenthesis; that's probably wrong,
1582: parentheses are added automatically.
1.196 schwarze 1583: .It Sy "unknown library name"
1584: .Pq mdoc, not on Ox
1585: An
1586: .Ic \&Lb
1587: macro has an unknown name argument and will be rendered as
1588: .Qq library Dq Ar name .
1.106 schwarze 1589: .It Sy "invalid content in Rs block"
1590: .Pq mdoc
1591: An
1592: .Ic \&Rs
1593: block contains plain text or non-% macros.
1594: The bogus content is left in the syntax tree.
1595: Formatting may be poor.
1596: .It Sy "invalid Boolean argument"
1597: .Pq mdoc
1598: An
1599: .Ic \&Sm
1600: macro has an argument other than
1601: .Cm on
1602: or
1603: .Cm off .
1604: The invalid argument is moved out of the macro, which leaves the macro
1605: empty, causing it to toggle the spacing mode.
1606: .It Sy "unknown font, skipping request"
1.115 schwarze 1607: .Pq man , tbl
1.106 schwarze 1608: A
1609: .Xr roff 7
1610: .Ic \&ft
1.115 schwarze 1611: request or a
1612: .Xr tbl 7
1613: .Ic \&f
1614: layout modifier has an unknown
1615: .Ar font
1616: argument.
1.151 schwarze 1617: .It Sy "odd number of characters in request"
1618: .Pq roff
1619: A
1620: .Ic \&tr
1621: request contains an odd number of characters.
1622: The last character is mapped to the blank character.
1.106 schwarze 1623: .El
1624: .Ss "Warnings related to plain text"
1625: .Bl -ohang
1626: .It Sy "blank line in fill mode, using .sp"
1627: .Pq mdoc
1628: The meaning of blank input lines is only well-defined in non-fill mode:
1629: In fill mode, line breaks of text input lines are not supposed to be
1630: significant.
1631: However, for compatibility with groff, blank lines in fill mode
1632: are replaced with
1633: .Ic \&sp
1634: requests.
1635: .It Sy "tab in filled text"
1636: .Pq mdoc , man
1637: The meaning of tab characters is only well-defined in non-fill mode:
1638: In fill mode, whitespace is not supposed to be significant
1639: on text input lines.
1640: As an implementation dependent choice, tab characters on text lines
1641: are passed through to the formatters in any case.
1642: Given that the text before the tab character will be filled,
1643: it is hard to predict which tab stop position the tab will advance to.
1.172 schwarze 1644: .It Sy "new sentence, new line"
1645: .Pq mdoc
1646: A new sentence starts in the middle of a text line.
1647: Start it on a new input line to help formatters produce correct spacing.
1.106 schwarze 1648: .It Sy "invalid escape sequence"
1649: .Pq roff
1650: An escape sequence has an invalid opening argument delimiter, lacks the
1651: closing argument delimiter, or the argument has too few characters.
1652: If the argument is incomplete,
1653: .Ic \e*
1654: and
1655: .Ic \en
1656: expand to an empty string,
1657: .Ic \eB
1658: to the digit
1659: .Sq 0 ,
1660: and
1661: .Ic \ew
1662: to the length of the incomplete argument.
1663: All other invalid escape sequences are ignored.
1664: .It Sy "undefined string, using \(dq\(dq"
1665: .Pq roff
1666: If a string is used without being defined before,
1667: its value is implicitly set to the empty string.
1668: However, defining strings explicitly before use
1669: keeps the code more readable.
1670: .El
1.138 schwarze 1671: .Ss "Warnings related to tables"
1672: .Bl -ohang
1673: .It Sy "tbl line starts with span"
1674: .Pq tbl
1675: The first cell in a table layout line is a horizontal span
1676: .Pq Sq Cm s .
1677: Data provided for this cell is ignored, and nothing is printed in the cell.
1678: .It Sy "tbl column starts with span"
1679: .Pq tbl
1680: The first line of a table layout specification
1681: requests a vertical span
1682: .Pq Sq Cm ^ .
1683: Data provided for this cell is ignored, and nothing is printed in the cell.
1684: .It Sy "skipping vertical bar in tbl layout"
1685: .Pq tbl
1686: A table layout specification contains more than two consecutive vertical bars.
1687: A double bar is printed, all additional bars are discarded.
1.106 schwarze 1688: .El
1689: .Ss "Errors related to tables"
1.136 schwarze 1690: .Bl -ohang
1691: .It Sy "non-alphabetic character in tbl options"
1692: .Pq tbl
1693: The table options line contains a character other than a letter,
1694: blank, or comma where the beginning of an option name is expected.
1695: The character is ignored.
1696: .It Sy "skipping unknown tbl option"
1697: .Pq tbl
1698: The table options line contains a string of letters that does not
1699: match any known option name.
1700: The word is ignored.
1701: .It Sy "missing tbl option argument"
1702: .Pq tbl
1703: A table option that requires an argument is not followed by an
1704: opening parenthesis, or the opening parenthesis is immediately
1705: followed by a closing parenthesis.
1706: The option is ignored.
1707: .It Sy "wrong tbl option argument size"
1708: .Pq tbl
1709: A table option argument contains an invalid number of characters.
1710: Both the option and the argument are ignored.
1.138 schwarze 1711: .It Sy "empty tbl layout"
1712: .Pq tbl
1713: A table layout specification is completely empty,
1714: specifying zero lines and zero columns.
1715: As a fallback, a single left-justified column is used.
1716: .It Sy "invalid character in tbl layout"
1717: .Pq tbl
1718: A table layout specification contains a character that can neither
1719: be interpreted as a layout key character nor as a layout modifier,
1720: or a modifier precedes the first key.
1721: The invalid character is discarded.
1722: .It Sy "unmatched parenthesis in tbl layout"
1723: .Pq tbl
1724: A table layout specification contains an opening parenthesis,
1725: but no matching closing parenthesis.
1726: The rest of the input line, starting from the parenthesis, has no effect.
1.139 schwarze 1727: .It Sy "tbl without any data cells"
1728: .Pq tbl
1729: A table does not contain any data cells.
1730: It will probably produce no output.
1731: .It Sy "ignoring data in spanned tbl cell"
1732: .Pq tbl
1733: A table cell is marked as a horizontal span
1734: .Pq Sq Cm s
1735: or vertical span
1736: .Pq Sq Cm ^
1737: in the table layout, but it contains data.
1738: The data is ignored.
1739: .It Sy "ignoring extra tbl data cells"
1740: .Pq tbl
1741: A data line contains more cells than the corresponding layout line.
1742: The data in the extra cells is ignored.
1743: .It Sy "data block open at end of tbl"
1744: .Pq tbl
1745: A data block is opened with
1746: .Cm T{ ,
1747: but never closed with a matching
1748: .Cm T} .
1749: The remaining data lines of the table are all put into one cell,
1750: and any remaining cells stay empty.
1.106 schwarze 1751: .El
1752: .Ss "Errors related to roff, mdoc, and man code"
1753: .Bl -ohang
1.215 ! schwarze 1754: .It Sy "duplicate prologue macro"
! 1755: .Pq mdoc
! 1756: One of the prologue macros occurs more than once.
! 1757: The last instance overrides all previous ones.
! 1758: .It Sy "skipping late title macro"
! 1759: .Pq mdoc
! 1760: The
! 1761: .Ic \&Dt
! 1762: macro appears after the first non-prologue macro.
! 1763: Traditional formatters cannot handle this because
! 1764: they write the page header before parsing the document body.
! 1765: Even though this technical restriction does not apply to
! 1766: .Nm ,
! 1767: traditional semantics is preserved.
! 1768: The late macro is discarded including its arguments.
1.106 schwarze 1769: .It Sy "input stack limit exceeded, infinite loop?"
1770: .Pq roff
1771: Explicit recursion limits are implemented for the following features,
1772: in order to prevent infinite loops:
1773: .Bl -dash -compact
1774: .It
1775: expansion of nested escape sequences
1776: including expansion of strings and number registers,
1777: .It
1778: expansion of nested user-defined macros,
1779: .It
1780: and
1781: .Ic \&so
1782: file inclusion.
1783: .El
1784: When a limit is hit, the output is incorrect, typically losing
1785: some content, but the parser can continue.
1786: .It Sy "skipping bad character"
1787: .Pq mdoc , man , roff
1788: The input file contains a byte that is not a printable
1789: .Xr ascii 7
1790: character.
1791: The message mentions the character number.
1792: The offending byte is replaced with a question mark
1793: .Pq Sq \&? .
1794: Consider editing the input file to replace the byte with an ASCII
1795: transliteration of the intended character.
1796: .It Sy "skipping unknown macro"
1797: .Pq mdoc , man , roff
1798: The first identifier on a request or macro line is neither recognized as a
1799: .Xr roff 7
1800: request, nor as a user-defined macro, nor, respectively, as an
1801: .Xr mdoc 7
1802: or
1803: .Xr man 7
1804: macro.
1805: It may be mistyped or unsupported.
1806: The request or macro is discarded including its arguments.
1.133 schwarze 1807: .It Sy "skipping insecure request"
1808: .Pq roff
1809: An input file attempted to run a shell command
1810: or to read or write an external file.
1811: Such attempts are denied for security reasons.
1.106 schwarze 1812: .It Sy "skipping item outside list"
1.118 schwarze 1813: .Pq mdoc , eqn
1.106 schwarze 1814: An
1815: .Ic \&It
1816: macro occurs outside any
1817: .Ic \&Bl
1.118 schwarze 1818: list, or an
1819: .Xr eqn 7
1820: .Ic above
1821: delimiter occurs outside any pile.
1.106 schwarze 1822: It is discarded including its arguments.
1823: .It Sy "skipping column outside column list"
1824: .Pq mdoc
1825: A
1826: .Ic \&Ta
1827: macro occurs outside any
1828: .Ic \&Bl Fl column
1829: block.
1830: It is discarded including its arguments.
1831: .It Sy "skipping end of block that is not open"
1832: .Pq mdoc , man , eqn , tbl , roff
1833: Various syntax elements can only be used to explicitly close blocks
1834: that have previously been opened.
1835: An
1836: .Xr mdoc 7
1837: block closing macro, a
1838: .Xr man 7
1.206 schwarze 1839: .Ic \&ME , \&RE
1.106 schwarze 1840: or
1841: .Ic \&UE
1.118 schwarze 1842: macro, an
1843: .Xr eqn 7
1844: right delimiter or closing brace, or the end of an equation, table, or
1.106 schwarze 1845: .Xr roff 7
1846: conditional request is encountered but no matching block is open.
1847: The offending request or macro is discarded.
1.135 schwarze 1848: .It Sy "fewer RS blocks open, skipping"
1849: .Pq man
1850: The
1851: .Ic \&RE
1852: macro is invoked with an argument, but less than the specified number of
1853: .Ic \&RS
1854: blocks is open.
1855: The
1856: .Ic \&RE
1857: macro is discarded.
1.106 schwarze 1858: .It Sy "inserting missing end of block"
1859: .Pq mdoc , tbl
1860: Various
1861: .Xr mdoc 7
1862: macros as well as tables require explicit closing by dedicated macros.
1863: A block that doesn't support bad nesting
1864: ends before all of its children are properly closed.
1865: The open child nodes are closed implicitly.
1.152 schwarze 1866: .It Sy "appending missing end of block"
1.106 schwarze 1867: .Pq mdoc , man , eqn , tbl , roff
1868: At the end of the document, an explicit
1869: .Xr mdoc 7
1870: block, a
1871: .Xr man 7
1872: next-line scope or
1.206 schwarze 1873: .Ic \&MT , \&RS
1.106 schwarze 1874: or
1875: .Ic \&UR
1876: block, an equation, table, or
1877: .Xr roff 7
1878: conditional or ignore block is still open.
1879: The open block is closed implicitly.
1880: .It Sy "escaped character not allowed in a name"
1881: .Pq roff
1882: Macro, string and register identifiers consist of printable,
1883: non-whitespace ASCII characters.
1884: Escape sequences and characters and strings expressed in terms of them
1885: cannot form part of a name.
1886: The first argument of an
1887: .Ic \&am ,
1888: .Ic \&as ,
1889: .Ic \&de ,
1890: .Ic \&ds ,
1891: .Ic \&nr ,
1892: or
1893: .Ic \&rr
1894: request, or any argument of an
1895: .Ic \&rm
1896: request, or the name of a request or user defined macro being called,
1897: is terminated by an escape sequence.
1898: In the cases of
1899: .Ic \&as ,
1900: .Ic \&ds ,
1901: and
1902: .Ic \&nr ,
1903: the request has no effect at all.
1904: In the cases of
1905: .Ic \&am ,
1906: .Ic \&de ,
1907: .Ic \&rr ,
1908: and
1909: .Ic \&rm ,
1910: what was parsed up to this point is used as the arguments to the request,
1911: and the rest of the input line is discarded including the escape sequence.
1912: When parsing for a request or a user-defined macro name to be called,
1913: only the escape sequence is discarded.
1914: The characters preceding it are used as the request or macro name,
1915: the characters following it are used as the arguments to the request or macro.
1.124 schwarze 1916: .It Sy "NOT IMPLEMENTED: Bd -file"
1917: .Pq mdoc
1918: For security reasons, the
1919: .Ic \&Bd
1920: macro does not support the
1921: .Fl file
1922: argument.
1923: By requesting the inclusion of a sensitive file, a malicious document
1924: might otherwise trick a privileged user into inadvertently displaying
1925: the file on the screen, revealing the file content to bystanders.
1926: The argument is ignored including the file name following it.
1.163 schwarze 1927: .It Sy "skipping display without arguments"
1928: .Pq mdoc
1929: A
1930: .Ic \&Bd
1931: block macro does not have any arguments.
1932: The block is discarded, and the block content is displayed in
1933: whatever mode was active before the block.
1.106 schwarze 1934: .It Sy "missing list type, using -item"
1935: .Pq mdoc
1936: A
1937: .Ic \&Bl
1938: macro fails to specify the list type.
1.194 schwarze 1939: .It Sy "argument is not numeric, using 1"
1940: .Pq roff
1941: The argument of a
1942: .Ic \&ce
1943: request is not a number.
1.106 schwarze 1944: .It Sy "missing manual name, using \(dq\(dq"
1945: .Pq mdoc
1946: The first call to
1.168 schwarze 1947: .Ic \&Nm ,
1948: or any call in the NAME section, lacks the required argument.
1.106 schwarze 1949: .It Sy "uname(3) system call failed, using UNKNOWN"
1950: .Pq mdoc
1951: The
1952: .Ic \&Os
1953: macro is called without arguments, and the
1954: .Xr uname 3
1955: system call failed.
1956: As a workaround,
1957: .Nm
1958: can be compiled with
1959: .Sm off
1960: .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
1961: .Sm on
1962: .It Sy "unknown standard specifier"
1963: .Pq mdoc
1964: An
1965: .Ic \&St
1966: macro has an unknown argument and is discarded.
1967: .It Sy "skipping request without numeric argument"
1.118 schwarze 1968: .Pq roff , eqn
1.106 schwarze 1969: An
1970: .Ic \&it
1.118 schwarze 1971: request or an
1972: .Xr eqn 7
1973: .Ic \&size
1974: or
1975: .Ic \&gsize
1976: statement has a non-numeric or negative argument or no argument at all.
1977: The invalid request or statement is ignored.
1.132 schwarze 1978: .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
1979: .Pq roff
1980: For security reasons,
1981: .Nm
1982: allows
1983: .Ic \&so
1984: file inclusion requests only with relative paths
1985: and only without ascending to any parent directory.
1986: By requesting the inclusion of a sensitive file, a malicious document
1987: might otherwise trick a privileged user into inadvertently displaying
1988: the file on the screen, revealing the file content to bystanders.
1989: .Nm
1990: only shows the path as it appears behind
1991: .Ic \&so .
1992: .It Sy ".so request failed"
1993: .Pq roff
1994: Servicing a
1995: .Ic \&so
1996: request requires reading an external file, but the file could not be
1997: opened.
1998: .Nm
1999: only shows the path as it appears behind
2000: .Ic \&so .
1.106 schwarze 2001: .It Sy "skipping all arguments"
2002: .Pq mdoc , man , eqn , roff
2003: An
2004: .Xr mdoc 7
2005: .Ic \&Bt ,
2006: .Ic \&Ed ,
2007: .Ic \&Ef ,
2008: .Ic \&Ek ,
2009: .Ic \&El ,
1.144 schwarze 2010: .Ic \&Lp ,
2011: .Ic \&Pp ,
1.106 schwarze 2012: .Ic \&Re ,
1.143 schwarze 2013: .Ic \&Rs ,
1.106 schwarze 2014: or
2015: .Ic \&Ud
2016: macro, an
2017: .Ic \&It
2018: macro in a list that don't support item heads, a
2019: .Xr man 7
2020: .Ic \&LP ,
2021: .Ic \&P ,
2022: or
2023: .Ic \&PP
2024: macro, an
2025: .Xr eqn 7
1.120 schwarze 2026: .Ic \&EQ
2027: or
1.106 schwarze 2028: .Ic \&EN
2029: macro, or a
2030: .Xr roff 7
1.148 schwarze 2031: .Ic \&br ,
2032: .Ic \&fi ,
2033: or
2034: .Ic \&nf
1.144 schwarze 2035: request or
1.106 schwarze 2036: .Sq \&..
2037: block closing request is invoked with at least one argument.
2038: All arguments are ignored.
2039: .It Sy "skipping excess arguments"
1.135 schwarze 2040: .Pq mdoc , man , roff
1.150 schwarze 2041: A macro or request is invoked with too many arguments:
2042: .Bl -dash -offset 2n -width 2n -compact
2043: .It
2044: .Ic \&Fo ,
1.206 schwarze 2045: .Ic \&MT ,
1.150 schwarze 2046: .Ic \&PD ,
2047: .Ic \&RS ,
2048: .Ic \&UR ,
2049: .Ic \&ft ,
2050: or
2051: .Ic \&sp
2052: with more than one argument
2053: .It
1.144 schwarze 2054: .Ic \&An
1.150 schwarze 2055: with another argument after
1.144 schwarze 2056: .Fl split
2057: or
1.150 schwarze 2058: .Fl nosplit
2059: .It
2060: .Ic \&RE
2061: with more than one argument or with a non-integer argument
2062: .It
2063: .Ic \&OP
2064: or a request of the
2065: .Ic \&de
2066: family with more than two arguments
1.154 schwarze 2067: .It
2068: .Ic \&Dt
2069: with more than three arguments
1.150 schwarze 2070: .It
2071: .Ic \&TH
2072: with more than five arguments
2073: .It
1.145 schwarze 2074: .Ic \&Bd ,
2075: .Ic \&Bk ,
2076: or
2077: .Ic \&Bl
1.150 schwarze 2078: with invalid arguments
2079: .El
1.106 schwarze 2080: The excess arguments are ignored.
1.133 schwarze 2081: .El
2082: .Ss Unsupported features
2083: .Bl -ohang
2084: .It Sy "input too large"
2085: .Pq mdoc , man
2086: Currently,
2087: .Nm
2088: cannot handle input files larger than its arbitrary size limit
2089: of 2^31 bytes (2 Gigabytes).
2090: Since useful manuals are always small, this is not a problem in practice.
2091: Parsing is aborted as soon as the condition is detected.
1.136 schwarze 2092: .It Sy "unsupported control character"
2093: .Pq roff
2094: An ASCII control character supported by other
2095: .Xr roff 7
2096: implementations but not by
2097: .Nm
2098: was found in an input file.
2099: It is replaced by a question mark.
1.133 schwarze 2100: .It Sy "unsupported roff request"
2101: .Pq roff
2102: An input file contains a
2103: .Xr roff 7
2104: request supported by GNU troff or Heirloom troff but not by
2105: .Nm ,
2106: and it is likely that this will cause information loss
2107: or considerable misformatting.
1.139 schwarze 2108: .It Sy "eqn delim option in tbl"
2109: .Pq eqn , tbl
2110: The options line of a table defines equation delimiters.
2111: Any equation source code contained in the table will be printed unformatted.
2112: .It Sy "unsupported table layout modifier"
1.138 schwarze 2113: .Pq tbl
2114: A table layout specification contains an
2115: .Sq Cm m
2116: modifier.
2117: The modifier is discarded.
1.133 schwarze 2118: .It Sy "ignoring macro in table"
1.139 schwarze 2119: .Pq tbl , mdoc , man
2120: A table contains an invocation of an
2121: .Xr mdoc 7
2122: or
2123: .Xr man 7
2124: macro or of an undefined macro.
2125: The macro is ignored, and its arguments are handled
2126: as if they were a text line.
1.106 schwarze 2127: .El
1.1 kristaps 2128: .Sh SEE ALSO
1.141 schwarze 2129: .Xr apropos 1 ,
2130: .Xr man 1 ,
1.85 kristaps 2131: .Xr eqn 7 ,
1.57 kristaps 2132: .Xr man 7 ,
1.13 kristaps 2133: .Xr mandoc_char 7 ,
1.84 kristaps 2134: .Xr mdoc 7 ,
2135: .Xr roff 7 ,
2136: .Xr tbl 7
1.173 schwarze 2137: .Sh HISTORY
2138: The
2139: .Nm
2140: utility first appeared in
2141: .Ox 4.8 .
2142: The option
2143: .Fl I
2144: appeared in
2145: .Ox 5.2 ,
2146: and
2147: .Fl aCcfhKklMSsw
2148: in
2149: .Ox 5.7 .
1.1 kristaps 2150: .Sh AUTHORS
1.156 schwarze 2151: .An -nosplit
1.1 kristaps 2152: The
2153: .Nm
1.26 kristaps 2154: utility was written by
1.141 schwarze 2155: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
2156: and is maintained by
2157: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
CVSweb