diff options
| -rw-r--r-- | man.7 | 457 | ||||
| -rw-r--r-- | mandoc.1 | 130 | ||||
| -rw-r--r-- | mdoc.7 | 730 |
3 files changed, 698 insertions, 619 deletions
@@ -20,116 +20,121 @@ . . .Sh NAME -. Nm man -. Nd man language reference +.Nm man +.Nd man language reference . . .Sh DESCRIPTION The -. Nm man +.Nm man language was historically used to format -. Ux +.Ux manuals. This reference document describes its syntax, structure, and usage. -. Pp -. Bf -emphasis +. +.Pp +.Bf -emphasis Do not use -. Nm +.Nm to write your manuals. -. Ef +.Ef Use the -. Xr mdoc 7 +.Xr mdoc 7 language, instead. -. Pp +. +.Pp An -. Nm +.Nm document follows simple rules: lines beginning with the control character -. Sq \&. +.Sq \&. are parsed for macros. Other lines are interpreted within the scope of prior macros: -. Bd -literal -offset indent +.Bd -literal -offset indent \&.SH Macro lines change control state. Other lines are interpreted within the current state. -. Ed +.Ed . . .Sh INPUT ENCODING -. Nm +.Nm documents may contain only graphable 7-bit ASCII characters, the space character, and the tabs character. All manuals must have -. Ux +.Ux line termination. -. Pp +. +.Pp Blank lines are acceptable; where found, the output will assert a vertical space. -. Pp +. +.Pp The -. Sq \ec +.Sq \ec escape is common in historical -. Nm +.Nm documents; if encountered at the end of a word, it ensures that the subsequent word isn't off-set by whitespace. . . -. Ss Comments +.Ss Comments Text following a -. Sq \e\*" , +.Sq \e\*" , whether in a macro or free-form text line, is ignored to the end of line. A macro line with only a control character and comment escape, -. Sq \&.\e" , +.Sq \&.\e" , is also ignored. Macro lines with only a control charater and optionally whitespace are stripped from input. . . -. Ss Special Characters +.Ss Special Characters Special characters may occur in both macro and free-form lines. Sequences begin with the escape character -. Sq \e +.Sq \e followed by either an open-parenthesis -. Sq \&( +.Sq \&( for two-character sequences; an open-bracket -. Sq \&[ +.Sq \&[ for n-character sequences (terminated at a close-bracket -. Sq \&] ) ; +.Sq \&] ) ; or a single one-character sequence. See -. Xr mandoc_char 7 +.Xr mandoc_char 7 for a complete list. Examples include -. Sq \e(em -. Pq em-dash +.Sq \e(em +.Pq em-dash and -. Sq \ee -. Pq back-slash . +.Sq \ee +.Pq back-slash . . . -. Ss Text Decoration +.Ss Text Decoration Terms may be text-decorated using the -. Sq \ef +.Sq \ef escape followed by an indicator: B (bold), I, (italic), or P and R (Roman, or reset). . . -. Ss Whitespace +.Ss Whitespace Unless specifically escaped, consecutive blocks of whitespace are pruned from input. These are later re-added, if applicable, by a front-end utility such as -. Xr mandoc 1 . +.Xr mandoc 1 . . . .Sh MANUAL STRUCTURE Each -. Nm +.Nm document must contain contains at least the -. Sq TH +.Sq TH macro describing the document's section and title. It may occur anywhere in the document, although conventionally, it appears as the first macro. -. Pp +. +.Pp Beyond -. Sq TH , +.Sq TH , at least one macro or text node must appear in the document. Documents are generally structured as follows: -. Bd -literal -offset indent +.Bd -literal -offset indent \&.TH FOO 1 "13 Aug 2009" \&. \&.SH NAME @@ -154,362 +159,378 @@ The \efBfoo\efR utility does... \&.\e\*q .SH AUTHORS \&.\e\*q .SH CAVEATS \&.\e\*q .SH BUGS -. Ed +.Ed . . .Sh MACRO SYNTAX Macros are one to three three characters in length and begin with a control character , -. Sq \&. , +.Sq \&. , at the beginning of the line. An arbitrary amount of whitespace may sit between the control character and the macro name. Thus, -. Sq .PP +.Sq .PP and -. Sq \&.\ \ \ PP +.Sq \&.\ \ \ PP are equivalent. -. Pp +. +.Pp The -. Nm +.Nm macros are classified by scope: line scope or block scope. Line macros are only scoped to the current line (and, in some situations, the subsequent line). Block macros are scoped to the current line and subsequent lines until closed by another block macro. . . -. Ss Line Macros +.Ss Line Macros Line macros are generally scoped to the current line, with the body consisting of zero or more arguments. If a macro is scoped to the next line and the line arguments are empty, the next line is used instead, else the general syntax is used. Thus: -. Bd -literal -offset indent +.Bd -literal -offset indent \&.I foo -. Ed -. Pp +.Ed +. +.Pp is equivalent to -. Sq \&.I foo . +.Sq \&.I foo . .\" PARAGRAPH Consecutive next-line scope invocations are disallowed. -. Bd -literal -offset indent +.Bd -literal -offset indent \&.YO \(lBbody...\(rB \(lBbody...\(rB -. Ed -. Pp +.Ed +. +.Pp It is considered an error when next-line scope is open at the end of file. -. Pp -. Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" -. It Em Macro Ta Em Arguments Ta Em Scope -. It B Ta n Ta next-line -. It BI Ta n Ta current -. It BR Ta n Ta current -. It DT Ta 0 Ta current -. It I Ta n Ta next-line -. It IB Ta n Ta current -. It IR Ta n Ta current -. It R Ta n Ta next-line -. It RB Ta n Ta current -. It RI Ta n Ta current -. It SB Ta n Ta next-line -. It SM Ta n Ta next-line -. It TH Ta >1, <6 Ta current -. It br Ta 0 Ta current -. It fi Ta 0 Ta current -. It i Ta n Ta current -. It na Ta 0 Ta current -. It nf Ta 0 Ta current -. It r Ta 0 Ta current -. It sp Ta 1 Ta current -. El -. Pp +. +.Pp +.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" +.It Em Macro Ta Em Arguments Ta Em Scope +.It B Ta n Ta next-line +.It BI Ta n Ta current +.It BR Ta n Ta current +.It DT Ta 0 Ta current +.It I Ta n Ta next-line +.It IB Ta n Ta current +.It IR Ta n Ta current +.It R Ta n Ta next-line +.It RB Ta n Ta current +.It RI Ta n Ta current +.It SB Ta n Ta next-line +.It SM Ta n Ta next-line +.It TH Ta >1, <6 Ta current +.It br Ta 0 Ta current +.It fi Ta 0 Ta current +.It i Ta n Ta current +.It na Ta 0 Ta current +.It nf Ta 0 Ta current +.It r Ta 0 Ta current +.It sp Ta 1 Ta current +.El +. +.Pp The -. Sq RS , -. Sq RE , -. Sq br , -. Sq fi , -. Sq i , -. Sq na , -. Sq nf , -. Sq r , +.Sq RS , +.Sq RE , +.Sq br , +.Sq fi , +.Sq i , +.Sq na , +.Sq nf , +.Sq r , and -. Sq sp +.Sq sp macros aren't historically part of -. Nm +.Nm and should not be used. They're included for compatibility. . . -. Ss Block Macros +.Ss Block Macros Block macros are comprised of a head and body. Like for in-line macros, the head is scoped to the current line and, in one circumstance, the next line; the body is scoped to subsequent lines and is closed out by a subsequent block macro invocation. -. Bd -literal -offset indent +.Bd -literal -offset indent \&.YO \(lBhead...\(rB \(lBhead...\(rB \(lBbody...\(rB -. Ed -. Pp +.Ed +. +.Pp The closure of body scope may be to the section, where a macro is closed by -. Sq SH ; +.Sq SH ; sub-section, closed by a section or -. Sq SS ; +.Sq SS ; part, closed by a section, sub-section, or -. Sq RE ; +.Sq RE ; or paragraph, closed by a section, sub-section, part, -. Sq HP , -. Sq IP , -. Sq LP , -. Sq P , -. Sq PP , +.Sq HP , +.Sq IP , +.Sq LP , +.Sq P , +.Sq PP , or -. Sq TP . +.Sq TP . No closure refers to an explicit block closing macro. -. Pp +. +.Pp It is considered an error when part or next-line scope is open at the end of file. -. Pp -. Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent -. It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope -. It HP Ta <2 Ta current Ta paragraph -. It IP Ta <3 Ta current Ta paragraph -. It LP Ta 0 Ta current Ta paragraph -. It P Ta 0 Ta current Ta paragraph -. It PP Ta 0 Ta current Ta paragraph -. It RE Ta 0 Ta current Ta none -. It RS Ta 1 Ta current Ta part -. It SH Ta >0 Ta current Ta section -. It SS Ta >0 Ta current Ta sub-section -. It TP Ta n Ta next-line Ta paragraph -. El -. Pp +. +.Pp +.Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent +.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope +.It HP Ta <2 Ta current Ta paragraph +.It IP Ta <3 Ta current Ta paragraph +.It LP Ta 0 Ta current Ta paragraph +.It P Ta 0 Ta current Ta paragraph +.It PP Ta 0 Ta current Ta paragraph +.It RE Ta 0 Ta current Ta none +.It RS Ta 1 Ta current Ta part +.It SH Ta >0 Ta current Ta section +.It SS Ta >0 Ta current Ta sub-section +.It TP Ta n Ta next-line Ta paragraph +.El +. +.Pp If a block macro is next-line scoped, it may only be followed by in-line macros (excluding -. Sq DT , -. Sq TH , -. Sq br , -. Sq na , -. Sq sp , -. Sq nf , +.Sq DT , +.Sq TH , +.Sq br , +.Sq na , +.Sq sp , +.Sq nf , and -. Sq fi ) . +.Sq fi ) . . . .Sh REFERENCE This section is a canonical reference to all macros, arranged alphabetically. For the scoping of individual macros, see -. Sx MACRO SYNTAX . +.Sx MACRO SYNTAX . . . -. Ss Definitions +.Ss Definitions In this reference, a numerical width may be either a standalone natural number (such as 3, 4, 10, etc.) or a natural number followed by a width multiplier -. Qq n , +.Qq n , corresponding to the width of the formatted letter n, or -. Qq m , +.Qq m , corresponding to the width of the formatted letter m. The latter is the default, if unspecified. Thus, -. Bd -literal -offset indent +.Bd -literal -offset indent \&.HP 12n -. Ed -. Pp +.Ed +. +.Pp indicates an offset of 12 -. Qq n -. Ns -sized +.Qq n +.Ns -sized letters. . . -. Ss Macro Reference -. Bl -tag -width Ds -. It B +.Ss Macro Reference +.Bl -tag -width Ds +.It B Text is rendered in bold face. -. It BI +.It BI Text is rendered alternately in bold face and italic. Thus, -. Sq .BI this word and that +.Sq .BI this word and that causes -. Sq this +.Sq this and -. Sq and +.Sq and to render in bold face, while -. Sq word +.Sq word and -. Sq that +.Sq that render in italics. Whitespace between arguments is omitted in output. -. It BR +.It BR Text is rendered alternately in bold face and roman (the default font). Whitespace between arguments is omitted in output. -. It DT +.It DT Re-set the tab spacing to 0.5 inches. -. It HP +.It HP Begin a paragraph whose initial output line is left-justified, but subsequent output lines are indented, with the following syntax: -. Bd -literal -offset indent +.Bd -literal -offset indent \&.HP [width] -. Ed -. Pp +.Ed +. +.Pp If -. Va width +.Va width is specified, it's saved for later paragraph left-margins; if unspecified, the saved or default width is used. -. It I +.It I Text is rendered in italics. -. It IB +.It IB Text is rendered alternately in italics and bold face. Whitespace between arguments is omitted in output. -. It IP +.It IP Begin a paragraph with the following syntax: -. Bd -literal -offset indent +.Bd -literal -offset indent \&.IP [head [width]] -. Ed -. Pp +.Ed +. +.Pp This follows the behaviour of the -. Sq TP +.Sq TP except for the macro syntax (all arguments on the line, instead of having next-line scope). If -. Va width +.Va width is specified, it's saved for later paragraph left-margins; if unspecified, the saved or default width is used. -. It IR +.It IR Text is rendered alternately in italics and roman (the default font). Whitespace between arguments is omitted in output. -. It LP, P, PP +.It LP, P, PP Begin an undecorated paragraph. The scope of a paragraph is closed by a subsequent paragraph, sub-section, section, or end of file. The saved paragraph left-margin width is re-set to the default. -. It R +.It R Text is rendered in roman (the default font). -. It RB +.It RB Text is rendered alternately in roman (the default font) and bold face. Whitespace between arguments is omitted in output. -. It RE +.It RE Explicitly close out the scope of a prior -. Sq RS . -. It RI +.Sq RS . +.It RI Text is rendered alternately in roman (the default font) and italics. Whitespace between arguments is omitted in output. -. It RS +.It RS Begin a part setting the left margin. The left margin controls the offset, following an initial indentation, to un-indented text such as that of -. Sq PP . +.Sq PP . The width may be specified as following: -. Bd -literal -offset indent +.Bd -literal -offset indent \&.RS [width] -. Ed -. Pp +.Ed +. +.Pp If -. Va width +.Va width is not specified, the saved or default width is used. -. It SB +.It SB Text is rendered in small size (one point smaller than the default font) bold face. -. It SH +.It SH Begin a section. The scope of a section is only closed by another section or the end of file. The paragraph left-margin width is re-set to the default. -. It SM +.It SM Text is rendered in small size (one point smaller than the default font). -. It SS +.It SS Begin a sub-section. The scope of a sub-section is closed by a subsequent sub-section, section, or end of file. The paragraph left-margin width is re-set to the default. -. It TH +.It TH Sets the title of the manual page with the following syntax: -. Bd -literal -offset indent +.Bd -literal -offset indent \&.TH title section [date [source [volume]]] -. Ed -. Pp +.Ed +. +.Pp At least the -. Va title +.Va title and -. Va section +.Va section arguments must be provided. The -. Va date +.Va date argument should be formatted as -. Qq %b [%d] %Y +.Qq %b [%d] %Y format, described in -. Xr strptime 3 . +.Xr strptime 3 . The -. Va source +.Va source string specifies the organisation providing the utility. The -. Va volume +.Va volume replaces the default rendered volume as dictated by the manual section. -. It TP +.It TP Begin a paragraph where the head, if exceeding the indentation width, is followed by a newline; if not, the body follows on the same line after a buffer to the indentation width. Subsequent output lines are indented. -. Pp +. +.Pp The indentation width may be set as follows: -. Bd -literal -offset indent +.Bd -literal -offset indent \&.TP [width] -. Ed -. Pp +.Ed +. +.Pp Where -. Va width +.Va width must be a properly-formed numeric width. If -. Va width +.Va width is specified, it's saved for later paragraph left-margins; if unspecified, the saved or default width is used. -. It br +.It br Breaks the current line. Consecutive invocations have no further effect. -. It fi +.It fi End literal mode begun by -. Sq nf . -. It i +.Sq nf . +.It i Italicise arguments. If no arguments are specified, all subsequent text is italicised. -. It na +.It na Don't alignment the right margin. -. It nf +.It nf Begin literal mode: all subsequent free-form lines have their end of line boundaries preserved. May be ended by -. Sq fi . -. It r +.Sq fi . +.It r Fonts and styles (bold face, italics) reset to roman (default font). -. It sp +.It sp Insert n spaces, where n is the macro's positive numeric argument. If 0, this is equivalent to the -. Sq br +.Sq br macro. -. El +.El . . .Sh COMPATIBILITY This section documents compatibility with other roff implementations, at this time limited to -. Xr groff 1 . -. Bl -hyphen -. It +.Xr groff 1 . +.Bl -hyphen +.It In quoted literals, groff allowed pair-wise double-quotes to produce a standalone double-quote in formatted output. This idiosyncratic behaviour is no longer applicable. -. It +.It The -. Sq sp +.Sq sp macro does not accept negative numbers. -. It +.It Blocks of whitespace are stripped from both macro and free-form text lines (except when in literal mode), while groff would retain whitespace in free-form text lines. -. El +.El . . .Sh SEE ALSO -. Xr mandoc 1 , -. Xr mandoc_char 7 +.Xr mandoc 1 , +.Xr mandoc_char 7 . . .Sh AUTHORS The -. Nm +.Nm reference was written by -. An Kristaps Dzonsons Aq kristaps@kth.se . +.An Kristaps Dzonsons Aq kristaps@kth.se . . . .Sh CAVEATS Do not use this language. Use -. Xr mdoc 7 , +.Xr mdoc 7 , instead. . @@ -17,11 +17,13 @@ .Dd $Mdocdate$ .Dt MANDOC 1 .Os -.\" SECTION +. +. .Sh NAME .Nm mandoc .Nd format and display UNIX manuals -.\" SECTION +. +. .Sh SYNOPSIS .Nm mandoc .Op Fl V @@ -30,35 +32,36 @@ .Op Fl W Ns Ar err... .Op Fl T Ns Ar output .Op Ar infile... -.\" SECTION +. +. .Sh DESCRIPTION The .Nm utility formats .Ux manual pages for display. The arguments are as follows: +. .Bl -tag -width Ds -.\" ITEM .It Fl f Ns Ar option... Override default compiler behaviour. See .Sx Compiler Options for details. -.\" ITEM +. .It Fl m Ns Ar format Input format. See .Sx Input Formats for available formats. Defaults to .Fl m Ns Ar andoc . -.\" ITEM +. .It Fl T Ns Ar output Output format. See .Sx Output Formats for available formats. Defaults to .Fl T Ns Ar ascii . -.\" ITEM +. .It Fl V Print version and exit. -.\" ITEM +. .It Fl W Ns Ar err... Configure warning messages. Use .Fl W Ns Ar all @@ -69,7 +72,7 @@ termination. Multiple .Fl W arguments may be comma-separated, such as .Fl W Ns Ar error,all . -.\" ITEM +. .It Ar infile... Read input from zero or more .Ar infile . @@ -77,7 +80,7 @@ If unspecified, reads from stdin. If multiple files are specified, .Nm will halt with the first failed parse. .El -.\" PARAGRAPH +. .Pp By default, .Nm @@ -90,10 +93,11 @@ text from stdin, implying and prints 78-column backspace-encoded output to stdout as if .Fl T Ns Ar ascii were provided. -.\" PARAGRAPH +. .Pp .Ex -std mandoc -.\" SUB-SECTION +. +. .Ss Punctuation and Spacing If punctuation is set apart from words, such as in the phrase .Dq to be \&, or not to be , @@ -120,10 +124,12 @@ and .Sq \&} .Pc is not preceded by whitespace. +. .Pp If the input is .Xr mdoc 7 , these rules are also applied to macro arguments when appropriate. +. .Pp White-space, in non-literal (normal) mode, is stripped from input and replaced on output by a single space. Thus, if you wish to preserve @@ -133,7 +139,8 @@ or used in a literal display mode, e.g., .Sq \&Bd \-literal in .Xr mdoc 7 . -.\" SUB-SECTION +. +. .Ss Input Formats The .Nm @@ -152,6 +159,7 @@ format is recommended; .Xr man 7 should only be used for legacy manuals. +. .Pp A third option, .Fl m Ns Ar andoc , @@ -165,6 +173,7 @@ the parser is used; otherwise, the .Xr man 7 parser is used. +. .Pp If multiple files are specified with @@ -175,64 +184,65 @@ specified and or .Fl m Ns Ar an is specified, then this format is used exclusively. -.\" .Pp -.\" The following escape sequences are recognised, although the per-format -.\" compiler may not allow certain sequences. -.\" .Bl -tag -width Ds -offset XXXX -.\" .It \efX -.\" sets the font mode to X (B, I, R or P, where P resets the font) -.\" .It \eX, \e(XX, \e[XN] -.\" queries the special-character table for a corresponding symbol -.\" .It \e*X, \e*(XX, \e*[XN] -.\" deprecated special-character format -.\" .El -.\" SUB-SECTION +. +. .Ss Output Formats The .Nm utility accepts the following .Fl T arguments: +. .Bl -tag -width Ds .It Fl T Ns Ar ascii Produce 7-bit ASCII output, backspace-encoded for bold and underline styles. This is the default. +. .It Fl T Ns Ar tree Produce an indented parse tree. +. .It Fl T Ns Ar lint Parse only: produce no output. .El +. .Pp If multiple input files are specified, these will be processed by the corresponding filter in-order. -.\" SUB-SECTION +. +. .Ss Compiler Options Default compiler behaviour may be overriden with the .Fl f flag. +. .Bl -tag -width Ds .It Fl f Ns Ar ign-scope When rewinding the scope of a block macro, forces the compiler to ignore scope violations. This can seriously mangle the resulting tree. .Pq mdoc only +. .It Fl f Ns Ar no-ign-escape Don't ignore invalid escape sequences. +. .It Fl f Ns Ar no-ign-macro Do not ignore unknown macros at the start of input lines. +. .It Fl f Ns Ar no-ign-chars Do not ignore disallowed characters. +. .It Fl f Ns Ar strict Implies .Fl f Ns Ar no-ign-escape , .Fl f Ns Ar no-ign-macro and .Fl f Ns Ar no-ign-chars . +. .It Fl f Ns Ar ign-errors Don't halt when encountering parse errors. Useful with .Fl T Ns Ar lint over a large set of manuals passed on the command line. .El -.\" PARAGRAPH +. .Pp As with the .Fl W @@ -242,60 +252,90 @@ options may be grouped and delimited with a comma. Using .Fl f Ns Ar ign-scope,no-ign-escape , for example, will try to ignore scope and not ignore character-escape errors. -.\" SECTION +. +. .Sh EXAMPLES To page manuals to the terminal: -.\" PARAGRAPH +. .Pp .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less -.\" PARAGRAPH +. .Pp To check over a large set of manuals: -.\" PARAGRAPH +. .Pp .Dl % mandoc \-Tlint \-fign-errors `find /usr/src -name \e*\e.[1-9]` -.\" SECTION +. +. .Sh COMPATIBILITY -.\" FIXME: libman `na' and `DT' have no effect. This section summarises .Nm compatibility with .Xr groff 1 . -.Pp +Each input and output format is separately noted. +. +. +.Ss ASCII output .Bl -bullet -compact -.\" LIST-ITEM .It The .Sq \e~ -special character doesn't produce expected behaviour. -.\" LIST-ITEM +special character doesn't produce expected behaviour in +.Fl T Ns Ar ascii . +. +.It +The +.Sq \&Bd \-literal +and +.Sq \&Bd \-unfilled +macros of +.Xr mdoc 7 +in +.Fl T Ns Ar ascii +are synonyms, as are \-filled and \-ragged. +. .It In .Xr groff 1 , the .Sq \&Pa -macro does not underline when under a +.Xr mdoc 7 +macro does not underline when scoped under an .Sq \&It in the FILES section. This behaves correctly in .Nm . -.\" LIST-ITEM +. .It A list or display following .Sq \&Ss +.Xr mdoc 7 +macro in +.Fl T Ns Ar ascii does not assert a prior vertical break, just as it doesn't with .Sq \&Sh . +. .It -The \-literal and \-unfilled -.Sq \&Bd -displays types are synonyms, as are \-filled and \-ragged. -.\" LIST-ITEM +The +.Sq \&na +and +.Sq \&Dt +.Xr man 7 +macros in +.Fl T Ns Ar ascii +have no effect. +. .It Words aren't hyphenated. -.\" LIST-ITEM +. .It In normal mode (not a literal block), blocks of spaces aren't preserved, -so double spaces following sentence closure are reduced to a single space. +so double spaces following sentence closure are reduced to a single space; +.Xr groff 1 +retains spaces. +. +.It +Sentences are unilaterally monospaced. .El .\" SECTION .Sh SEE ALSO @@ -20,209 +20,216 @@ . . .Sh NAME -. Nm mdoc -. Nd mdoc language reference +.Nm mdoc +.Nd mdoc language reference . . .Sh DESCRIPTION The -. Nm mdoc +.Nm mdoc language is used to format -. Bx -. Ux +.Bx +.Ux manuals. In this reference document, we describe its syntax, structure, and usage. Our reference implementation is -. Xr mandoc 1 . +.Xr mandoc 1 . The -. Sx COMPATIBILITY +.Sx COMPATIBILITY section describes compatibility with -. Xr groff 1 . -. Pp +.Xr groff 1 . +. +.Pp An -. Nm +.Nm document follows simple rules: lines beginning with the control character -. Sq \. +.Sq \. are parsed for macros. Other lines are interpreted within the scope of prior macros: -. Bd -literal -offset indent +.Bd -literal -offset indent \&.Sh Macro lines change control state. Other lines are interpreted within the current state. -. Ed +.Ed . . .Sh LANGUAGE SYNTAX -. Nm +.Nm documents may contain only graphable 7-bit ASCII characters, the space character, and, in certain circumstances, the tab character. All manuals must have -. Ux +.Ux line terminators. . . -. Ss Comments +.Ss Comments Text following a -. Sq \e" , +.Sq \e" , whether in a macro or free-form text line, is ignored to the end of line. A macro line with only a control character and comment escape, -. Sq \&.\e" , +.Sq \&.\e" , is also ignored. . . -. Ss Reserved Characters +.Ss Reserved Characters Within a macro line, the following characters are reserved: -. Bl -tag -width Ds -offset indent -compact -. It \&. -. Pq period -. It \&, -. Pq comma -. It \&: -. Pq colon -. It \&; -. Pq semicolon -. It \&( -. Pq left-parenthesis -. It \&) -. Pq right-parenthesis -. It \&[ -. Pq left-bracket -. It \&] -. Pq right-bracket -. It \&? -. Pq question -. It \&! -. Pq exclamation -. It \&| -. Pq vertical bar -. El -. Pp +.Bl -tag -width Ds -offset indent -compact +.It \&. +.Pq period +.It \&, +.Pq comma +.It \&: +.Pq colon +.It \&; +.Pq semicolon +.It \&( +.Pq left-parenthesis +.It \&) +.Pq right-parenthesis +.It \&[ +.Pq left-bracket +.It \&] +.Pq right-bracket +.It \&? +.Pq question +.It \&! +.Pq exclamation +.It \&| +.Pq vertical bar +.El +. +.Pp Use of reserved characters is described in -. Sx MACRO SYNTAX . +.Sx MACRO SYNTAX . For general use in macro lines, these characters must either be escaped with a non-breaking space -. Pq Sq \e& +.Pq Sq \e& or, if applicable, an appropriate escape sequence used. . . -. Ss Special Characters +.Ss Special Characters Special characters may occur in both macro and free-form lines. Sequences begin with the escape character -. Sq \e +.Sq \e followed by either an open-parenthesis -. Sq \&( +.Sq \&( for two-character sequences; an open-bracket -. Sq \&[ +.Sq \&[ for n-character sequences (terminated at a close-bracket -. Sq \&] ) ; +.Sq \&] ) ; or a single one-character sequence. See -. Xr mandoc_char 7 +.Xr mandoc_char 7 for a complete list. Examples include -. Sq \e(em -. Pq em-dash +.Sq \e(em +.Pq em-dash and -. Sq \ee -. Pq back-slash . +.Sq \ee +.Pq back-slash . . . -. Ss Text Decoration +.Ss Text Decoration Terms may be text-decorated using the -. Sq \ef +.Sq \ef escape followed by an indicator: B (bold), I, (italic), or P and R (Roman, or reset). This form is not recommended for -. Nm , +.Nm , which encourages semantic, not presentation, annotation. . . -. Ss Predefined Strings +.Ss Predefined Strings Historically, -. Xr groff 1 +.Xr groff 1 also defined a set of package-specific -. Dq predefined strings , +.Dq predefined strings , which, like -. Sx Special Characters , +.Sx Special Characters , demark special output characters and strings by way of input codes. Predefined strings are escaped with the slash-asterisk, -. Sq \e* : +.Sq \e* : single-character -. Sq \e*X , +.Sq \e*X , two-character -. Sq \e*(XX , +.Sq \e*(XX , and N-character -. Sq \e*[N] . +.Sq \e*[N] . See -. Xr mandoc_char 7 +.Xr mandoc_char 7 for a complete list. Examples include -. Sq \e*(Am -. Pq ampersand +.Sq \e*(Am +.Pq ampersand and -. Sq \e*(Ba -. Pq vertical bar . +.Sq \e*(Ba +.Pq vertical bar . . . -. Ss Whitespace +.Ss Whitespace In non-literal free-form lines, consecutive blocks of whitespace are pruned from input and added later in the output filter, if applicable: -. Bd -literal -offset indent +.Bd -literal -offset indent These spaces are pruned from input. \&.Bd \-literal These are not. \&.Ed -. Ed -. Pp +.Ed +. +.Pp In macro lines, whitespace delimits arguments and is discarded. If arguments are quoted, whitespace within the quotes is retained. -. Pp +. +.Pp Blank lines are only permitted within literal contexts, as are lines containing only whitespace. Tab characters are only acceptable when delimiting -. Sq \&Bl \-column +.Sq \&Bl \-column or when in a literal context. . . -. Ss Quotation +.Ss Quotation Macro arguments may be quoted with a double-quote to group space-delimited terms or to retain blocks of whitespace. A quoted argument begins with a double-quote preceded by whitespace. The next double-quote not pair-wise adjacent to another double-quote terminates the literal, regardless of surrounding whitespace. -. Pp +. +.Pp This produces tokens -. Sq a" , -. Sq b c , -. Sq de , +.Sq a" , +.Sq b c , +.Sq de , and -. Sq fg" . +.Sq fg" . Note that any quoted term, be it argument or macro, is indiscriminately considered literal text. Thus, the following produces -. Sq \&Em a : -. Bd -literal -offset indent +.Sq \&Em a : +.Bd -literal -offset indent \&.Em "Em a" -. Ed -. Pp +.Ed +. +.Pp In free-form mode, quotes are regarded as opaque text. . . .Sh MANUAL STRUCTURE Each -. Nm +.Nm document must begin with a document prologue, containing, in order, -. Sq \&Dd , -. Sq \&Dt , +.Sq \&Dd , +.Sq \&Dt , and -. Sq \&Os , +.Sq \&Os , then the NAME section containing at least one -. Sq \&Nm +.Sq \&Nm followed by -. Sq \&Nd : -. Bd -literal -offset indent +.Sq \&Nd : +.Bd -literal -offset indent \&.Dd $\&Mdocdate$ \&.Dt mdoc 7 \&.Os \&.Sh NAME \&.Nm mdoc \&.Nd mdoc language reference -. Ed -. Pp +.Ed +. +.Pp Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged, but non-compulsory. . @@ -230,397 +237,408 @@ but non-compulsory. .Sh MACRO SYNTAX Macros are one to three three characters in length and begin with a control character , -. Sq \&. , +.Sq \&. , at the beginning of the line. An arbitrary amount of whitespace may sit between the control character and the macro name. Thus, -. Sq \&.Pp +.Sq \&.Pp and -. Sq \&.\ \ \ \&Pp +.Sq \&.\ \ \ \&Pp are equivalent. Macro names are two or three characters in length. -. Pp +. +.Pp The syntax of a macro depends on its classification. In this section, -. Sq \-arg +.Sq \-arg refers to macro arguments, which may be followed by zero or more -. Sq parm +.Sq parm parameters; -. Sq \&Yo +.Sq \&Yo opens the scope of a macro; and if specified, -. Sq \&Yc +.Sq \&Yc closes it out. -. Pp +. +.Pp The -. Em Callable +.Em Callable column indicates that the macro may be called subsequent to the initial line-macro. If a macro is not callable, then its invocation after the initial line macro is interpreted as opaque text, such that -. Sq \&.Fl Sh +.Sq \&.Fl Sh produces -. Sq Fl Sh . -. Pp +.Sq Fl Sh . +. +.Pp The -. Em Parsable +.Em Parsable column indicates whether the macro may be followed by further (ostensibly callable) macros. If a macro is not parsable, subsequent macro invocations on the line will be interpreted as opaque text. -. Pp +. +.Pp The -. Em Scope +.Em Scope column, if applicable, describes closure rules. . . -. Ss Block full-explicit +.Ss Block full-explicit Multi-line scope closed by an explicit closing macro. All macros contains bodies; only -. Pq Sq \&Bf +.Pq Sq \&Bf contains a head. -. Bd -literal -offset indent +.Bd -literal -offset indent \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \(lBbody...\(rB \&.Yc -. Ed -. Pp -. Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX" -. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope -. It \&Bd Ta \&No Ta \&No Ta closed by \&Ed -. It \&Bf Ta \&No Ta \&No Ta closed by \&Ef -. It \&Bk Ta \&No Ta \&No Ta closed by \&Ek -. It \&Bl Ta \&No Ta \&No Ta closed by \&El -. It \&Ed Ta \&No Ta \&No Ta opened by \&Bd -. It \&Ef Ta \&No Ta \&No Ta opened by \&Bf -. It \&Ek Ta \&No Ta \&No Ta opened by \&Bk -. It \&El Ta \&No Ta \&No Ta opened by \&Bl -. El -. -. -. Ss Block full-implicit +.Ed +. +.Pp +.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXX" +.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope +.It \&Bd Ta \&No Ta \&No Ta closed by \&Ed +.It \&Bf Ta \&No Ta \&No Ta closed by \&Ef +.It \&Bk Ta \&No Ta \&No Ta closed by \&Ek +.It \&Bl Ta \&No Ta \&No Ta closed by \&El +.It \&Ed Ta \&No Ta \&No Ta opened by \&Bd +.It \&Ef Ta \&No Ta \&No Ta opened by \&Bf +.It \&Ek Ta \&No Ta \&No Ta opened by \&Bk +.It \&El Ta \&No Ta \&No Ta opened by \&Bl +.El +. +. +.Ss Block full-implicit Multi-line scope closed by end-of-file or implicitly by another macro. All macros have bodies; some -. Po -. Sq \&It \-bullet , -. Sq \-hyphen , -. Sq \-dash , -. Sq \-enum , -. Sq \-item -. Pc +.Po +.Sq \&It \-bullet , +.Sq \-hyphen , +.Sq \-dash , +.Sq \-enum , +.Sq \-item +.Pc don't have heads, while -. Sq \&It \-column +.Sq \&It \-column may have multiple heads. -. Bd -literal -offset indent +.Bd -literal -offset indent \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB \(lBbody...\(rB -. Ed -. Pp -. Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX" -. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope -. It \&It Ta \&No Ta Yes Ta closed by \&It, \&El -. It \&Nd Ta \&No Ta \&No Ta closed by \&Sh -. It \&Sh Ta \&No Ta \&No Ta closed by \&Sh -. It \&Ss Ta \&No Ta \&No Ta closed by \&Sh, \&Ss -. El -. -. -. Ss Block partial-explicit +.Ed +. +.Pp +.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsableX" "closed by XXXXXXXXXXX" +.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope +.It \&It Ta \&No Ta Yes Ta closed by \&It, \&El +.It \&Nd Ta \&No Ta \&No Ta closed by \&Sh +.It \&Sh Ta \&No Ta \&No Ta closed by \&Sh +.It \&Ss Ta \&No Ta \&No Ta closed by \&Sh, \&Ss +.El +. +. +.Ss Block partial-explicit Like block full-explicit, but also with single-line scope. Each has at least a body and, in limited circumstances, a head -. Pq So \&Fo Sc , So \&Eo Sc +.Pq So \&Fo Sc , So \&Eo Sc and/or tail -. Pq So \&Ec Sc . -. Bd -literal -offset indent +.Pq So \&Ec Sc . +.Bd -literal -offset indent \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \(lBbody...\(rB \&.Yc \(lBtail...\(rB \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \ \(lBbody...\(rB \&Yc \(lBtail...\(rB -. Ed -. Pp -. Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent -. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope -. It \&Ac Ta Yes Ta Yes Ta opened by \&Ao -. It \&Ao Ta Yes Ta Yes Ta closed by \&Ac -. It \&Bc Ta Yes Ta Yes Ta closed by \&Bo -. It \&Bo Ta Yes Ta Yes Ta opened by \&Bc -. It \&Brc Ta Yes Ta Yes Ta opened by \&Bro -. It \&Bro Ta Yes Ta Yes Ta closed by \&Brc -. It \&Dc Ta Yes Ta Yes Ta opened by \&Do -. It \&Do Ta Yes Ta Yes Ta closed by \&Dc -. It \&Ec Ta Yes Ta Yes Ta opened by \&Eo -. It \&Eo Ta Yes Ta Yes Ta closed by \&Ec -. It \&Fc Ta Yes Ta Yes Ta opened by \&Fo -. It \&Fo Ta \&No Ta \&No Ta closed by \&Fc -. It \&Oc Ta Yes Ta Yes Ta closed by \&Oo -. It \&Oo Ta Yes Ta Yes Ta opened by \&Oc -. It \&Pc Ta Yes Ta Yes Ta closed by \&Po -. It \&Po Ta Yes Ta Yes Ta opened by \&Pc -. It \&Qc Ta Yes Ta Yes Ta opened by \&Oo -. It \&Qo Ta Yes Ta Yes Ta closed by \&Oc -. It \&Re Ta \&No Ta \&No Ta opened by \&Rs -. It \&Rs Ta \&No Ta \&No Ta closed by \&Re -. It \&Sc Ta Yes Ta Yes Ta opened by \&So -. It \&So Ta Yes Ta Yes Ta closed by \&Sc -. It \&Xc Ta Yes Ta Yes Ta opened by \&Xo -. It \&Xo Ta Yes Ta Yes Ta closed by \&Xc -. El -. -. -. Ss Block partial-implicit +.Ed +. +.Pp +.Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXXX" -compact -offset indent +.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope +.It \&Ac Ta Yes Ta Yes Ta opened by \&Ao +.It \&Ao Ta Yes Ta Yes Ta closed by \&Ac +.It \&Bc Ta Yes Ta Yes Ta closed by \&Bo +.It \&Bo Ta Yes Ta Yes Ta opened by \&Bc +.It \&Brc Ta Yes Ta Yes Ta opened by \&Bro +.It \&Bro Ta Yes Ta Yes Ta closed by \&Brc +.It \&Dc Ta Yes Ta Yes Ta opened by \&Do +.It \&Do Ta Yes Ta Yes Ta closed by \&Dc +.It \&Ec Ta Yes Ta Yes Ta opened by \&Eo +.It \&Eo Ta Yes Ta Yes Ta closed by \&Ec +.It \&Fc Ta Yes Ta Yes Ta opened by \&Fo +.It \&Fo Ta \&No Ta \&No Ta closed by \&Fc +.It \&Oc Ta Yes Ta Yes Ta closed by \&Oo +.It \&Oo Ta Yes Ta Yes Ta opened by \&Oc +.It \&Pc Ta Yes Ta Yes Ta closed by \&Po +.It \&Po Ta Yes Ta Yes Ta opened by \&Pc +.It \&Qc Ta Yes Ta Yes Ta opened by \&Oo +.It \&Qo Ta Yes Ta Yes Ta closed by \&Oc +.It \&Re Ta \&No Ta \&No Ta opened by \&Rs +.It \&Rs Ta \&No Ta \&No Ta closed by \&Re +.It \&Sc Ta Yes Ta Yes Ta opened by \&So +.It \&So Ta Yes Ta Yes Ta closed by \&Sc +.It \&Xc Ta Yes Ta Yes Ta opened by \&Xo +.It \&Xo Ta Yes Ta Yes Ta closed by \&Xc +.El +. +. +.Ss Block partial-implicit Like block full-implicit, but with single-line scope closed by -. Sx Reserved Characters +.Sx Reserved Characters or end of line. -. Bd -literal -offset indent +.Bd -literal -offset indent \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB -. Ed -. Pp -. Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent -. It Em Macro Ta Em Callable Ta Em Parsable -. It \&Aq Ta Yes Ta Yes -. It \&Bq Ta Yes Ta Yes -. It \&Brq Ta Yes Ta Yes -. It \&D1 Ta \&No Ta \&Yes -. It \&Dl Ta \&No Ta Yes -. It \&Dq Ta Yes Ta Yes -. It \&Op Ta Yes Ta Yes -. It \&Pq Ta Yes Ta Yes -. It \&Ql Ta Yes Ta Yes -. It \&Qq Ta Yes Ta Yes -. It \&Sq Ta Yes Ta Yes -. El -. -. -. Ss In-line +.Ed +. +.Pp +.Bl -column "MacroX" "CallableX" "ParsableX" -compact -offset indent +.It Em Macro Ta Em Callable Ta Em Parsable +.It \&Aq Ta Yes Ta Yes +.It \&Bq Ta Yes Ta Yes +.It \&Brq Ta Yes Ta Yes +.It \&D1 Ta \&No Ta \&Yes +.It \&Dl Ta \&No Ta Yes +.It \&Dq Ta Yes Ta Yes +.It \&Op Ta Yes Ta Yes +.It \&Pq Ta Yes Ta Yes +.It \&Ql Ta Yes Ta Yes +.It \&Qq Ta Yes Ta Yes +.It \&Sq Ta Yes Ta Yes +.El +. +. +.Ss In-line Closed by -. Sx Reserved Characters , +.Sx Reserved Characters , end of line, fixed argument lengths, and/or subsequent macros. In-line macros have only text children. If a number (or inequality) of arguments is -. Pq n , +.Pq n , then the macro accepts an arbitrary number of arguments. -. Bd -literal -offset indent +.Bd -literal -offset indent \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc... \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN -. Ed -. Pp -. Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent -. It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments -. It \&%A Ta \&No Ta \&No Ta >0 -. It \&%B Ta \&No Ta \&No Ta >0 -. It \&%C Ta \&No Ta \&No Ta >0 -. It \&%D Ta \&No Ta \&No Ta >0 -. It \&%I Ta \&No Ta \&No Ta >0 -. It \&%J Ta \&No Ta \&No Ta >0 -. It \&%N Ta \&No Ta \&No Ta >0 -. It \&%O Ta \&No Ta \&No Ta >0 -. It \&%P Ta \&No Ta \&No Ta >0 -. It \&%R Ta \&No Ta \&No Ta >0 -. It \&%T Ta \&No Ta \&No Ta >0 -. It \&%V Ta \&No Ta \&No Ta >0 -. It \&Ad Ta Yes Ta Yes Ta n -. It \&An Ta Yes Ta Yes Ta n -. It \&Ap Ta Yes Ta Yes Ta 0 -. It \&Ar Ta Yes Ta Yes Ta n -. It \&At Ta Yes Ta Yes Ta 1 -. It \&Bsx Ta Yes Ta Yes Ta n -. It \&Bt Ta \&No Ta \&No Ta 0 -. It \&Bx Ta Yes Ta Yes Ta n -. It \&Cd Ta Yes Ta Yes Ta >0 -. It \&Cm Ta Yes Ta Yes Ta n -. It \&Db Ta \&No Ta \&No Ta 1 -. It \&Dd Ta \&No Ta \&No Ta >0 -. It \&Dt Ta \&No Ta \&No Ta n -. It \&Dv Ta Yes Ta Yes Ta n -. It \&Dx Ta Yes Ta Yes Ta n -. It \&Em Ta Yes Ta Yes Ta >0 -. It \&En Ta \&No Ta \&No Ta 0 -. It \&Er Ta Yes Ta Yes Ta >0 -. It \&Es Ta \&No Ta \&No Ta 0 -. It \&Ev Ta Yes Ta Yes Ta n -. It \&Ex Ta \&No Ta \&No Ta 0 -. It \&Fa Ta Yes Ta Yes Ta n -. It \&Fd Ta \&No Ta \&No Ta >0 -. It \&Fl Ta Yes Ta Yes Ta n -. It \&Fn Ta Yes Ta Yes Ta >0 -. It \&Fr Ta \&No Ta \&No Ta n -. It \&Ft Ta Yes Ta Yes Ta n -. It \&Fx Ta Yes Ta Yes Ta n -. It \&Hf Ta \&No Ta \&No Ta n -. It \&Ic Ta Yes Ta Yes Ta >0 -. It \&In Ta \&No Ta \&No Ta n -. It \&Lb Ta \&No Ta \&No Ta 1 -. It \&Li Ta Yes Ta Yes Ta n -. It \&Lk Ta Yes Ta Yes Ta n -. It \&Lp Ta \&No Ta \&No Ta 0 -. It \&Ms Ta Yes Ta Yes Ta >0 -. It \&Mt Ta Yes Ta Yes Ta >0 -. It \&Nm Ta Yes Ta Yes Ta n -. It \&No Ta Yes Ta Yes Ta 0 -. It \&Ns Ta Yes Ta Yes Ta 0 -. It \&Nx Ta Yes Ta Yes Ta n -. It \&Os Ta \&No Ta \&No Ta n -. It \&Ot Ta \&No Ta \&No Ta n -. It \&Ox Ta Yes Ta Yes Ta n -. It \&Pa Ta Yes Ta Yes Ta n -. It \&Pf Ta \&No Ta Yes Ta 1 -. It \&Pp Ta \&No Ta \&No Ta 0 -. It \&Rv Ta \&No Ta \&No Ta 0 -. It \&Sm Ta \&No Ta \&No Ta 1 -. It \&St Ta \&No Ta Yes Ta 1 -. It \&Sx Ta Yes Ta Yes Ta >0 -. It \&Sy Ta Yes Ta Yes Ta >0 -. It \&Tn Ta Yes Ta Yes Ta >0 -. It \&Ud Ta \&No Ta \&No Ta 0 -. It \&Ux Ta Yes Ta Yes Ta n -. It \&Va Ta Yes Ta Yes Ta n -. It \&Vt Ta Yes Ta Yes Ta >0 -. It \&Xr Ta Yes Ta Yes Ta >0, <3 -. It \&br Ta \&No Ta \&No Ta 0 -. It \&sp Ta \&No Ta \&No Ta 1 -. El +.Ed +. +.Pp +.Bl -column "MacroX" "CallableX" "ParsableX" "Arguments" -compact -offset indent +.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Arguments +.It \&%A Ta \&No Ta \&No Ta >0 +.It \&%B Ta \&No Ta \&No Ta >0 +.It \&%C Ta \&No Ta \&No Ta >0 +.It \&%D Ta \&No Ta \&No Ta >0 +.It \&%I Ta \&No Ta \&No Ta >0 +.It \&%J Ta \&No Ta \&No Ta >0 +.It \&%N Ta \&No Ta \&No Ta >0 +.It \&%O Ta \&No Ta \&No Ta >0 +.It \&%P Ta \&No Ta \&No Ta >0 +.It \&%R Ta \&No Ta \&No Ta >0 +.It \&%T Ta \&No Ta \&No Ta >0 +.It \&%V Ta \&No Ta \&No Ta >0 +.It \&Ad Ta Yes Ta Yes Ta n +.It \&An Ta Yes Ta Yes Ta n +.It \&Ap Ta Yes Ta Yes Ta 0 +.It \&Ar Ta Yes Ta Yes Ta n +.It \&At Ta Yes Ta Yes Ta 1 +.It \&Bsx Ta Yes Ta Yes Ta n +.It \&Bt Ta \&No Ta \&No Ta 0 +.It \&Bx Ta Yes Ta Yes Ta n +.It \&Cd Ta Yes Ta Yes Ta >0 +.It \&Cm Ta Yes Ta Yes Ta n +.It \&Db Ta \&No Ta \&No Ta 1 +.It \&Dd Ta \&No Ta \&No Ta >0 +.It \&Dt Ta \&No Ta \&No Ta n +.It \&Dv Ta Yes Ta Yes Ta n +.It \&Dx Ta Yes Ta Yes Ta n +.It \&Em Ta Yes Ta Yes Ta >0 +.It \&En Ta \&No Ta \&No Ta 0 +.It \&Er Ta Yes Ta Yes Ta >0 +.It \&Es Ta \&No Ta \&No Ta 0 +.It \&Ev Ta Yes Ta Yes Ta n +.It \&Ex Ta \&No Ta \&No Ta 0 +.It \&Fa Ta Yes Ta Yes Ta n +.It \&Fd Ta \&No Ta \&No Ta >0 +.It \&Fl Ta Yes Ta Yes Ta n +.It \&Fn Ta Yes Ta Yes Ta >0 +.It \&Fr Ta \&No Ta \&No Ta n +.It \&Ft Ta Yes Ta Yes Ta n +.It \&Fx Ta Yes Ta Yes Ta n +.It \&Hf Ta \&No Ta \&No Ta n +.It \&Ic Ta Yes Ta Yes Ta >0 +.It \&In Ta \&No Ta \&No Ta n +.It \&Lb Ta \&No Ta \&No Ta 1 +.It \&Li Ta Yes Ta Yes Ta n +.It \&Lk Ta Yes Ta Yes Ta n +.It \&Lp Ta \&No Ta \&No Ta 0 +.It \&Ms Ta Yes Ta Yes Ta >0 +.It \&Mt Ta Yes Ta Yes Ta >0 +.It \&Nm Ta Yes Ta Yes Ta n +.It \&No Ta Yes Ta Yes Ta 0 +.It \&Ns Ta Yes Ta Yes Ta 0 +.It \&Nx Ta Yes Ta Yes Ta n +.It \&Os Ta \&No Ta \&No Ta n +.It \&Ot Ta \&No Ta \&No Ta n +.It \&Ox Ta Yes Ta Yes Ta n +.It \&Pa Ta Yes Ta Yes Ta n +.It \&Pf Ta \&No Ta Yes Ta 1 +.It \&Pp Ta \&No Ta \&No Ta 0 +.It \&Rv Ta \&No Ta \&No Ta 0 +.It \&Sm Ta \&No Ta \&No Ta 1 +.It \&St Ta \&No Ta Yes Ta 1 +.It \&Sx Ta Yes Ta Yes Ta >0 +.It \&Sy Ta Yes Ta Yes Ta >0 +.It \&Tn Ta Yes Ta Yes Ta >0 +.It \&Ud Ta \&No Ta \&No Ta 0 +.It \&Ux Ta Yes Ta Yes Ta n +.It \&Va Ta Yes Ta Yes Ta n +.It \&Vt Ta Yes Ta Yes Ta >0 +.It \&Xr Ta Yes Ta Yes Ta >0, <3 +.It \&br Ta \&No Ta \&No Ta 0 +.It \&sp Ta \&No Ta \&No Ta 1 +.El . . .Sh COMPATIBILITY This section documents compatibility with other roff implementations, at this time limited to -. Xr groff 1 . +.Xr groff 1 . The term -. Qq historic groff +.Qq historic groff refers to those versions before the -. Pa doc.tmac +.Pa doc.tmac file re-write -. Pq somewhere between 1.15 and 1.19 . -. Pp -. Bl -dash -compact -. It +.Pq somewhere between 1.15 and 1.19 . +. +.Pp +.Bl -dash -compact +.It The -. Sq \-split +.Sq \-split or -. Sq \-nosplit +.Sq \-nosplit argument to -. Sq \&An +.Sq \&An applies to the whole document, not just to the current section as it does in groff. -. It +.It In quoted literals, groff allowed pair-wise double-quotes to produce a standalone double-quote in formatted output. This idiosyncratic behaviour is no longer applicable. -. It +.It The -. Sq \&sp +.Sq \&sp macro does not accept negative numbers. -. It +.It Blocks of whitespace are stripped from both macro and free-form text lines (except when in literal mode), while groff would retain whitespace in free-form text lines. -. It +.It Historic groff has many un-callable macros. Most of these (excluding some block-level macros) are now callable, conforming to the non-historic groff version. -. It +.It The vertical bar -. Sq \(ba +.Sq \(ba made historic groff -. Qq go orbital +.Qq go orbital but is a proper delimiter in this implementation. -. It -. Sq \&It \-nested +.It +.Sq \&It \-nested is assumed for all lists (it wasn't in historic groff): any list may be nested and -. Sq \-enum +.Sq \-enum lists will restart the sequence only for the sub-list. -. It -. Sq \&It \-column +.It +.Sq \&It \-column syntax where column widths may be preceded by other arguments (instead of proceeded) is not supported. -. It +.It The -. Sq \&At +.Sq \&At macro only accepts a single parameter. -. It +.It Some manuals use -. Sq \&Li +.Sq \&Li incorrectly by following it with a reserved character and expecting the delimiter to render. This is not supported. -. It +.It In groff, the -. Sq \&Fo +.Sq \&Fo macro only produces the first parameter. This is no longer the case. -. El +.El . . .Sh SEE ALSO -. Xr mandoc 1 , -. Xr mandoc_char 7 +.Xr mandoc 1 , +.Xr mandoc_char 7 . . .Sh AUTHORS The -. Nm +.Nm reference was written by -. An Kristaps Dzonsons Aq kristaps@kth.se . +.An Kristaps Dzonsons Aq kristaps@kth.se . . . .Sh CAVEATS There are many ambiguous parts of mdoc. -. Pp -. Bl -dash -compact -. It -. Sq \&Fa +. +.Pp +.Bl -dash -compact +.It +.Sq \&Fa should be -. Sq \&Va +.Sq \&Va as function arguments are variables. -. It -. Sq \&Ft +.It +.Sq \&Ft should be -. Sq \&Vt +.Sq \&Vt as function return types are still types. Furthermore, the -. Sq \&Ft +.Sq \&Ft should be removed and -. Sq \&Fo , +.Sq \&Fo , which ostensibly follows it, should follow the same convention as -. Sq \&Va . -. It -. Sq \&Va +.Sq \&Va . +.It +.Sq \&Va should formalise that only one or two arguments are acceptable: a variable name and optional, preceding type. -. It -. Sq \&Fd +.It +.Sq \&Fd is ambiguous. It's commonly used to indicate an include file in the synopsis section. -. Sq \&In +.Sq \&In should be used, instead. -. It +.It Only the -. Sq \-literal +.Sq \-literal argument to -. Sq \&Bd +.Sq \&Bd makes sense. The remaining ones should be removed. -. It +.It The -. Sq \&Xo +.Sq \&Xo and -. Sq \&Xc +.Sq \&Xc macros should be deprecated. -. It +.It The -. Sq \&Dt +.Sq \&Dt macro lacks clarity. It should be absolutely clear which title will render when formatting the manual page. -. It +.It A -. Sq \&Lx +.Sq \&Lx should be provided for Linux (\(`a la -. Sq \&Ox , -. Sq \&Nx +.Sq \&Ox , +.Sq \&Nx etc.). -. It +.It There's no way to refer to references in -. Sq \&Rs/Re +.Sq \&Rs/Re blocks. -. It +.It The \-split and \-nosplit dictates via -. Sq \&An +.Sq \&An are re-set when entering and leaving the AUTHORS section. -. El +.El . |