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