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