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