1 .\" $Id: mandoc.1,v 1.125 2014/11/28 18:09:01 schwarze Exp $
3 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 .\" Copyright (c) 2012, 2014 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: November 28 2014 $
23 .Nd format and display UNIX manuals
28 .Op Fl I Cm os Li = Ar name
30 .Op Fl K Ns Ar encoding
41 manual pages for display.
49 text from stdin, implying
55 The options are as follows:
58 If the standard output is a terminal device and
62 to paginate the output, just like
66 Copy the formatted manual pages to the standard output without using
70 It can be specified to override
75 This overrides any earlier
81 .It Fl I Cm os Li = Ar name
83 Override the default operating system
90 Display only the SYNOPSIS lines.
93 .It Fl K Ns Ar encoding
94 Specify the input encoding.
102 If not specified, autodetection uses the first match:
103 .Bl -tag -width iso-8859-1
105 if the first three bytes of the input file
106 are the UTF-8 byte order mark (BOM, 0xefbbbf)
108 if the first or second line of the input file matches the
112 .D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-
114 if the first non-ASCII byte in the file introduces a valid UTF-8 sequence
121 This overrides any earlier
129 Also reverts any earlier
134 .It Fl m Ns Ar format
138 for available formats.
141 .It Fl O Ns Ar option
142 Comma-separated output options.
143 .It Fl T Ns Ar output
147 for available formats.
151 Print version and exit.
153 Specify the minimum message
155 to be reported on the standard error output and to affect the exit status.
167 .Fl W Ns Cm warning .
178 to exit after parsing a file that causes warnings or errors of at least
180 No formatted output will be produced from that file.
185 are requested, they can be joined with a comma, for example
186 .Fl W Ns Cm error , Ns Cm stop .
188 Read input from zero or more files.
189 If unspecified, reads from stdin.
190 If multiple files are specified,
192 will halt with the first failed parse.
201 also supports the options
224 should only be used for legacy manuals.
228 which is also the default, determines encoding on-the-fly: if the first
235 parser is used; otherwise, the
240 files are specified with
242 each has its file-type determined this way.
243 If multiple files are
248 is specified, then this format is used exclusively.
252 utility accepts the following
254 arguments, which correspond to output modes:
255 .Bl -tag -width "-Tlocale"
257 Produce 7-bit ASCII output.
262 Produce HTML5, CSS1, and MathML output.
266 Parse only: produce no output.
268 .Fl W Ns Cm warning .
269 .It Fl T Ns Cm locale
270 Encode output using the current locale.
284 Produce PostScript output.
286 .Sx PostScript Output .
288 Produce an indented parse tree.
290 Encode output in the UTF\-8 multi-byte format.
294 This is a synonym for
298 If multiple input files are specified, these will be processed by the
299 corresponding filter in-order.
303 which is the default, is rendered in standard 7-bit ASCII documented in
306 Font styles are applied by using back-spaced encoding such that an
310 .Sq _ Ns \e[bs] Ns c ,
313 is the back-space character number 8.
314 Emboldened characters are rendered as
315 .Sq c Ns \e[bs] Ns c .
317 The special characters documented in
319 are rendered best-effort in an ASCII equivalent.
320 If no equivalent is found,
324 Output width is limited to 78 visible columns unless literal input lines
329 arguments are accepted:
331 .It Cm indent Ns = Ns Ar indent
332 The left margin for normal text is set to
334 blank characters instead of the default of five for
338 Increasing this is not recommended; it may result in degraded formatting,
339 for example overfull lines or ugly line breaks.
340 .It Cm width Ns = Ns Ar width
341 The output width is set to
343 which will normalise to \(>=60.
348 conforms to HTML5 using optional self-closing tags.
349 Default styles use only CSS1.
350 Equations rendered from
355 .Pa example.style.css
356 file documents style-sheet classes available for customising output.
357 If a style-sheet is not specified with
360 defaults to simple output (via an embedded style-sheet)
361 readable in any graphical or text-based web
364 Special characters are rendered in decimal-encoded UTF\-8.
368 arguments are accepted:
371 Omit the <!DOCTYPE> declaration and the <html>, <head>, and <body>
372 elements and only emit the subtree below the <body> element.
375 argument will be ignored.
376 This is useful when embedding manual content within existing documents.
377 .It Cm includes Ns = Ns Ar fmt
382 is used as a template for linked header files (usually via the
387 are replaced with the include filename.
388 The default is not to present a
390 .It Cm man Ns = Ns Ar fmt
394 .Ar ../html%S/%N.%S.html ,
395 is used as a template for linked manuals (usually via the
402 are replaced with the linked manual's name and section, respectively.
403 If no section is included, section 1 is assumed.
404 The default is not to
406 .It Cm style Ns = Ns Ar style.css
409 is used for an external style-sheet.
410 This must be a valid absolute or
414 Locale-depending output encoding is triggered with
416 This option is not available on all systems: systems without locale
417 support, or those whose internal representation is not natively UCS-4,
422 for font style specification and available command-line arguments.
424 Translate input format into
427 This is useful for distributing manual sources to legacy systems
434 is passed as input, it is translated into
436 If the input format is
438 the input is copied to the output, expanding any
442 The parser is also run, and as usual, the
446 are displayed before copying the input to the output.
448 PDF-1.1 output may be generated by
451 .Sx PostScript Output
454 arguments and defaults.
455 .Ss PostScript Output
458 Level-2 pages may be generated by
460 Output pages default to letter sized and are rendered in the Times font
462 Margins are calculated as 1/9 the page length and width.
465 Special characters are rendered as in
470 arguments are accepted:
472 .It Cm paper Ns = Ns Ar name
482 You may also manually specify dimensions as
484 width by height in millimetres.
485 If an unknown value is encountered,
492 to force a UTF\-8 locale.
495 for details and options.
497 .Bl -tag -width MANPAGER
499 Any non-empty value of the environment variable
501 will be used instead of the standard pagination program,
504 Specifies the pagination program to use when
507 If neither PAGER nor MANPAGER is defined,
508 .Pa /usr/bin/more Fl s
514 utility exits with one of the following values, controlled by the message
520 .Bl -tag -width Ds -compact
522 No warnings or errors occurred, or those that did were ignored because
523 they were lower than the requested
526 At least one warning occurred, but no error, and
530 At least one parsing error occurred, but no fatal error, and
536 A fatal parsing error occurred.
538 Invalid command line arguments were specified.
539 No input files have been read.
541 An operating system error occurred, for example memory exhaustion or an
542 error accessing input files.
545 to exit at once, possibly in the middle of parsing or formatting a file.
551 .Fl W Ns Cm warning .
553 To page manuals to the terminal:
555 .Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less
556 .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
558 To produce HTML manuals with
562 .Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html
564 To check over a large set of manuals:
566 .Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`
568 To produce a series of PostScript manuals for A4 paper:
570 .Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps
576 format, for use on systems lacking an
580 .Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man
582 Messages displayed by
586 .D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args
588 Line and column numbers start at 1.
589 Both are omitted for messages referring to an input file as a whole.
590 Macro names and arguments are omitted where meaningless.
591 Fatal messages about invalid command line arguments
592 or operating system errors, for example when memory is exhausted,
599 Message levels have the following meanings:
600 .Bl -tag -width "warning"
602 Opening or reading an input file failed, so the parser cannot
603 even be started and no output is produced from that input file.
605 The parser is unable to parse a given input file at all.
606 No formatted output is produced from that input file.
608 An input file contains syntax that cannot be safely interpreted,
609 either because it is invalid or because
611 does not implement it yet.
612 By discarding part of the input or inserting missing tokens,
613 the parser is able to continue, and the error does not prevent
614 generation of formatted output, but typically, preparing that
615 output involves information loss, broken document structure
616 or unintended formatting.
618 An input file uses obsolete, discouraged or non-portable syntax.
619 All the same, the meaning of the input is unambiguous and a correct
620 rendering can be produced.
621 Documents causing warnings may render poorly when using other
622 formatting tools instead of
630 levels are hidden unless their level, or a lower level, is requested using a
635 .Ss Warnings related to the document prologue
637 .It Sy "missing manual title, using UNTITLED"
641 macro has no arguments, or there is no
643 macro before the first non-prologue macro.
644 .It Sy "missing manual title, using \(dq\(dq"
648 macro, or it has no arguments.
649 .It Sy "lower case character in document title"
651 The title is still used as given in the
656 .It Sy "missing manual section, using \(dq\(dq"
662 macro lacks the mandatory section argument.
663 .It Sy "unknown manual section"
665 The section number in a
667 line is invalid, but still used.
668 .It Sy "missing date, using today's date"
670 The document was parsed as
676 macro has no arguments or only empty arguments;
677 or the document was parsed as
683 macro has less than three arguments or its third argument is empty.
684 .It Sy "cannot parse date, using it verbatim"
690 macro does not follow the conventional format.
691 .It Sy "missing Os macro, using \(dq\(dq"
693 The default or current system is not shown in this case.
694 .It Sy "duplicate prologue macro"
696 One of the prologue macros occurs more than once.
697 The last instance overrides all previous ones.
698 .It Sy "late prologue macro"
704 macro occurs after some non-prologue macro, but still takes effect.
705 .It Sy "skipping late title macro"
709 macro can only occur before the first non-prologue macro
710 because traditional formatters write the page header
711 before parsing the document body.
712 Even though this technical restriction does not apply to
714 traditional semantics is preserved.
715 The late macro is discarded including its arguments.
716 .It Sy "prologue macros out of order"
718 The prologue macros are not given in the conventional order
722 All three macros are used even when given in another order.
724 .Ss Warnings regarding document structure
726 .It Sy ".so is fragile, better use ln(1)"
728 Including files only works when the parser program runs with the correct
729 current working directory.
730 .It Sy "no document body"
732 The document body contains neither text nor macros.
733 An empty document is shown, consisting only of a header and a footer line.
734 .It Sy "content before first section header"
736 Some macros or text precede the first
741 The offending macros and text are parsed and added to the top level
742 of the syntax tree, outside any section block.
743 .It Sy "first section is not NAME"
745 The argument of the first
753 .It Sy "bad NAME section contents"
755 The last node in the NAME section is not an
757 macro, or any preceding macro is not
759 or the NAME section is completely empty.
764 .It Sy "sections out of conventional order"
766 A standard section occurs after another section it usually precedes.
767 All section titles are used as given,
768 and the order of sections is not changed.
769 .It Sy "duplicate section title"
771 The same standard section title occurs more than once.
772 .It Sy "unexpected section"
774 A standard section header occurs in a section of the manual
775 where it normally isn't useful.
776 .It Sy "unusual Xr order"
778 In the SEE ALSO section, an
780 macro with a lower section number follows one with a higher number,
783 macros refering to the same section are out of alphabetical order.
784 .It Sy "unusual Xr punctuation"
786 In the SEE ALSO section, punctuation between two
788 macros differs from a single comma, or there is trailing punctuation
792 .It Sy "AUTHORS section without An macro"
794 An AUTHORS sections contains no
796 macros, or only empty ones.
797 Probably, there are author names lacking markup.
799 .Ss "Warnings related to macros and nesting"
801 .It Sy "obsolete macro"
805 manual for replacements.
806 .It Sy "skipping paragraph macro"
809 documents, this happens
812 at the beginning and end of sections and subsections
814 right before non-compact lists and displays
816 at the end of items in non-column, non-compact lists
818 and for multiple consecutive paragraph macros.
822 documents, it happens
834 macros having neither head nor body arguments
845 .It Sy "moving paragraph macro out of list"
849 list contains a trailing paragraph macro.
850 The paragraph macro is moved after the end of the list.
851 .It Sy "skipping no-space macro"
853 An input line begins with an
856 The macro is ignored.
857 .It Sy "blocks badly nested"
859 If two blocks intersect, one should completely contain the other.
860 Otherwise, rendered output is likely to look strange in any output
861 format, and rendering in SGML-based output formats is likely to be
862 outright wrong because such languages do not support badly nested
864 Typical examples of badly nested blocks are
865 .Qq Ic \&Ao \&Bo \&Ac \&Bc
867 .Qq Ic \&Ao \&Bq \&Ac .
875 .It Sy "nested displays are not portable"
882 display occurs nested inside another
887 but fails with most other implementations.
888 .It Sy "moving content out of list"
892 list block contains text or macros before the first
895 The offending children are moved before the beginning of the list.
896 .It Sy ".Vt block has child macro"
900 macro supports plain text arguments only.
901 Formatting may be ugly and semantic searching
902 for the affected content might not work.
903 .It Sy "fill mode already enabled, skipping"
907 request occurs even though the document is still in fill mode,
908 or already switched back to fill mode.
910 .It Sy "fill mode already disabled, skipping"
914 request occurs even though the document already switched to no-fill mode
915 and did not switch back to fill mode yet.
917 .It Sy "line scope broken"
919 While parsing the next-line scope of the previous macro,
920 another macro is found that prematurely terminates the previous one.
921 The previous, interrupted macro is deleted from the parse tree.
923 .Ss "Warnings related to missing arguments"
925 .It Sy "skipping empty request"
927 The macro name is missing from a macro definition request,
930 control statement or operation keyword lacks its required argument.
931 .It Sy "conditional request controls empty scope"
933 A conditional request is only useful if any of the following
934 follows it on the same logical input line:
939 keyword to open a multi-line scope.
941 A request or macro or some text, resulting in a single-line scope.
943 The immediate end of the logical line without any intervening whitespace,
944 resulting in next-line scope.
946 Here, a conditional request is followed by trailing whitespace only,
947 and there is no other content on its logical input line.
948 Note that it doesn't matter whether the logical input line is split
949 across multiple physical input lines using
951 line continuation characters.
952 This is one of the rare cases
953 where trailing whitespace is syntactically significant.
954 The conditional request controls a scope containing whitespace only,
955 so it is unlikely to have a significant effect,
956 except that it may control a following
959 .It Sy "skipping empty macro"
961 The indicated macro has no arguments and hence no effect.
962 .It Sy "empty argument, using 0n"
964 The required width is missing after
971 .It Sy "argument count wrong"
973 The indicated macro has too few or too many arguments.
974 The syntax tree will contain the wrong number of arguments as given.
975 Formatting behaviour depends on the specific macro in question.
976 Note that the same message may also occur as an ERROR, see below.
977 .It Sy "missing display type, using -ragged"
981 macro is invoked without the required display type.
982 .It Sy "list type is not the first argument"
986 macro, at least one other argument precedes the type argument.
989 utility copes with any argument order, but some other
991 implementations do not.
992 .It Sy "missing -width in -tag list, using 8n"
1001 .It Sy "missing utility name, using \(dq\(dq"
1005 macro is called without an argument before
1007 has first been called with an argument.
1008 .It Sy "empty head in list item"
1020 macro lacks the required argument.
1021 The item head is left empty.
1022 .It Sy "empty list item"
1034 An empty list item is shown.
1035 .It Sy "missing font type"
1039 macro has no argument.
1040 It switches to the default font,
1042 .It Sy "unknown font type"
1046 argument is invalid.
1050 .It Sy "missing -std argument, adding it"
1056 macro lacks the required
1063 even when it is not specified, but other implementations may not.
1064 .It Sy "missing eqn box, using \(dq\(dq"
1066 A diacritic mark or a binary operator is found,
1067 but there is nothing to the left of it.
1068 An empty box is inserted.
1070 .Ss "Warnings related to bad macro arguments"
1072 .It Sy "unterminated quoted argument"
1074 Macro arguments can be enclosed in double quote characters
1075 such that space characters and macro names contained in the quoted
1076 argument need not be escaped.
1077 The closing quote of the last argument of a macro can be omitted.
1078 However, omitting it is not recommended because it makes the code
1080 .It Sy "duplicate argument"
1086 macro has more than one
1093 All but the last instances of these arguments are ignored.
1094 .It Sy "skipping duplicate argument"
1098 macro has more than one
1103 All but the first of these arguments are ignored.
1104 .It Sy "skipping duplicate display type"
1108 macro has more than one type argument; the first one is used.
1109 .It Sy "skipping duplicate list type"
1113 macro has more than one type argument; the first one is used.
1114 .It Sy "skipping -width argument"
1128 .It Sy "unknown AT&T UNIX version"
1132 macro has an invalid argument.
1133 It is used verbatim, with
1136 .It Sy "comma in function argument"
1142 macro contains a comma; it should probably be split into two arguments.
1143 .It Sy "parenthesis in function name"
1145 The first argument of an
1149 macro contains an opening or closing parenthesis; that's probably wrong,
1150 parentheses are added automatically.
1151 .It Sy "invalid content in Rs block"
1155 block contains plain text or non-% macros.
1156 The bogus content is left in the syntax tree.
1157 Formatting may be poor.
1158 .It Sy "invalid Boolean argument"
1162 macro has an argument other than
1166 The invalid argument is moved out of the macro, which leaves the macro
1167 empty, causing it to toggle the spacing mode.
1168 .It Sy "unknown font, skipping request"
1176 layout modifier has an unknown
1180 .Ss "Warnings related to plain text"
1182 .It Sy "blank line in fill mode, using .sp"
1184 The meaning of blank input lines is only well-defined in non-fill mode:
1185 In fill mode, line breaks of text input lines are not supposed to be
1187 However, for compatibility with groff, blank lines in fill mode
1191 .It Sy "tab in filled text"
1193 The meaning of tab characters is only well-defined in non-fill mode:
1194 In fill mode, whitespace is not supposed to be significant
1195 on text input lines.
1196 As an implementation dependent choice, tab characters on text lines
1197 are passed through to the formatters in any case.
1198 Given that the text before the tab character will be filled,
1199 it is hard to predict which tab stop position the tab will advance to.
1200 .It Sy "whitespace at end of input line"
1201 .Pq mdoc , man , roff
1202 Whitespace at the end of input lines is almost never semantically
1203 significant \(em but in the odd case where it might be, it is
1204 extremely confusing when reviewing and maintaining documents.
1205 .It Sy "bad comment style"
1207 Comment lines start with a dot, a backslash, and a double-quote character.
1210 utility treats the line as a comment line even without the backslash,
1211 but leaving out the backslash might not be portable.
1212 .It Sy "invalid escape sequence"
1214 An escape sequence has an invalid opening argument delimiter, lacks the
1215 closing argument delimiter, or the argument has too few characters.
1216 If the argument is incomplete,
1220 expand to an empty string,
1226 to the length of the incomplete argument.
1227 All other invalid escape sequences are ignored.
1228 .It Sy "undefined string, using \(dq\(dq"
1230 If a string is used without being defined before,
1231 its value is implicitly set to the empty string.
1232 However, defining strings explicitly before use
1233 keeps the code more readable.
1235 .Ss "Errors related to equations"
1237 .It "unexpected equation scope closure"
1238 .It "equation scope open on exit"
1239 .It "overlapping equation scopes"
1240 .It "unexpected end of equation"
1242 .Ss "Errors related to tables"
1244 .It "bad table syntax"
1245 .It "bad table option"
1246 .It "bad table layout"
1247 .It "no table layout cells specified"
1248 .It "no table data cells specified"
1249 .It "ignore data in cell"
1250 .It "data block still open"
1251 .It "ignoring extra data cells"
1253 .Ss "Errors related to roff, mdoc, and man code"
1255 .It Sy "input stack limit exceeded, infinite loop?"
1257 Explicit recursion limits are implemented for the following features,
1258 in order to prevent infinite loops:
1261 expansion of nested escape sequences
1262 including expansion of strings and number registers,
1264 expansion of nested user-defined macros,
1270 When a limit is hit, the output is incorrect, typically losing
1271 some content, but the parser can continue.
1272 .It Sy "skipping bad character"
1273 .Pq mdoc , man , roff
1274 The input file contains a byte that is not a printable
1277 The message mentions the character number.
1278 The offending byte is replaced with a question mark
1280 Consider editing the input file to replace the byte with an ASCII
1281 transliteration of the intended character.
1282 .It Sy "skipping unknown macro"
1283 .Pq mdoc , man , roff
1284 The first identifier on a request or macro line is neither recognized as a
1286 request, nor as a user-defined macro, nor, respectively, as an
1291 It may be mistyped or unsupported.
1292 The request or macro is discarded including its arguments.
1293 .It Sy "skipping item outside list"
1297 macro occurs outside any
1302 delimiter occurs outside any pile.
1303 It is discarded including its arguments.
1304 .It Sy "skipping column outside column list"
1308 macro occurs outside any
1311 It is discarded including its arguments.
1312 .It Sy "skipping end of block that is not open"
1313 .Pq mdoc , man , eqn , tbl , roff
1314 Various syntax elements can only be used to explicitly close blocks
1315 that have previously been opened.
1318 block closing macro, a
1325 right delimiter or closing brace, or the end of an equation, table, or
1327 conditional request is encountered but no matching block is open.
1328 The offending request or macro is discarded.
1329 .It Sy "inserting missing end of block"
1333 macros as well as tables require explicit closing by dedicated macros.
1334 A block that doesn't support bad nesting
1335 ends before all of its children are properly closed.
1336 The open child nodes are closed implicitly.
1337 .It Sy "scope open on exit"
1338 .Pq mdoc , man , eqn , tbl , roff
1339 At the end of the document, an explicit
1347 block, an equation, table, or
1349 conditional or ignore block is still open.
1350 The open block is closed implicitly.
1351 .It Sy "escaped character not allowed in a name"
1353 Macro, string and register identifiers consist of printable,
1354 non-whitespace ASCII characters.
1355 Escape sequences and characters and strings expressed in terms of them
1356 cannot form part of a name.
1357 The first argument of an
1365 request, or any argument of an
1367 request, or the name of a request or user defined macro being called,
1368 is terminated by an escape sequence.
1374 the request has no effect at all.
1381 what was parsed up to this point is used as the arguments to the request,
1382 and the rest of the input line is discarded including the escape sequence.
1383 When parsing for a request or a user-defined macro name to be called,
1384 only the escape sequence is discarded.
1385 The characters preceding it are used as the request or macro name,
1386 the characters following it are used as the arguments to the request or macro.
1387 .It Sy "argument count wrong"
1388 .Pq mdoc , man , roff
1389 The indicated request or macro has too few or too many arguments.
1390 The syntax tree will contain the wrong number of arguments as given.
1391 Formatting behaviour depends on the specific request or macro in question.
1392 Note that the same message may also occur as a WARNING, see above.
1393 .It Sy "NOT IMPLEMENTED: Bd -file"
1395 For security reasons, the
1397 macro does not support the
1400 By requesting the inclusion of a sensitive file, a malicious document
1401 might otherwise trick a privileged user into inadvertently displaying
1402 the file on the screen, revealing the file content to bystanders.
1403 The argument is ignored including the file name following it.
1404 .It Sy "missing list type, using -item"
1408 macro fails to specify the list type.
1409 .It Sy "missing manual name, using \(dq\(dq"
1413 lacks the required argument.
1414 .It Sy "uname(3) system call failed, using UNKNOWN"
1418 macro is called without arguments, and the
1423 can be compiled with
1425 .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
1427 .It Sy "unknown standard specifier"
1431 macro has an unknown argument and is discarded.
1432 .It Sy "skipping request without numeric argument"
1441 statement has a non-numeric or negative argument or no argument at all.
1442 The invalid request or statement is ignored.
1443 .It Sy "skipping all arguments"
1444 .Pq mdoc , man , eqn , roff
1457 macro in a list that don't support item heads, a
1471 block closing request is invoked with at least one argument.
1472 All arguments are ignored.
1473 .It Sy "skipping excess arguments"
1477 macro is invoked with more than one argument, or a request of the
1479 family is invoked with more than two arguments.
1480 The excess arguments are ignored.
1484 .It Sy "input too large"
1488 cannot handle input files larger than its arbitrary size limit
1489 of 2^31 bytes (2 Gigabytes).
1490 Since useful manuals are always small, this is not a problem in practice.
1491 Parsing is aborted as soon as the condition is detected.
1492 .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
1494 For security reasons,
1498 file inclusion requests only with relative paths
1499 and only without ascending to any parent directory.
1500 By requesting the inclusion of a sensitive file, a malicious document
1501 might otherwise trick a privileged user into inadvertently displaying
1502 the file on the screen, revealing the file content to bystanders.
1503 The parser exits immediately.
1504 .It Sy ".so request failed"
1508 request requires reading an external file.
1509 While trying to do so, an
1515 The parser exits immediately.
1516 Before showing this message,
1518 always shows another message explaining why the system call failed.
1521 This section summarises
1523 compatibility with GNU troff.
1524 Each input and output format is separately noted.
1525 .Ss ASCII Compatibility
1526 .Bl -bullet -compact
1528 Unrenderable unicode codepoints specified with
1530 escapes are printed as
1533 In GNU troff, these raise an error.
1543 are synonyms, as are \-filled and \-ragged.
1545 In historic GNU troff, the
1548 macro does not underline when scoped under an
1550 in the FILES section.
1551 This behaves correctly in
1554 A list or display following the
1559 does not assert a prior vertical break, just as it doesn't with
1569 Words aren't hyphenated.
1571 .Ss HTML Compatibility
1572 .Bl -bullet -compact
1576 escape will revert the font to the previous
1578 escape, not to the last rendered decoration, which is now dictated by
1579 CSS instead of hard-coded.
1580 It also will not span past the current scope,
1581 for the same reason.
1584 mode, this will work fine.
1591 list types render similarly (no break following overreached left-hand
1592 side) due to the expressive constraints of HTML.
1599 lists render similarly.
1611 utility was written by
1612 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1618 the maximum size of an element attribute is determined by
1620 which is usually 1024 bytes.
1621 Be aware of this when setting long link
1623 .Fl O Ns Cm style Ns = Ns Ar really/long/link .
1625 Nesting elements within next-line element scopes of
1635 and cause them to forget the formatting of the prior next-line scope.
1639 control character is an alias for the standard macro control character
1640 and does not emit a line-break as stipulated in GNU troff.
git.ckatri.com / mandoc.git / blob