1 .\" $Id: mandoc.1,v 1.114 2014/09/27 11:17:19 kristaps 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: September 27 2014 $
23 .Nd format and display UNIX manuals
28 .Op Fl I Cm os Li = Ar name
40 manual pages for display.
48 text from stdin, implying
54 The options are as follows:
57 If the standard output is a terminal device and
61 to paginate the output, just like
65 Copy the formatted manual pages to the standard output without using
69 It can be specified to override
74 This overrides any earlier
80 .It Fl I Cm os Li = Ar name
82 Override the default operating system
89 Display only the SYNOPSIS lines.
95 This overrides any earlier
103 Also reverts any earlier
108 .It Fl m Ns Ar format
112 for available formats.
115 .It Fl O Ns Ar option
116 Comma-separated output options.
117 .It Fl T Ns Ar output
121 for available formats.
125 Print version and exit.
127 Specify the minimum message
129 to be reported on the standard error output and to affect the exit status.
141 .Fl W Ns Cm warning .
152 to exit after parsing a file that causes warnings or errors of at least
154 No formatted output will be produced from that file.
159 are requested, they can be joined with a comma, for example
160 .Fl W Ns Cm error , Ns Cm stop .
162 Read input from zero or more files.
163 If unspecified, reads from stdin.
164 If multiple files are specified,
166 will halt with the first failed parse.
175 also supports the options
198 should only be used for legacy manuals.
202 which is also the default, determines encoding on-the-fly: if the first
209 parser is used; otherwise, the
214 files are specified with
216 each has its file-type determined this way.
217 If multiple files are
222 is specified, then this format is used exclusively.
226 utility accepts the following
228 arguments, which correspond to output modes:
229 .Bl -tag -width "-Tlocale"
231 Produce 7-bit ASCII output.
236 Produce CSS1/HTML5 output.
240 Parse only: produce no output.
242 .Fl W Ns Cm warning .
243 .It Fl T Ns Cm locale
244 Encode output using the current locale.
258 Produce PostScript output.
260 .Sx PostScript Output .
262 Produce an indented parse tree.
264 Encode output in the UTF\-8 multi-byte format.
268 This is a synonym for
272 If multiple input files are specified, these will be processed by the
273 corresponding filter in-order.
277 which is the default, is rendered in standard 7-bit ASCII documented in
280 Font styles are applied by using back-spaced encoding such that an
284 .Sq _ Ns \e[bs] Ns c ,
287 is the back-space character number 8.
288 Emboldened characters are rendered as
289 .Sq c Ns \e[bs] Ns c .
291 The special characters documented in
293 are rendered best-effort in an ASCII equivalent.
294 If no equivalent is found,
298 Output width is limited to 78 visible columns unless literal input lines
303 arguments are accepted:
305 .It Cm indent Ns = Ns Ar indent
306 The left margin for normal text is set to
308 blank characters instead of the default of five for
312 Increasing this is not recommended; it may result in degraded formatting,
313 for example overfull lines or ugly line breaks.
314 .It Cm width Ns = Ns Ar width
315 The output width is set to
317 which will normalise to \(>=60.
322 conforms to HTML5 using optional self-closing tags.
325 .Pa example.style.css
326 file documents style-sheet classes available for customising output.
327 If a style-sheet is not specified with
330 defaults to simple output (via an embedded style-sheet)
331 readable in any graphical or text-based web
334 Special characters are rendered in decimal-encoded UTF\-8.
338 arguments are accepted:
348 elements and only emit the subtree below the
353 argument will be ignored.
354 This is useful when embedding manual content within existing documents.
355 .It Cm includes Ns = Ns Ar fmt
360 is used as a template for linked header files (usually via the
365 are replaced with the include filename.
366 The default is not to present a
368 .It Cm man Ns = Ns Ar fmt
372 .Ar ../html%S/%N.%S.html ,
373 is used as a template for linked manuals (usually via the
380 are replaced with the linked manual's name and section, respectively.
381 If no section is included, section 1 is assumed.
382 The default is not to
384 .It Cm style Ns = Ns Ar style.css
387 is used for an external style-sheet.
388 This must be a valid absolute or
392 Locale-depending output encoding is triggered with
394 This option is not available on all systems: systems without locale
395 support, or those whose internal representation is not natively UCS-4,
400 for font style specification and available command-line arguments.
402 Translate input format into
405 This is useful for distributing manual sources to legacy systems
412 is passed as input, it is translated into
414 If the input format is
416 the input is copied to the output, expanding any
420 The parser is also run, and as usual, the
424 are displayed before copying the input to the output.
426 PDF-1.1 output may be generated by
429 .Sx PostScript Output
432 arguments and defaults.
433 .Ss PostScript Output
436 Level-2 pages may be generated by
438 Output pages default to letter sized and are rendered in the Times font
440 Margins are calculated as 1/9 the page length and width.
443 Special characters are rendered as in
448 arguments are accepted:
450 .It Cm paper Ns = Ns Ar name
460 You may also manually specify dimensions as
462 width by height in millimetres.
463 If an unknown value is encountered,
470 to force a UTF\-8 locale.
473 for details and options.
475 .Bl -tag -width MANPAGER
477 Any non-empty value of the environment variable
479 will be used instead of the standard pagination program,
482 Specifies the pagination program to use when
485 If neither PAGER nor MANPAGER is defined,
486 .Pa /usr/bin/more Fl s
492 utility exits with one of the following values, controlled by the message
498 .Bl -tag -width Ds -compact
500 No warnings or errors occurred, or those that did were ignored because
501 they were lower than the requested
504 At least one warning occurred, but no error, and
508 At least one parsing error occurred, but no fatal error, and
514 A fatal parsing error occurred.
516 Invalid command line arguments were specified.
517 No input files have been read.
519 An operating system error occurred, for example memory exhaustion or an
520 error accessing input files.
523 to exit at once, possibly in the middle of parsing or formatting a file.
529 .Fl W Ns Cm warning .
531 To page manuals to the terminal:
533 .Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less
534 .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
536 To produce HTML manuals with
540 .Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html
542 To check over a large set of manuals:
544 .Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`
546 To produce a series of PostScript manuals for A4 paper:
548 .Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps
554 format, for use on systems lacking an
558 .Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man
560 Messages displayed by
564 .D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args
566 Line and column numbers start at 1.
567 Both are omitted for messages referring to an input file as a whole.
568 Macro names and arguments are omitted where meaningless.
569 Fatal messages about invalid command line arguments
570 or operating system errors, for example when memory is exhausted,
577 Message levels have the following meanings:
578 .Bl -tag -width "warning"
580 Opening or reading an input file failed, so the parser cannot
581 even be started and no output is produced from that input file.
583 The parser is unable to parse a given input file at all.
584 No formatted output is produced from that input file.
586 An input file contains syntax that cannot be safely interpreted,
587 either because it is invalid or because
589 does not implement it yet.
590 By discarding part of the input or inserting missing tokens,
591 the parser is able to continue, and the error does not prevent
592 generation of formatted output, but typically, preparing that
593 output involves information loss, broken document structure
594 or unintended formatting.
596 An input file uses obsolete, discouraged or non-portable syntax.
597 All the same, the meaning of the input is unambiguous and a correct
598 rendering can be produced.
599 Documents causing warnings may render poorly when using other
600 formatting tools instead of
608 levels are hidden unless their level, or a lower level, is requested using a
613 .Ss Warnings related to the document prologue
615 .It Sy "missing manual title, using UNTITLED"
619 macro has no arguments, or there is no
621 macro before the first non-prologue macro.
622 .It Sy "missing manual title, using \(dq\(dq"
626 macro, or it has no arguments.
627 .It Sy "lower case character in document title"
629 The title is still used as given in the
634 .It Sy "missing manual section, using \(dq\(dq"
640 macro lacks the mandatory section argument.
641 .It Sy "unknown manual section"
643 The section number in a
645 line is invalid, but still used.
646 .It Sy "unknown manual volume or arch"
650 line is invalid, but still used.
651 The manual is assumed to be architecture-independent.
652 .It Sy "missing date, using today's date"
654 The document was parsed as
660 macro has no arguments or only empty arguments;
661 or the document was parsed as
667 macro has less than three arguments or its third argument is empty.
668 .It Sy "cannot parse date, using it verbatim"
674 macro does not follow the conventional format.
675 .It Sy "missing Os macro, using \(dq\(dq"
677 The default or current system is not shown in this case.
678 .It Sy "duplicate prologue macro"
680 One of the prologue macros occurs more than once.
681 The last instance overrides all previous ones.
682 .It Sy "late prologue macro"
688 macro occurs after some non-prologue macro, but still takes effect.
689 .It Sy "skipping late title macro"
693 macro can only occur before the first non-prologue macro
694 because traditional formatters write the page header
695 before parsing the document body.
696 Even though this technical restriction does not apply to
698 traditional semantics is preserved.
699 The late macro is discarded including its arguments.
700 .It Sy "prologue macros out of order"
702 The prologue macros are not given in the conventional order
706 All three macros are used even when given in another order.
708 .Ss Warnings regarding document structure
710 .It Sy ".so is fragile, better use ln(1)"
712 Including files only works when the parser program runs with the correct
713 current working directory.
714 .It Sy "no document body"
716 The document body contains neither text nor macros.
717 An empty document is shown, consisting only of a header and a footer line.
718 .It Sy "content before first section header"
720 Some macros or text precede the first
725 The offending macros and text are parsed and added to the top level
726 of the syntax tree, outside any section block.
727 .It Sy "first section is not NAME"
729 The argument of the first
737 .It Sy "bad NAME section contents"
739 The last node in the NAME section is not an
741 macro, or any preceding macro is not
743 or the NAME section is completely empty.
748 .It Sy "sections out of conventional order"
750 A standard section occurs after another section it usually precedes.
751 All section titles are used as given,
752 and the order of sections is not changed.
753 .It Sy "duplicate section title"
755 The same standard section title occurs more than once.
756 .It Sy "unexpected section"
758 A standard section header occurs in a section of the manual
759 where it normally isn't useful.
760 .It Sy "unusual Xr order"
762 In the SEE ALSO section, an
764 macro with a lower section number follows one with a higher number,
767 macros refering to the same section are out of alphabetical order.
768 .It Sy "unusual Xr punctuation"
770 In the SEE ALSO section, punctuation between two
772 macros differs from a single comma, or there is trailing punctuation
776 .It Sy "AUTHORS section without An macro"
778 An AUTHORS sections contains no
780 macros, or only empty ones.
781 Probably, there are author names lacking markup.
783 .Ss "Warnings related to macros and nesting"
785 .It Sy "obsolete macro"
789 manual for replacements.
790 .It Sy "skipping paragraph macro"
793 documents, this happens
796 at the beginning and end of sections and subsections
798 right before non-compact lists and displays
800 at the end of items in non-column, non-compact lists
802 and for multiple consecutive paragraph macros.
806 documents, it happens
818 macros having neither head nor body arguments
829 .It Sy "moving paragraph macro out of list"
833 list contains a trailing paragraph macro.
834 The paragraph macro is moved after the end of the list.
835 .It Sy "skipping no-space macro"
837 An input line begins with an
840 The macro is ignored.
841 .It Sy "blocks badly nested"
843 If two blocks intersect, one should completely contain the other.
844 Otherwise, rendered output is likely to look strange in any output
845 format, and rendering in SGML-based output formats is likely to be
846 outright wrong because such languages do not support badly nested
848 Typical examples of badly nested blocks are
849 .Qq Ic \&Ao \&Bo \&Ac \&Bc
851 .Qq Ic \&Ao \&Bq \&Ac .
859 .It Sy "nested displays are not portable"
866 display occurs nested inside another
871 but fails with most other implementations.
872 .It Sy "moving content out of list"
876 list block contains text or macros before the first
879 The offending children are moved before the beginning of the list.
880 .It Sy ".Vt block has child macro"
884 macro supports plain text arguments only.
885 Formatting may be ugly and semantic searching
886 for the affected content might not work.
887 .It Sy "fill mode already enabled, skipping"
891 request occurs even though the document is still in fill mode,
892 or already switched back to fill mode.
894 .It Sy "fill mode already disabled, skipping"
898 request occurs even though the document already switched to no-fill mode
899 and did not switch back to fill mode yet.
901 .It Sy "line scope broken"
903 While parsing the next-line scope of the previous macro,
904 another macro is found that prematurely terminates the previous one.
905 The previous, interrupted macro is deleted from the parse tree.
907 .Ss "Warnings related to missing arguments"
909 .It Sy "skipping empty request"
911 The macro name is missing from a macro definition request.
912 .It Sy "conditional request controls empty scope"
914 A conditional request is only useful if any of the following
915 follows it on the same logical input line:
920 keyword to open a multi-line scope.
922 A request or macro or some text, resulting in a single-line scope.
924 The immediate end of the logical line without any intervening whitespace,
925 resulting in next-line scope.
927 Here, a conditional request is followed by trailing whitespace only,
928 and there is no other content on its logical input line.
929 Note that it doesn't matter whether the logical input line is split
930 across multiple physical input lines using
932 line continuation characters.
933 This is one of the rare cases
934 where trailing whitespace is syntactically significant.
935 The conditional request controls a scope containing whitespace only,
936 so it is unlikely to have a significant effect,
937 except that it may control a following
940 .It Sy "skipping empty macro"
942 The indicated macro has no arguments and hence no effect.
943 .It Sy "empty argument, using 0n"
945 The required width is missing after
952 .It Sy "argument count wrong"
954 The indicated macro has too few or too many arguments.
955 The syntax tree will contain the wrong number of arguments as given.
956 Formatting behaviour depends on the specific macro in question.
957 Note that the same message may also occur as an ERROR, see below.
958 .It Sy "missing display type, using -ragged"
962 macro is invoked without the required display type.
963 .It Sy "list type is not the first argument"
967 macro, at least one other argument precedes the type argument.
970 utility copes with any argument order, but some other
972 implementations do not.
973 .It Sy "missing -width in -tag list, using 8n"
982 .It Sy "missing utility name, using \(dq\(dq"
986 macro is called without an argument before
988 has first been called with an argument.
989 .It Sy "empty head in list item"
1001 macro lacks the required argument.
1002 The item head is left empty.
1003 .It Sy "empty list item"
1015 An empty list item is shown.
1016 .It Sy "missing font type"
1020 macro has no argument.
1021 It switches to the default font,
1023 .It Sy "unknown font type"
1027 argument is invalid.
1031 .It Sy "missing -std argument, adding it"
1037 macro lacks the required
1044 even when it is not specified, but other implementations may not.
1046 .Ss "Warnings related to bad macro arguments"
1048 .It Sy "unterminated quoted argument"
1050 Macro arguments can be enclosed in double quote characters
1051 such that space characters and macro names contained in the quoted
1052 argument need not be escaped.
1053 The closing quote of the last argument of a macro can be omitted.
1054 However, omitting it is not recommended because it makes the code
1056 .It Sy "duplicate argument"
1062 macro has more than one
1069 All but the last instances of these arguments are ignored.
1070 .It Sy "skipping duplicate argument"
1074 macro has more than one
1079 All but the first of these arguments are ignored.
1080 .It Sy "skipping duplicate display type"
1084 macro has more than one type argument; the first one is used.
1085 .It Sy "skipping duplicate list type"
1089 macro has more than one type argument; the first one is used.
1090 .It Sy "skipping -width argument"
1104 .It Sy "unknown AT&T UNIX version"
1108 macro has an invalid argument.
1109 It is used verbatim, with
1112 .It Sy "comma in function argument"
1118 macro contains a comma; it should probably be split into two arguments.
1119 .It Sy "invalid content in Rs block"
1123 block contains plain text or non-% macros.
1124 The bogus content is left in the syntax tree.
1125 Formatting may be poor.
1126 .It Sy "invalid Boolean argument"
1130 macro has an argument other than
1134 The invalid argument is moved out of the macro, which leaves the macro
1135 empty, causing it to toggle the spacing mode.
1136 .It Sy "unknown font, skipping request"
1141 request has an invalid argument.
1143 .Ss "Warnings related to plain text"
1145 .It Sy "blank line in fill mode, using .sp"
1147 The meaning of blank input lines is only well-defined in non-fill mode:
1148 In fill mode, line breaks of text input lines are not supposed to be
1150 However, for compatibility with groff, blank lines in fill mode
1154 .It Sy "tab in filled text"
1156 The meaning of tab characters is only well-defined in non-fill mode:
1157 In fill mode, whitespace is not supposed to be significant
1158 on text input lines.
1159 As an implementation dependent choice, tab characters on text lines
1160 are passed through to the formatters in any case.
1161 Given that the text before the tab character will be filled,
1162 it is hard to predict which tab stop position the tab will advance to.
1163 .It Sy "whitespace at end of input line"
1164 .Pq mdoc , man , roff
1165 Whitespace at the end of input lines is almost never semantically
1166 significant \(em but in the odd case where it might be, it is
1167 extremely confusing when reviewing and maintaining documents.
1168 .It Sy "bad comment style"
1170 Comment lines start with a dot, a backslash, and a double-quote character.
1173 utility treats the line as a comment line even without the backslash,
1174 but leaving out the backslash might not be portable.
1175 .It Sy "invalid escape sequence"
1177 An escape sequence has an invalid opening argument delimiter, lacks the
1178 closing argument delimiter, or the argument has too few characters.
1179 If the argument is incomplete,
1183 expand to an empty string,
1189 to the length of the incomplete argument.
1190 All other invalid escape sequences are ignored.
1191 .It Sy "undefined string, using \(dq\(dq"
1193 If a string is used without being defined before,
1194 its value is implicitly set to the empty string.
1195 However, defining strings explicitly before use
1196 keeps the code more readable.
1198 .Ss "Errors related to equations"
1200 .It "unexpected equation scope closure"
1201 .It "equation scope open on exit"
1202 .It "overlapping equation scopes"
1203 .It "unexpected end of equation"
1204 .It "equation syntax error"
1206 .Ss "Errors related to tables"
1208 .It "bad table syntax"
1209 .It "bad table option"
1210 .It "bad table layout"
1211 .It "no table layout cells specified"
1212 .It "no table data cells specified"
1213 .It "ignore data in cell"
1214 .It "data block still open"
1215 .It "ignoring extra data cells"
1217 .Ss "Errors related to roff, mdoc, and man code"
1219 .It Sy "input stack limit exceeded, infinite loop?"
1221 Explicit recursion limits are implemented for the following features,
1222 in order to prevent infinite loops:
1225 expansion of nested escape sequences
1226 including expansion of strings and number registers,
1228 expansion of nested user-defined macros,
1234 When a limit is hit, the output is incorrect, typically losing
1235 some content, but the parser can continue.
1236 .It Sy "skipping bad character"
1237 .Pq mdoc , man , roff
1238 The input file contains a byte that is not a printable
1241 The message mentions the character number.
1242 The offending byte is replaced with a question mark
1244 Consider editing the input file to replace the byte with an ASCII
1245 transliteration of the intended character.
1246 .It Sy "skipping unknown macro"
1247 .Pq mdoc , man , roff
1248 The first identifier on a request or macro line is neither recognized as a
1250 request, nor as a user-defined macro, nor, respectively, as an
1255 It may be mistyped or unsupported.
1256 The request or macro is discarded including its arguments.
1257 .It Sy "skipping item outside list"
1261 macro occurs outside any
1264 It is discarded including its arguments.
1265 .It Sy "skipping column outside column list"
1269 macro occurs outside any
1272 It is discarded including its arguments.
1273 .It Sy "skipping end of block that is not open"
1274 .Pq mdoc , man , eqn , tbl , roff
1275 Various syntax elements can only be used to explicitly close blocks
1276 that have previously been opened.
1279 block closing macro, a
1284 macro, or the end of an equation, table, or
1286 conditional request is encountered but no matching block is open.
1287 The offending request or macro is discarded.
1288 .It Sy "inserting missing end of block"
1292 macros as well as tables require explicit closing by dedicated macros.
1293 A block that doesn't support bad nesting
1294 ends before all of its children are properly closed.
1295 The open child nodes are closed implicitly.
1296 .It Sy "scope open on exit"
1297 .Pq mdoc , man , eqn , tbl , roff
1298 At the end of the document, an explicit
1306 block, an equation, table, or
1308 conditional or ignore block is still open.
1309 The open block is closed implicitly.
1310 .It Sy "escaped character not allowed in a name"
1312 Macro, string and register identifiers consist of printable,
1313 non-whitespace ASCII characters.
1314 Escape sequences and characters and strings expressed in terms of them
1315 cannot form part of a name.
1316 The first argument of an
1324 request, or any argument of an
1326 request, or the name of a request or user defined macro being called,
1327 is terminated by an escape sequence.
1333 the request has no effect at all.
1340 what was parsed up to this point is used as the arguments to the request,
1341 and the rest of the input line is discarded including the escape sequence.
1342 When parsing for a request or a user-defined macro name to be called,
1343 only the escape sequence is discarded.
1344 The characters preceding it are used as the request or macro name,
1345 the characters following it are used as the arguments to the request or macro.
1346 .It Sy "argument count wrong"
1347 .Pq mdoc , man , roff
1348 The indicated request or macro has too few or too many arguments.
1349 The syntax tree will contain the wrong number of arguments as given.
1350 Formatting behaviour depends on the specific request or macro in question.
1351 Note that the same message may also occur as a WARNING, see above.
1352 .It Sy "missing list type, using -item"
1356 macro fails to specify the list type.
1357 .It Sy "missing manual name, using \(dq\(dq"
1361 lacks the required argument.
1362 .It Sy "uname(3) system call failed, using UNKNOWN"
1366 macro is called without arguments, and the
1371 can be compiled with
1373 .Fl D Cm OSNAME=\(dq\e\(dq Ar string Cm \e\(dq\(dq .
1375 .It Sy "unknown standard specifier"
1379 macro has an unknown argument and is discarded.
1380 .It Sy "skipping request without numeric argument"
1384 request has a non-numeric or negative argument or no argument at all.
1385 The invalid request is ignored.
1386 .It Sy "skipping all arguments"
1387 .Pq mdoc , man , eqn , roff
1400 macro in a list that don't support item heads, a
1412 block closing request is invoked with at least one argument.
1413 All arguments are ignored.
1414 .It Sy "skipping excess arguments"
1418 macro is invoked with more than one argument, or a request of the
1420 family is invoked with more than two arguments.
1421 The excess arguments are ignored.
1425 .It Sy "input too large"
1429 cannot handle input files larger than its arbitrary size limit
1430 of 2^31 bytes (2 Gigabytes).
1431 Since useful manuals are always small, this is not a problem in practice.
1432 Parsing is aborted as soon as the condition is detected.
1433 .It Sy "NOT IMPLEMENTED: Bd -file"
1435 For security reasons, the
1437 macro does not support the
1440 By requesting the inclusion of a sensitive file, a malicious document
1441 might otherwise trick a privileged user into inadvertently displaying
1442 the file on the screen, revealing the file content to bystanders.
1443 The parser exits immediately.
1444 .It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"
1446 For security reasons,
1450 file inclusion requests only with relative paths
1451 and only without ascending to any parent directory.
1452 By requesting the inclusion of a sensitive file, a malicious document
1453 might otherwise trick a privileged user into inadvertently displaying
1454 the file on the screen, revealing the file content to bystanders.
1455 The parser exits immediately.
1456 .It Sy ".so request failed"
1460 request requires reading an external file.
1461 While trying to do so, an
1467 The parser exits immediately.
1468 Before showing this message,
1470 always shows another message explaining why the system call failed.
1473 This section summarises
1475 compatibility with GNU troff.
1476 Each input and output format is separately noted.
1477 .Ss ASCII Compatibility
1478 .Bl -bullet -compact
1480 Unrenderable unicode codepoints specified with
1482 escapes are printed as
1485 In GNU troff, these raise an error.
1495 are synonyms, as are \-filled and \-ragged.
1497 In historic GNU troff, the
1500 macro does not underline when scoped under an
1502 in the FILES section.
1503 This behaves correctly in
1506 A list or display following the
1511 does not assert a prior vertical break, just as it doesn't with
1521 Words aren't hyphenated.
1523 .Ss HTML Compatibility
1524 .Bl -bullet -compact
1528 escape will revert the font to the previous
1530 escape, not to the last rendered decoration, which is now dictated by
1531 CSS instead of hard-coded.
1532 It also will not span past the current scope,
1533 for the same reason.
1536 mode, this will work fine.
1543 list types render similarly (no break following overreached left-hand
1544 side) due to the expressive constraints of HTML.
1551 lists render similarly.
1563 utility was written by
1564 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1570 the maximum size of an element attribute is determined by
1572 which is usually 1024 bytes.
1573 Be aware of this when setting long link
1575 .Fl O Ns Cm style Ns = Ns Ar really/long/link .
1577 Nesting elements within next-line element scopes of
1587 and cause them to forget the formatting of the prior next-line scope.
1591 control character is an alias for the standard macro control character
1592 and does not emit a line-break as stipulated in GNU troff.
git.ckatri.com / mandoc.git / blob