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