1 .\" $Id: mandoc.1,v 1.214 2017/07/04 14:40:38 schwarze Exp $
3 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 .\" Copyright (c) 2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
6 .\" Permission to use, copy, modify, and distribute this software for any
7 .\" purpose with or without fee is hereby granted, provided that the above
8 .\" copyright notice and this permission notice appear in all copies.
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.
18 .Dd $Mdocdate: July 4 2017 $
23 .Nd format manual pages
27 .Op Fl I Cm os Ns = Ns Ar name
39 manual pages for display.
47 text from stdin and produces
51 The options are as follows:
54 If the standard output is a terminal device and
58 to paginate the output, just like
62 Copy the formatted manual pages to the standard output without using
66 It can be specified to override
68 .It Fl I Cm os Ns = Ns Ar name
69 Override the default operating system
79 Specify the input encoding.
87 If not specified, autodetection uses the first match in the following
91 If the first three bytes of the input file are the UTF-8 byte order
92 mark (BOM, 0xefbbbf), input is interpreted as
95 If the first or second line of the input file matches the
99 .D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-
101 then input is interpreted according to
104 If the first non-ASCII byte in the file introduces a valid UTF-8
105 sequence, input is interpreted as
108 Otherwise, input is interpreted as
114 all input files are interpreted as
118 all input files are interpreted as
120 By default, the input language is automatically detected for each file:
121 if the the first macro is
127 parser is used; otherwise, the
130 With other arguments,
134 Comma-separated output options.
139 for available formats.
143 Specify the minimum message
145 to be reported on the standard error output and to affect the exit status.
157 level automatically derives the operating system from the contents of the
161 command line option, or from the
170 that bypass autodetection and request validation of base system
171 conventions for a particular operating system.
189 to exit after parsing a file that causes warnings or errors of at least
191 No formatted output will be produced from that file.
196 are requested, they can be joined with a comma, for example
197 .Fl W Cm error , Ns Cm stop .
199 Read input from zero or more files.
200 If unspecified, reads from stdin.
201 If multiple files are specified,
203 will halt with the first failed parse.
208 are also supported and are documented in man(1).
215 also supports the options
222 are mutually exclusive and override each other.
226 utility accepts the following
228 arguments, which correspond to output modes:
229 .Bl -tag -width "-T markdown"
231 Produce 7-bit ASCII output.
235 Produce HTML5, CSS1, and MathML output.
239 Parse only: produce no output.
243 Encode output using the current locale.
258 .Sx Markdown Output .
264 Produce PostScript output.
266 .Sx PostScript Output .
268 Produce an indented parse tree.
270 .Sx Syntax tree output .
272 Encode output in the UTF\-8 multi-byte format.
277 If multiple input files are specified, these will be processed by the
278 corresponding filter in-order.
282 is rendered in standard 7-bit ASCII documented in
285 Font styles are applied by using back-spaced encoding such that an
289 .Sq _ Ns \e[bs] Ns c ,
292 is the back-space character number 8.
293 Emboldened characters are rendered as
294 .Sq c Ns \e[bs] Ns c .
296 The special characters documented in
298 are rendered best-effort in an ASCII equivalent.
300 Output width is limited to 78 visible columns unless literal input lines
305 arguments are accepted:
307 .It Cm indent Ns = Ns Ar indent
308 The left margin for normal text is set to
310 blank characters instead of the default of five for
314 Increasing this is not recommended; it may result in degraded formatting,
315 for example overfull lines or ugly line breaks.
316 .It Cm width Ns = Ns Ar width
317 The output width is set to
323 conforms to HTML5 using optional self-closing tags.
324 Default styles use only CSS1.
325 Equations rendered from
331 file documents style-sheet classes available for customising output.
332 If a style-sheet is not specified with
335 defaults to simple output (via an embedded style-sheet)
336 readable in any graphical or text-based web
339 Special characters are rendered in decimal-encoded UTF\-8.
343 arguments are accepted:
346 Omit the <!DOCTYPE> declaration and the <html>, <head>, and <body>
347 elements and only emit the subtree below the <body> element.
350 argument will be ignored.
351 This is useful when embedding manual content within existing documents.
352 .It Cm includes Ns = Ns Ar fmt
357 is used as a template for linked header files (usually via the
362 are replaced with the include filename.
363 The default is not to present a
365 .It Cm man Ns = Ns Ar fmt
369 .Ar ../html%S/%N.%S.html ,
370 is used as a template for linked manuals (usually via the
377 are replaced with the linked manual's name and section, respectively.
378 If no section is included, section 1 is assumed.
379 The default is not to
381 .It Cm style Ns = Ns Ar style.css
384 is used for an external style-sheet.
385 This must be a valid absolute or
389 Locale-depending output encoding is triggered with
393 This option is not available on all systems: systems without locale
394 support, or those whose internal representation is not natively UCS-4,
399 for font style specification and available command-line arguments.
401 Translate input format into
404 This is useful for distributing manual sources to legacy systems
411 is passed as input, it is translated into
413 If the input format is
415 the input is copied to the output, expanding any
419 The parser is also run, and as usual, the
423 are displayed before copying the input to the output.
430 .Lk http://daringfireball.net/projects/markdown/syntax.text\
431 "John Gruber's 2004 specification" .
432 The output also almost conforms to the
433 .Lk http://commonmark.org/ CommonMark
436 The character set used for the markdown output is ASCII.
437 Non-ASCII characters are encoded as HTML entities.
438 Since that is not possible in literal font contexts, because these
439 are rendered as code spans and code blocks in the markdown output,
440 non-ASCII characters are transliterated to ASCII approximations in
443 Markdown is a very weak markup language, so all semantic markup is
444 lost, and even part of the presentational markup may be lost.
445 Do not use this as an intermediate step in converting to HTML;
455 input languages are not supported by
459 PDF-1.1 output may be generated by
462 .Sx PostScript Output
465 arguments and defaults.
466 .Ss PostScript Output
469 Level-2 pages may be generated by
471 Output pages default to letter sized and are rendered in the Times font
473 Margins are calculated as 1/9 the page length and width.
476 Special characters are rendered as in
481 arguments are accepted:
483 .It Cm paper Ns = Ns Ar name
493 You may also manually specify dimensions as
495 width by height in millimetres.
496 If an unknown value is encountered,
503 to force a UTF\-8 locale.
506 for details and options.
507 .Ss Syntax tree output
510 to show a human readable representation of the syntax tree.
511 It is useful for debugging the source code of manual pages.
512 The exact format is subject to change, so don't write parsers for it.
514 The first paragraph shows meta data found in the
519 line, or the fallbacks used.
521 In the tree dump, each output line shows one syntax tree node.
522 Child nodes are indented with respect to their parent node.
527 For macro nodes, the macro name; for text and
530 There is a special format for
534 Node type (text, elem, block, head, body, body-end, tail, tbl, eqn).
539 An opening parenthesis if the node is an opening delimiter.
541 An asterisk if the node starts a new input line.
543 The input line number (starting at one).
547 The input column number (starting at one).
549 A closing parenthesis if the node is a closing delimiter.
551 A full stop if the node ends a sentence.
553 BROKEN if the node is a block broken by another block.
555 NOSRC if the node is not in the input file,
556 but automatically generated from macros.
558 NOPRT if the node is not supposed to generate output
559 for any output format.
565 argument is accepted:
568 Skip validation and show the unvalidated syntax tree.
569 This can help to find out whether a given behaviour is caused by
570 the parser or by the validator.
571 Meta data is not available in this case.
574 .Bl -tag -width MANPAGER
576 Any non-empty value of the environment variable
578 is used instead of the standard pagination program,
589 Specifies the pagination program to use when
592 If neither PAGER nor MANPAGER is defined,
605 utility exits with one of the following values, controlled by the message
611 .Bl -tag -width Ds -compact
613 No base system convention violations, style suggestions, warnings,
614 or errors occurred, or those that did were ignored because they
615 were lower than the requested
618 At least one base system convention violation or style suggestion
619 occurred, but no warning or error, and
625 At least one warning occurred, but no error, and
631 At least one parsing error occurred,
632 but no unsupported feature was encountered, and
638 At least one unsupported feature was encountered, and
644 Invalid command line arguments were specified.
645 No input files have been read.
647 An operating system error occurred, for example exhaustion
648 of memory, file descriptors, or process table entries.
651 to exit at once, possibly in the middle of parsing or formatting a file.
659 To page manuals to the terminal:
661 .Dl $ mandoc -l mandoc.1 man.1 apropos.1 makewhatis.8
663 To produce HTML manuals with
667 .Dl $ mandoc \-T html -O style=mandoc.css mdoc.7 \*(Gt mdoc.7.html
669 To check over a large set of manuals:
671 .Dl $ mandoc \-T lint \(gafind /usr/src -name \e*\e.[1-9]\(ga
673 To produce a series of PostScript manuals for A4 paper:
675 .Dl $ mandoc \-T ps \-O paper=a4 mdoc.7 man.7 \*(Gt manuals.ps
681 format, for use on systems lacking an
685 .Dl $ mandoc \-T man foo.mdoc \*(Gt foo.man
687 Messages displayed by
690 .Bd -ragged -offset indent
692 .Ar file : Ns Ar line : Ns Ar column : level : message : macro args
696 Line and column numbers start at 1.
697 Both are omitted for messages referring to an input file as a whole.
698 Macro names and arguments are omitted where meaningless.
701 operating system specifier is omitted for messages that are relevant
702 for all operating systems.
703 Fatal messages about invalid command line arguments
704 or operating system errors, for example when memory is exhausted,
711 Message levels have the following meanings:
712 .Bl -tag -width "warning"
714 An input file uses unsupported low-level
717 The output may be incomplete and/or misformatted,
718 so using GNU troff instead of
720 to process the file may be preferable.
722 An input file contains invalid syntax that cannot be safely interpreted.
723 By discarding part of the input or inserting missing tokens,
724 the parser is able to continue, and the error does not prevent
725 generation of formatted output, but typically, preparing that
726 output involves information loss, broken document structure
727 or unintended formatting, no matter whether
729 or GNU troff is used.
730 In many cases, the output of
732 and GNU troff is identical, but in some,
734 is more resilient than GNU troff with respect to malformed input.
736 Non-existent or unreadable input files are also reported on the
739 In that case, the parser cannot even be started and no output
740 is produced from those input files.
742 An input file uses obsolete, discouraged or non-portable syntax.
743 All the same, the meaning of the input is unambiguous and a correct
744 rendering can be produced.
745 Documents causing warnings may render poorly when using other
746 formatting tools instead of
749 An input file uses dubious or discouraged style.
750 This is not a complaint about the syntax, and probably neither
751 formatting nor portability are in danger.
752 While great care is taken to avoid false positives on the higher
755 level tries to reduce the probability that issues go unnoticed,
756 so it may occasionally issue bogus suggestions.
757 Please use your good judgement to decide whether any particular
759 suggestion really justifies a change to the input file.
761 A convertion used in the base system of a specific operating system
763 These are not markup mistakes, and neither the quality of formatting
764 nor portability are in danger.
767 level are printed with the more intuitive
780 levels except those about non-existent or unreadable input files
781 are hidden unless their level, or a lower level, is requested using a
787 As indicated below, all
791 checks are only performed if a specific operating system name occurs
792 in the arguments of the
794 command line option, of the
798 command line option, or, if neither are present, in the return value
802 .Ss Conventions for base system manuals
804 .It Sy "Mdocdate found"
810 keyword substitution, which is not supported by the
813 Consider using the conventional
816 .It Sy "Mdocdate missing"
820 macro does not use CVS
822 keyword substitution, but using it is conventionally expected in the
825 .It Sy "unknown architecture"
827 The third argument of the
829 macro does not match any of the architectures this operating system
831 .It Sy "operating system explicitly specified"
835 macro has an argument.
836 In the base system, it is conventionally left blank.
837 .It Sy "RCS id missing"
839 The manual page lacks the comment line with the RCS identifier
844 keyword substitution as conventionally used in these operating systems.
845 .It Sy "referenced manual not found"
849 macro references a manual page that is not found in the base system.
850 The path to look for base system manuals is configurable at compile
852 .Pa /usr/share/man : /usr/X11R6/man .
854 .Ss Style suggestions
856 .It Sy "legacy man(7) date format"
860 macro uses the legacy
864 Consider using the conventional
869 .It Sy "duplicate RCS id"
870 A single manual page contains two copies of the RCS identifier for
871 the same operating system.
872 Consider deleting the later instance and moving the first one up
873 to the top of the page.
874 .It Sy "typo in section name"
876 Fuzzy string matching revealed that the argument of an
878 macro is similar, but not identical to a standard section name.
879 .It Sy "useless macro"
887 Simply delete it: it serves no useful purpose.
888 .It Sy "consider using OS macro"
890 A string was found in plain text or in a
892 macro that could be represented using
898 .It Sy "errnos out of order"
904 list are not in alphabetical order.
905 .It Sy "duplicate errno"
909 list contains two consecutive
911 entries describing the same
914 .It Sy "trailing delimiter"
916 The last argument of an
917 .Ic \&Ex , \&Fo , \&Nd , \&Nm , \&Os , \&Sh , \&Ss , \&St ,
920 macro ends with a trailing delimiter.
921 This is usually bad style and often indicates typos.
922 Most likely, the delimiter can be removed.
923 .It Sy "no blank before trailing delimiter"
925 The last argument of a macro that supports trailing delimiter
926 arguments is longer than one byte and ends with a trailing delimiter.
927 Consider inserting a blank such that the delimiter becomes a separate
928 argument, thus moving it out of the scope of the macro.
929 .It Sy "function name without markup"
931 A word followed by an empty pair of parentheses occurs on a text line.
938 .Ss Warnings related to the document prologue
940 .It Sy "missing manual title, using UNTITLED"
944 macro has no arguments, or there is no
946 macro before the first non-prologue macro.
947 .It Sy "missing manual title, using \(dq\(dq"
951 macro, or it has no arguments.
952 .It Sy "lower case character in document title"
954 The title is still used as given in the
959 .It Sy "missing manual section, using \(dq\(dq"
965 macro lacks the mandatory section argument.
966 .It Sy "unknown manual section"
968 The section number in a
970 line is invalid, but still used.
971 .It Sy "missing date, using today's date"
973 The document was parsed as
979 macro has no arguments or only empty arguments;
980 or the document was parsed as
986 macro has less than three arguments or its third argument is empty.
987 .It Sy "cannot parse date, using it verbatim"
993 macro does not follow the conventional format.
994 .It Sy "date in the future, using it anyway"
1000 macro is more than a day ahead of the current system
1002 .It Sy "missing Os macro, using \(dq\(dq"
1004 The default or current system is not shown in this case.
1005 .It Sy "duplicate prologue macro"
1007 One of the prologue macros occurs more than once.
1008 The last instance overrides all previous ones.
1009 .It Sy "late prologue macro"
1015 macro occurs after some non-prologue macro, but still takes effect.
1016 .It Sy "skipping late title macro"
1020 macro appears after the first non-prologue macro.
1021 Traditional formatters cannot handle this because
1022 they write the page header before parsing the document body.
1023 Even though this technical restriction does not apply to
1025 traditional semantics is preserved.
1026 The late macro is discarded including its arguments.
1027 .It Sy "prologue macros out of order"
1029 The prologue macros are not given in the conventional order
1033 All three macros are used even when given in another order.
1035 .Ss Warnings regarding document structure
1037 .It Sy ".so is fragile, better use ln(1)"
1039 Including files only works when the parser program runs with the correct
1040 current working directory.
1041 .It Sy "no document body"
1043 The document body contains neither text nor macros.
1044 An empty document is shown, consisting only of a header and a footer line.
1045 .It Sy "content before first section header"
1047 Some macros or text precede the first
1052 The offending macros and text are parsed and added to the top level
1053 of the syntax tree, outside any section block.
1054 .It Sy "first section is not NAME"
1056 The argument of the first
1064 .It Sy "NAME section without Nm before Nd"
1066 The NAME section does not contain any
1068 child macro before the first
1071 .It Sy "NAME section without description"
1073 The NAME section lacks the mandatory
1076 .It Sy "description not at the end of NAME"
1078 The NAME section does contain an
1080 child macro, but other content follows it.
1081 .It Sy "bad NAME section content"
1083 The NAME section contains plain text or macros other than
1087 .It Sy "missing comma before name"
1089 The NAME section contains an
1091 macro that is neither the first one nor preceded by a comma.
1092 .It Sy "missing description line, using \(dq\(dq"
1096 macro lacks the required argument.
1097 The title line of the manual will end after the dash.
1098 .It Sy "description line outside NAME section"
1102 macro appears outside the NAME section.
1103 The arguments are printed anyway and the following text is used for
1105 but none of that behaviour is portable.
1106 .It Sy "sections out of conventional order"
1108 A standard section occurs after another section it usually precedes.
1109 All section titles are used as given,
1110 and the order of sections is not changed.
1111 .It Sy "duplicate section title"
1113 The same standard section title occurs more than once.
1114 .It Sy "unexpected section"
1116 A standard section header occurs in a section of the manual
1117 where it normally isn't useful.
1118 .It Sy "cross reference to self"
1122 macro refers to a name and section matching the section of the present
1123 manual page and a name mentioned in an
1125 macro in the NAME or SYNOPSIS section, or in an
1129 macro in the SYNOPSIS.
1136 .It Sy "unusual Xr order"
1138 In the SEE ALSO section, an
1140 macro with a lower section number follows one with a higher number,
1143 macros referring to the same section are out of alphabetical order.
1144 .It Sy "unusual Xr punctuation"
1146 In the SEE ALSO section, punctuation between two
1148 macros differs from a single comma, or there is trailing punctuation
1152 .It Sy "AUTHORS section without An macro"
1154 An AUTHORS sections contains no
1156 macros, or only empty ones.
1157 Probably, there are author names lacking markup.
1159 .Ss "Warnings related to macros and nesting"
1161 .It Sy "obsolete macro"
1165 manual for replacements.
1166 .It Sy "macro neither callable nor escaped"
1168 The name of a macro that is not callable appears on a macro line.
1169 It is printed verbatim.
1170 If the intention is to call it, move it to its own input line;
1171 otherwise, escape it by prepending
1173 .It Sy "skipping paragraph macro"
1176 documents, this happens
1179 at the beginning and end of sections and subsections
1181 right before non-compact lists and displays
1183 at the end of items in non-column, non-compact lists
1185 and for multiple consecutive paragraph macros.
1189 documents, it happens
1201 macros having neither head nor body arguments
1212 .It Sy "moving paragraph macro out of list"
1216 list contains a trailing paragraph macro.
1217 The paragraph macro is moved after the end of the list.
1218 .It Sy "skipping no-space macro"
1220 An input line begins with an
1222 macro, or the next argument after an
1224 macro is an isolated closing delimiter.
1225 The macro is ignored.
1226 .It Sy "blocks badly nested"
1228 If two blocks intersect, one should completely contain the other.
1229 Otherwise, rendered output is likely to look strange in any output
1230 format, and rendering in SGML-based output formats is likely to be
1231 outright wrong because such languages do not support badly nested
1233 Typical examples of badly nested blocks are
1234 .Qq Ic \&Ao \&Bo \&Ac \&Bc
1236 .Qq Ic \&Ao \&Bq \&Ac .
1244 .It Sy "nested displays are not portable"
1251 display occurs nested inside another
1256 but fails with most other implementations.
1257 .It Sy "moving content out of list"
1261 list block contains text or macros before the first
1264 The offending children are moved before the beginning of the list.
1265 .It Sy "first macro on line"
1270 macro occurs as the first macro on a line, which is not portable.
1271 .It Sy "fill mode already enabled, skipping"
1275 request occurs even though the document is still in fill mode,
1276 or already switched back to fill mode.
1278 .It Sy "fill mode already disabled, skipping"
1282 request occurs even though the document already switched to no-fill mode
1283 and did not switch back to fill mode yet.
1285 .It Sy "line scope broken"
1287 While parsing the next-line scope of the previous macro,
1288 another macro is found that prematurely terminates the previous one.
1289 The previous, interrupted macro is deleted from the parse tree.
1291 .Ss "Warnings related to missing arguments"
1293 .It Sy "skipping empty request"
1295 The macro name is missing from a macro definition request,
1298 control statement or operation keyword lacks its required argument.
1299 .It Sy "conditional request controls empty scope"
1301 A conditional request is only useful if any of the following
1302 follows it on the same logical input line:
1307 keyword to open a multi-line scope.
1309 A request or macro or some text, resulting in a single-line scope.
1311 The immediate end of the logical line without any intervening whitespace,
1312 resulting in next-line scope.
1314 Here, a conditional request is followed by trailing whitespace only,
1315 and there is no other content on its logical input line.
1316 Note that it doesn't matter whether the logical input line is split
1317 across multiple physical input lines using
1319 line continuation characters.
1320 This is one of the rare cases
1321 where trailing whitespace is syntactically significant.
1322 The conditional request controls a scope containing whitespace only,
1323 so it is unlikely to have a significant effect,
1324 except that it may control a following
1327 .It Sy "skipping empty macro"
1329 The indicated macro has no arguments and hence no effect.
1330 .It Sy "empty block"
1342 block contains nothing in its body and will produce no output.
1343 .It Sy "empty argument, using 0n"
1345 The required width is missing after
1352 .It Sy "missing display type, using -ragged"
1356 macro is invoked without the required display type.
1357 .It Sy "list type is not the first argument"
1361 macro, at least one other argument precedes the type argument.
1364 utility copes with any argument order, but some other
1366 implementations do not.
1367 .It Sy "missing -width in -tag list, using 8n"
1376 .It Sy "missing utility name, using \(dq\(dq"
1380 macro is called without an argument before
1382 has first been called with an argument.
1383 .It Sy "missing function name, using \(dq\(dq"
1387 macro is called without an argument.
1388 No function name is printed.
1389 .It Sy "empty head in list item"
1401 macro lacks the required argument.
1402 The item head is left empty.
1403 .It Sy "empty list item"
1415 An empty list item is shown.
1416 .It Sy "missing argument, using next line"
1422 list has no arguments.
1425 uses the text or macros of the following line, if any, for the cell,
1426 other formatters may misformat the list.
1427 .It Sy "missing font type, using \efR"
1431 macro has no argument.
1432 It switches to the default font.
1433 .It Sy "unknown font type, using \efR"
1437 argument is invalid.
1438 The default font is used instead.
1439 .It Sy "nothing follows prefix"
1443 macro has no argument, or only one argument and no macro follows
1444 on the same input line.
1445 This defeats its purpose; in particular, spacing is not suppressed
1446 before the text or macros following on the next input line.
1447 .It Sy "empty reference block"
1451 macro is immediately followed by an
1453 macro on the next input line.
1454 Such an empty block does not produce any output.
1455 .It Sy "missing section argument"
1459 macro lacks its second, section number argument.
1460 The first argument, i.e. the name, is printed, but without subsequent
1462 .It Sy "missing -std argument, adding it"
1468 macro lacks the required
1475 even when it is not specified, but other implementations may not.
1476 .It Sy "missing option string, using \(dq\(dq"
1480 macro is invoked without any argument.
1481 An empty pair of square brackets is shown.
1482 .It Sy "missing resource identifier, using \(dq\(dq"
1488 macro is invoked without any argument.
1489 An empty pair of angle brackets is shown.
1490 .It Sy "missing eqn box, using \(dq\(dq"
1492 A diacritic mark or a binary operator is found,
1493 but there is nothing to the left of it.
1494 An empty box is inserted.
1496 .Ss "Warnings related to bad macro arguments"
1498 .It Sy "unterminated quoted argument"
1500 Macro arguments can be enclosed in double quote characters
1501 such that space characters and macro names contained in the quoted
1502 argument need not be escaped.
1503 The closing quote of the last argument of a macro can be omitted.
1504 However, omitting it is not recommended because it makes the code
1506 .It Sy "duplicate argument"
1512 macro has more than one
1519 All but the last instances of these arguments are ignored.
1520 .It Sy "skipping duplicate argument"
1524 macro has more than one
1529 All but the first of these arguments are ignored.
1530 .It Sy "skipping duplicate display type"
1534 macro has more than one type argument; the first one is used.
1535 .It Sy "skipping duplicate list type"
1539 macro has more than one type argument; the first one is used.
1540 .It Sy "skipping -width argument"
1554 .It Sy "wrong number of cells"
1557 list, the number of tabs or
1559 macros is less than the number expected from the list header line
1560 or exceeds the expected number by more than one.
1561 Missing cells remain empty, and all cells exceeding the number of
1562 columns are joined into one single cell.
1563 .It Sy "unknown AT&T UNIX version"
1567 macro has an invalid argument.
1568 It is used verbatim, with
1571 .It Sy "comma in function argument"
1577 macro contains a comma; it should probably be split into two arguments.
1578 .It Sy "parenthesis in function name"
1580 The first argument of an
1584 macro contains an opening or closing parenthesis; that's probably wrong,
1585 parentheses are added automatically.
1586 .It Sy "unknown library name"
1590 macro has an unknown name argument and will be rendered as
1591 .Qq library Dq Ar name .
1592 .It Sy "invalid content in Rs block"
1596 block contains plain text or non-% macros.
1597 The bogus content is left in the syntax tree.
1598 Formatting may be poor.
1599 .It Sy "invalid Boolean argument"
1603 macro has an argument other than
1607 The invalid argument is moved out of the macro, which leaves the macro
1608 empty, causing it to toggle the spacing mode.
1609 .It Sy "unknown font, skipping request"
1617 layout modifier has an unknown
1620 .It Sy "odd number of characters in request"
1624 request contains an odd number of characters.
1625 The last character is mapped to the blank character.
1627 .Ss "Warnings related to plain text"
1629 .It Sy "blank line in fill mode, using .sp"
1631 The meaning of blank input lines is only well-defined in non-fill mode:
1632 In fill mode, line breaks of text input lines are not supposed to be
1634 However, for compatibility with groff, blank lines in fill mode
1638 .It Sy "tab in filled text"
1640 The meaning of tab characters is only well-defined in non-fill mode:
1641 In fill mode, whitespace is not supposed to be significant
1642 on text input lines.
1643 As an implementation dependent choice, tab characters on text lines
1644 are passed through to the formatters in any case.
1645 Given that the text before the tab character will be filled,
1646 it is hard to predict which tab stop position the tab will advance to.
1647 .It Sy "whitespace at end of input line"
1648 .Pq mdoc , man , roff
1649 Whitespace at the end of input lines is almost never semantically
1650 significant \(em but in the odd case where it might be, it is
1651 extremely confusing when reviewing and maintaining documents.
1652 .It Sy "new sentence, new line"
1654 A new sentence starts in the middle of a text line.
1655 Start it on a new input line to help formatters produce correct spacing.
1656 .It Sy "bad comment style"
1658 Comment lines start with a dot, a backslash, and a double-quote character.
1661 utility treats the line as a comment line even without the backslash,
1662 but leaving out the backslash might not be portable.
1663 .It Sy "invalid escape sequence"
1665 An escape sequence has an invalid opening argument delimiter, lacks the
1666 closing argument delimiter, or the argument has too few characters.
1667 If the argument is incomplete,
1671 expand to an empty string,
1677 to the length of the incomplete argument.
1678 All other invalid escape sequences are ignored.
1679 .It Sy "undefined string, using \(dq\(dq"
1681 If a string is used without being defined before,
1682 its value is implicitly set to the empty string.
1683 However, defining strings explicitly before use
1684 keeps the code more readable.
1686 .Ss "Warnings related to tables"
1688 .It Sy "tbl line starts with span"
1690 The first cell in a table layout line is a horizontal span
1692 Data provided for this cell is ignored, and nothing is printed in the cell.
1693 .It Sy "tbl column starts with span"
1695 The first line of a table layout specification
1696 requests a vertical span
1698 Data provided for this cell is ignored, and nothing is printed in the cell.
1699 .It Sy "skipping vertical bar in tbl layout"
1701 A table layout specification contains more than two consecutive vertical bars.
1702 A double bar is printed, all additional bars are discarded.
1704 .Ss "Errors related to tables"
1706 .It Sy "non-alphabetic character in tbl options"
1708 The table options line contains a character other than a letter,
1709 blank, or comma where the beginning of an option name is expected.
1710 The character is ignored.
1711 .It Sy "skipping unknown tbl option"
1713 The table options line contains a string of letters that does not
1714 match any known option name.
1715 The word is ignored.
1716 .It Sy "missing tbl option argument"
1718 A table option that requires an argument is not followed by an
1719 opening parenthesis, or the opening parenthesis is immediately
1720 followed by a closing parenthesis.
1721 The option is ignored.
1722 .It Sy "wrong tbl option argument size"
1724 A table option argument contains an invalid number of characters.
1725 Both the option and the argument are ignored.
1726 .It Sy "empty tbl layout"
1728 A table layout specification is completely empty,
1729 specifying zero lines and zero columns.
1730 As a fallback, a single left-justified column is used.
1731 .It Sy "invalid character in tbl layout"
1733 A table layout specification contains a character that can neither
1734 be interpreted as a layout key character nor as a layout modifier,
1735 or a modifier precedes the first key.
1736 The invalid character is discarded.
1737 .It Sy "unmatched parenthesis in tbl layout"
1739 A table layout specification contains an opening parenthesis,
1740 but no matching closing parenthesis.
1741 The rest of the input line, starting from the parenthesis, has no effect.
1742 .It Sy "tbl without any data cells"
1744 A table does not contain any data cells.
1745 It will probably produce no output.
1746 .It Sy "ignoring data in spanned tbl cell"
1748 A table cell is marked as a horizontal span
1752 in the table layout, but it contains data.
1753 The data is ignored.
1754 .It Sy "ignoring extra tbl data cells"
1756 A data line contains more cells than the corresponding layout line.
1757 The data in the extra cells is ignored.
1758 .It Sy "data block open at end of tbl"
1760 A data block is opened with
1762 but never closed with a matching
1764 The remaining data lines of the table are all put into one cell,
1765 and any remaining cells stay empty.
1767 .Ss "Errors related to roff, mdoc, and man code"
1769 .It Sy "input stack limit exceeded, infinite loop?"
1771 Explicit recursion limits are implemented for the following features,
1772 in order to prevent infinite loops:
1775 expansion of nested escape sequences
1776 including expansion of strings and number registers,
1778 expansion of nested user-defined macros,
1784 When a limit is hit, the output is incorrect, typically losing
1785 some content, but the parser can continue.
1786 .It Sy "skipping bad character"
1787 .Pq mdoc , man , roff
1788 The input file contains a byte that is not a printable
1791 The message mentions the character number.
1792 The offending byte is replaced with a question mark
1794 Consider editing the input file to replace the byte with an ASCII
1795 transliteration of the intended character.
1796 .It Sy "skipping unknown macro"
1797 .Pq mdoc , man , roff
1798 The first identifier on a request or macro line is neither recognized as a
1800 request, nor as a user-defined macro, nor, respectively, as an
1805 It may be mistyped or unsupported.
1806 The request or macro is discarded including its arguments.
1807 .It Sy "skipping insecure request"
1809 An input file attempted to run a shell command
1810 or to read or write an external file.
1811 Such attempts are denied for security reasons.
1812 .It Sy "skipping item outside list"
1816 macro occurs outside any
1821 delimiter occurs outside any pile.
1822 It is discarded including its arguments.
1823 .It Sy "skipping column outside column list"
1827 macro occurs outside any
1830 It is discarded including its arguments.
1831 .It Sy "skipping end of block that is not open"
1832 .Pq mdoc , man , eqn , tbl , roff
1833 Various syntax elements can only be used to explicitly close blocks
1834 that have previously been opened.
1837 block closing macro, a
1844 right delimiter or closing brace, or the end of an equation, table, or
1846 conditional request is encountered but no matching block is open.
1847 The offending request or macro is discarded.
1848 .It Sy "fewer RS blocks open, skipping"
1852 macro is invoked with an argument, but less than the specified number of
1858 .It Sy "inserting missing end of block"
1862 macros as well as tables require explicit closing by dedicated macros.
1863 A block that doesn't support bad nesting
1864 ends before all of its children are properly closed.
1865 The open child nodes are closed implicitly.
1866 .It Sy "appending missing end of block"
1867 .Pq mdoc , man , eqn , tbl , roff
1868 At the end of the document, an explicit
1876 block, an equation, table, or
1878 conditional or ignore block is still open.
1879 The open block is closed implicitly.
1880 .It Sy "escaped character not allowed in a name"
1882 Macro, string and register identifiers consist of printable,
1883 non-whitespace ASCII characters.
1884 Escape sequences and characters and strings expressed in terms of them
1885 cannot form part of a name.
1886 The first argument of an
1894 request, or any argument of an
1896 request, or the name of a request or user defined macro being called,
1897 is terminated by an escape sequence.
1903 the request has no effect at all.
1910 what was parsed up to this point is used as the arguments to the request,
1911 and the rest of the input line is discarded including the escape sequence.
1912 When parsing for a request or a user-defined macro name to be called,
1913 only the escape sequence is discarded.
1914 The characters preceding it are used as the request or macro name,
1915 the characters following it are used as the arguments to the request or macro.
1916 .It Sy "NOT IMPLEMENTED: Bd -file"
1918 For security reasons, the
1920 macro does not support the
1923 By requesting the inclusion of a sensitive file, a malicious document
1924 might otherwise trick a privileged user into inadvertently displaying
1925 the file on the screen, revealing the file content to bystanders.
1926 The argument is ignored including the file name following it.
1927 .It Sy "skipping display without arguments"
1931 block macro does not have any arguments.
1932 The block is discarded, and the block content is displayed in
1933 whatever mode was active before the block.
1934 .It Sy "missing list type, using -item"
1938 macro fails to specify the list type.
1939 .It Sy "argument is not numeric, using 1"
1943 request is not a number.
1944 .It Sy "missing manual name, using \(dq\(dq"
1948 or any call in the NAME section, lacks the required argument.
1949 .It Sy "uname(3) system call failed, using UNKNOWN"
1953 macro is called without arguments, and the
1958 can be compiled with
1960 .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
1962 .It Sy "unknown standard specifier"
1966 macro has an unknown argument and is discarded.
1967 .It Sy "skipping request without numeric argument"
1976 statement has a non-numeric or negative argument or no argument at all.
1977 The invalid request or statement is ignored.
1978 .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
1980 For security reasons,
1984 file inclusion requests only with relative paths
1985 and only without ascending to any parent directory.
1986 By requesting the inclusion of a sensitive file, a malicious document
1987 might otherwise trick a privileged user into inadvertently displaying
1988 the file on the screen, revealing the file content to bystanders.
1990 only shows the path as it appears behind
1992 .It Sy ".so request failed"
1996 request requires reading an external file, but the file could not be
1999 only shows the path as it appears behind
2001 .It Sy "skipping all arguments"
2002 .Pq mdoc , man , eqn , roff
2018 macro in a list that don't support item heads, a
2037 block closing request is invoked with at least one argument.
2038 All arguments are ignored.
2039 .It Sy "skipping excess arguments"
2040 .Pq mdoc , man , roff
2041 A macro or request is invoked with too many arguments:
2042 .Bl -dash -offset 2n -width 2n -compact
2052 with more than one argument
2055 with another argument after
2061 with more than one argument or with a non-integer argument
2066 family with more than two arguments
2069 with more than three arguments
2072 with more than five arguments
2078 with invalid arguments
2080 The excess arguments are ignored.
2082 .Ss Unsupported features
2084 .It Sy "input too large"
2088 cannot handle input files larger than its arbitrary size limit
2089 of 2^31 bytes (2 Gigabytes).
2090 Since useful manuals are always small, this is not a problem in practice.
2091 Parsing is aborted as soon as the condition is detected.
2092 .It Sy "unsupported control character"
2094 An ASCII control character supported by other
2096 implementations but not by
2098 was found in an input file.
2099 It is replaced by a question mark.
2100 .It Sy "unsupported roff request"
2102 An input file contains a
2104 request supported by GNU troff or Heirloom troff but not by
2106 and it is likely that this will cause information loss
2107 or considerable misformatting.
2108 .It Sy "eqn delim option in tbl"
2110 The options line of a table defines equation delimiters.
2111 Any equation source code contained in the table will be printed unformatted.
2112 .It Sy "unsupported table layout modifier"
2114 A table layout specification contains an
2117 The modifier is discarded.
2118 .It Sy "ignoring macro in table"
2119 .Pq tbl , mdoc , man
2120 A table contains an invocation of an
2124 macro or of an undefined macro.
2125 The macro is ignored, and its arguments are handled
2126 as if they were a text line.
2140 utility first appeared in
2154 utility was written by
2155 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
2156 and is maintained by
2157 .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
git.ckatri.com / mandoc.git / blob