[BACK]Return to man.7 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/man.7, Revision 1.34

1.34    ! kristaps    1: .\"    $Id: man.7,v 1.33 2009/08/20 13:32:09 kristaps Exp $
1.1       kristaps    2: .\"
1.11      kristaps    3: .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1       kristaps    4: .\"
                      5: .\" Permission to use, copy, modify, and distribute this software for any
1.10      kristaps    6: .\" purpose with or without fee is hereby granted, provided that the above
                      7: .\" copyright notice and this permission notice appear in all copies.
                      8: .\"
                      9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   16: .\"
                     17: .Dd $Mdocdate$
1.9       kristaps   18: .Dt MAN 7
1.1       kristaps   19: .Os
1.28      kristaps   20: .
                     21: .
1.1       kristaps   22: .Sh NAME
1.32      kristaps   23: .Nm man
                     24: .Nd man language reference
1.28      kristaps   25: .
                     26: .
1.1       kristaps   27: .Sh DESCRIPTION
                     28: The
1.32      kristaps   29: .Nm man
1.20      kristaps   30: language was historically used to format
1.32      kristaps   31: .Ux
1.19      kristaps   32: manuals.  This reference document describes its syntax, structure, and
                     33: usage.
1.32      kristaps   34: .
                     35: .Pp
                     36: .Bf -emphasis
1.20      kristaps   37: Do not use
1.32      kristaps   38: .Nm
1.20      kristaps   39: to write your manuals.
1.32      kristaps   40: .Ef
1.19      kristaps   41: Use the
1.32      kristaps   42: .Xr mdoc 7
1.1       kristaps   43: language, instead.
1.32      kristaps   44: .
                     45: .Pp
1.1       kristaps   46: An
1.32      kristaps   47: .Nm
1.1       kristaps   48: document follows simple rules:  lines beginning with the control
1.20      kristaps   49: character
1.32      kristaps   50: .Sq \&.
1.1       kristaps   51: are parsed for macros.  Other lines are interpreted within the scope of
                     52: prior macros:
1.32      kristaps   53: .Bd -literal -offset indent
1.1       kristaps   54: \&.SH Macro lines change control state.
                     55: Other lines are interpreted within the current state.
1.32      kristaps   56: .Ed
1.28      kristaps   57: .
                     58: .
1.1       kristaps   59: .Sh INPUT ENCODING
1.32      kristaps   60: .Nm
1.14      kristaps   61: documents may contain only graphable 7-bit ASCII characters, the
1.19      kristaps   62: space character, and the tabs character.  All manuals must have
1.32      kristaps   63: .Ux
1.20      kristaps   64: line termination.
1.32      kristaps   65: .
                     66: .Pp
1.5       kristaps   67: Blank lines are acceptable; where found, the output will assert a
1.1       kristaps   68: vertical space.
1.32      kristaps   69: .
                     70: .Pp
1.4       kristaps   71: The
1.32      kristaps   72: .Sq \ec
1.4       kristaps   73: escape is common in historical
1.32      kristaps   74: .Nm
1.4       kristaps   75: documents; if encountered at the end of a word, it ensures that the
                     76: subsequent word isn't off-set by whitespace.
1.28      kristaps   77: .
                     78: .
1.32      kristaps   79: .Ss Comments
1.21      kristaps   80: Text following a
1.32      kristaps   81: .Sq \e\*" ,
1.21      kristaps   82: whether in a macro or free-form text line, is ignored to the end of
                     83: line.  A macro line with only a control character and comment escape,
1.32      kristaps   84: .Sq \&.\e" ,
1.22      kristaps   85: is also ignored.  Macro lines with only a control charater and
                     86: optionally whitespace are stripped from input.
1.28      kristaps   87: .
                     88: .
1.32      kristaps   89: .Ss Special Characters
1.21      kristaps   90: Special characters may occur in both macro and free-form lines.
                     91: Sequences begin with the escape character
1.32      kristaps   92: .Sq \e
1.20      kristaps   93: followed by either an open-parenthesis
1.32      kristaps   94: .Sq \&(
1.1       kristaps   95: for two-character sequences; an open-bracket
1.32      kristaps   96: .Sq \&[
1.1       kristaps   97: for n-character sequences (terminated at a close-bracket
1.32      kristaps   98: .Sq \&] ) ;
1.21      kristaps   99: or a single one-character sequence.  See
1.32      kristaps  100: .Xr mandoc_char 7
1.21      kristaps  101: for a complete list.  Examples include
1.32      kristaps  102: .Sq \e(em
                    103: .Pq em-dash
1.21      kristaps  104: and
1.32      kristaps  105: .Sq \ee
                    106: .Pq back-slash .
1.28      kristaps  107: .
                    108: .
1.32      kristaps  109: .Ss Text Decoration
1.21      kristaps  110: Terms may be text-decorated using the
1.32      kristaps  111: .Sq \ef
1.21      kristaps  112: escape followed by an indicator: B (bold), I, (italic), or P and R
                    113: (Roman, or reset).
1.28      kristaps  114: .
                    115: .
1.32      kristaps  116: .Ss Whitespace
1.17      kristaps  117: Unless specifically escaped, consecutive blocks of whitespace are pruned
                    118: from input.  These are later re-added, if applicable, by a front-end
                    119: utility such as
1.32      kristaps  120: .Xr mandoc 1 .
1.28      kristaps  121: .
                    122: .
1.22      kristaps  123: .Sh MANUAL STRUCTURE
1.16      kristaps  124: Each
1.32      kristaps  125: .Nm
1.16      kristaps  126: document must contain contains at least the
1.32      kristaps  127: .Sq TH
1.16      kristaps  128: macro describing the document's section and title.  It may occur
                    129: anywhere in the document, although conventionally, it appears as the
                    130: first macro.
1.32      kristaps  131: .
                    132: .Pp
1.22      kristaps  133: Beyond
1.32      kristaps  134: .Sq TH ,
1.22      kristaps  135: at least one macro or text node must appear in the document.  Documents
                    136: are generally structured as follows:
1.32      kristaps  137: .Bd -literal -offset indent
1.22      kristaps  138: \&.TH FOO 1 "13 Aug 2009"
                    139: \&.
                    140: \&.SH NAME
1.29      kristaps  141: \efBfoo\efR \e(en a description goes here
1.33      kristaps  142: \&.\e\*q The next is for sections 2 & 3 only.
                    143: \&.\e\*q .SH LIBRARY
1.22      kristaps  144: \&.
                    145: \&.SH SYNOPSIS
                    146: \efBfoo\efR [\efB\e-options\efR] arguments...
                    147: \&.
                    148: \&.SH DESCRIPTION
1.33      kristaps  149: The \efBfoo\efR utility processes files...
1.22      kristaps  150: \&.
1.33      kristaps  151: \&.\e\*q .SH IMPLEMENTATION NOTES
                    152: \&.\e\*q The next is for sections 1 & 8 only.
                    153: \&.\e\*q .SH EXIT STATUS
                    154: \&.\e\*q The next is for sections 2, 3, & 9 only.
1.22      kristaps  155: \&.\e\*q .SH RETURN VALUES
1.33      kristaps  156: \&.\e\*q The next is for sections 1, 6, 7, & 8 only.
1.22      kristaps  157: \&.\e\*q .SH ENVIRONMENT
                    158: \&.\e\*q .SH FILES
                    159: \&.\e\*q .SH EXAMPLES
1.33      kristaps  160: \&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
1.22      kristaps  161: \&.\e\*q .SH DIAGNOSTICS
1.33      kristaps  162: \&.\e\*q The next is for sections 2, 3, & 9 only.
1.22      kristaps  163: \&.\e\*q .SH ERRORS
                    164: \&.\e\*q .SH SEE ALSO
                    165: \&.\e\*q \efBbar\efR(1)
                    166: \&.\e\*q .SH STANDARDS
                    167: \&.\e\*q .SH HISTORY
                    168: \&.\e\*q .SH AUTHORS
                    169: \&.\e\*q .SH CAVEATS
                    170: \&.\e\*q .SH BUGS
1.33      kristaps  171: \&.\e\*q .SH SECURITY CONSIDERATIONS
1.32      kristaps  172: .Ed
1.28      kristaps  173: .
                    174: .
1.22      kristaps  175: .Sh MACRO SYNTAX
1.2       kristaps  176: Macros are one to three three characters in length and begin with a
1.4       kristaps  177: control character ,
1.32      kristaps  178: .Sq \&. ,
1.2       kristaps  179: at the beginning of the line.  An arbitrary amount of whitespace may
                    180: sit between the control character and the macro name.  Thus,
1.32      kristaps  181: .Sq .PP
1.2       kristaps  182: and
1.32      kristaps  183: .Sq \&.\ \ \ PP
1.2       kristaps  184: are equivalent.
1.32      kristaps  185: .
                    186: .Pp
1.1       kristaps  187: The
1.32      kristaps  188: .Nm
1.30      kristaps  189: macros are classified by scope: line scope or block scope.  Line
1.22      kristaps  190: macros are only scoped to the current line (and, in some situations,
                    191: the subsequent line).  Block macros are scoped to the current line and
                    192: subsequent lines until closed by another block macro.
1.28      kristaps  193: .
                    194: .
1.32      kristaps  195: .Ss Line Macros
1.30      kristaps  196: Line macros are generally scoped to the current line, with the body
                    197: consisting of zero or more arguments.  If a macro is scoped to the next
                    198: line and the line arguments are empty, the next line is used instead,
                    199: else the general syntax is used.  Thus:
1.32      kristaps  200: .Bd -literal -offset indent
1.30      kristaps  201: \&.I
1.4       kristaps  202: foo
1.32      kristaps  203: .Ed
                    204: .
                    205: .Pp
1.20      kristaps  206: is equivalent to
1.32      kristaps  207: .Sq \&.I foo .
1.22      kristaps  208: .\" PARAGRAPH
1.30      kristaps  209: Consecutive next-line scope invocations are disallowed.
1.32      kristaps  210: .Bd -literal -offset indent
1.22      kristaps  211: \&.YO \(lBbody...\(rB
                    212: \(lBbody...\(rB
1.32      kristaps  213: .Ed
                    214: .
                    215: .Pp
1.30      kristaps  216: It is considered an error when next-line scope is open at the end of
                    217: file.
1.32      kristaps  218: .
                    219: .Pp
                    220: .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"
                    221: .It Em Macro Ta Em Arguments Ta Em Scope
                    222: .It    B     Ta    n         Ta    next-line
                    223: .It    BI    Ta    n         Ta    current
                    224: .It    BR    Ta    n         Ta    current
                    225: .It    DT    Ta    0         Ta    current
                    226: .It    I     Ta    n         Ta    next-line
                    227: .It    IB    Ta    n         Ta    current
                    228: .It    IR    Ta    n         Ta    current
                    229: .It    R     Ta    n         Ta    next-line
                    230: .It    RB    Ta    n         Ta    current
                    231: .It    RI    Ta    n         Ta    current
                    232: .It    SB    Ta    n         Ta    next-line
                    233: .It    SM    Ta    n         Ta    next-line
                    234: .It    TH    Ta    >1, <6    Ta    current
                    235: .It    br    Ta    0         Ta    current
                    236: .It    fi    Ta    0         Ta    current
                    237: .It    i     Ta    n         Ta    current
                    238: .It    na    Ta    0         Ta    current
                    239: .It    nf    Ta    0         Ta    current
                    240: .It    r     Ta    0         Ta    current
                    241: .It    sp    Ta    1         Ta    current
                    242: .El
                    243: .
                    244: .Pp
1.31      kristaps  245: The
1.32      kristaps  246: .Sq RS ,
                    247: .Sq RE ,
                    248: .Sq br ,
                    249: .Sq fi ,
                    250: .Sq i ,
                    251: .Sq na ,
                    252: .Sq nf ,
                    253: .Sq r ,
1.22      kristaps  254: and
1.32      kristaps  255: .Sq sp
1.22      kristaps  256: macros aren't historically part of
1.32      kristaps  257: .Nm
1.22      kristaps  258: and should not be used.  They're included for compatibility.
1.28      kristaps  259: .
                    260: .
1.32      kristaps  261: .Ss Block Macros
1.30      kristaps  262: Block macros are comprised of a head and body.  Like for in-line macros,
                    263: the head is scoped to the current line and, in one circumstance, the
                    264: next line; the body is scoped to subsequent lines and is closed out by a
                    265: subsequent block macro invocation.
1.32      kristaps  266: .Bd -literal -offset indent
1.22      kristaps  267: \&.YO \(lBhead...\(rB
                    268: \(lBhead...\(rB
                    269: \(lBbody...\(rB
1.32      kristaps  270: .Ed
                    271: .
                    272: .Pp
1.30      kristaps  273: The closure of body scope may be to the section, where a macro is closed
                    274: by
1.32      kristaps  275: .Sq SH ;
1.30      kristaps  276: sub-section, closed by a section or
1.32      kristaps  277: .Sq SS ;
1.30      kristaps  278: part, closed by a section, sub-section, or
1.32      kristaps  279: .Sq RE ;
1.30      kristaps  280: or paragraph, closed by a section, sub-section, part,
1.32      kristaps  281: .Sq HP ,
                    282: .Sq IP ,
                    283: .Sq LP ,
                    284: .Sq P ,
                    285: .Sq PP ,
1.30      kristaps  286: or
1.32      kristaps  287: .Sq TP .
1.30      kristaps  288: No closure refers to an explicit block closing macro.
1.32      kristaps  289: .
                    290: .Pp
1.30      kristaps  291: It is considered an error when part or next-line scope is open at the
                    292: end of file.
1.32      kristaps  293: .
                    294: .Pp
                    295: .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent
                    296: .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope
                    297: .It   HP     Ta    <2        Ta    current    Ta    paragraph
                    298: .It   IP     Ta    <3        Ta    current    Ta    paragraph
                    299: .It   LP     Ta    0         Ta    current    Ta    paragraph
                    300: .It   P      Ta    0         Ta    current    Ta    paragraph
                    301: .It   PP     Ta    0         Ta    current    Ta    paragraph
                    302: .It   RE     Ta    0         Ta    current    Ta    none
                    303: .It   RS     Ta    1         Ta    current    Ta    part
1.34    ! kristaps  304: .It   SH     Ta    >0        Ta    next-line  Ta    section
        !           305: .It   SS     Ta    >0        Ta    next-line  Ta    sub-section
1.32      kristaps  306: .It   TP     Ta    n         Ta    next-line  Ta    paragraph
                    307: .El
                    308: .
                    309: .Pp
1.22      kristaps  310: If a block macro is next-line scoped, it may only be followed by in-line
                    311: macros (excluding
1.32      kristaps  312: .Sq DT ,
                    313: .Sq TH ,
                    314: .Sq br ,
                    315: .Sq na ,
                    316: .Sq sp ,
                    317: .Sq nf ,
1.22      kristaps  318: and
1.32      kristaps  319: .Sq fi ) .
1.28      kristaps  320: .
                    321: .
1.22      kristaps  322: .Sh REFERENCE
                    323: This section is a canonical reference to all macros, arranged
                    324: alphabetically.  For the scoping of individual macros, see
1.32      kristaps  325: .Sx MACRO SYNTAX .
1.28      kristaps  326: .
                    327: .
1.32      kristaps  328: .Ss Definitions
1.26      kristaps  329: In this reference, a numerical width may be either a standalone natural
                    330: number (such as 3, 4, 10, etc.) or a natural number followed by a width
                    331: multiplier
1.32      kristaps  332: .Qq n ,
1.26      kristaps  333: corresponding to the width of the formatted letter n, or
1.32      kristaps  334: .Qq m ,
1.26      kristaps  335: corresponding to the width of the formatted letter m.  The latter is the
1.27      kristaps  336: default, if unspecified.  Thus,
1.32      kristaps  337: .Bd -literal -offset indent
1.27      kristaps  338: \&.HP 12n
1.32      kristaps  339: .Ed
                    340: .
                    341: .Pp
1.27      kristaps  342: indicates an offset of 12
1.32      kristaps  343: .Qq n
                    344: .Ns -sized
1.27      kristaps  345: letters.
1.28      kristaps  346: .
                    347: .
1.32      kristaps  348: .Ss Macro Reference
                    349: .Bl -tag -width Ds
                    350: .It B
1.22      kristaps  351: Text is rendered in bold face.
1.32      kristaps  352: .It BI
1.22      kristaps  353: Text is rendered alternately in bold face and italic.  Thus,
1.32      kristaps  354: .Sq .BI this word and that
1.22      kristaps  355: causes
1.32      kristaps  356: .Sq this
1.22      kristaps  357: and
1.32      kristaps  358: .Sq and
1.22      kristaps  359: to render in bold face, while
1.32      kristaps  360: .Sq word
1.22      kristaps  361: and
1.32      kristaps  362: .Sq that
1.22      kristaps  363: render in italics.  Whitespace between arguments is omitted in output.
1.32      kristaps  364: .It BR
1.22      kristaps  365: Text is rendered alternately in bold face and roman (the default font).
                    366: Whitespace between arguments is omitted in output.
1.32      kristaps  367: .It DT
1.31      kristaps  368: Re-set the tab spacing to 0.5 inches.
1.32      kristaps  369: .It HP
1.23      kristaps  370: Begin a paragraph whose initial output line is left-justified, but
1.27      kristaps  371: subsequent output lines are indented, with the following syntax:
1.32      kristaps  372: .Bd -literal -offset indent
1.27      kristaps  373: \&.HP [width]
1.32      kristaps  374: .Ed
                    375: .
                    376: .Pp
1.27      kristaps  377: If
1.32      kristaps  378: .Va width
1.27      kristaps  379: is specified, it's saved for later paragraph left-margins; if
                    380: unspecified, the saved or default width is used.
1.32      kristaps  381: .It I
1.22      kristaps  382: Text is rendered in italics.
1.32      kristaps  383: .It IB
1.22      kristaps  384: Text is rendered alternately in italics and bold face.  Whitespace
                    385: between arguments is omitted in output.
1.32      kristaps  386: .It IP
1.25      kristaps  387: Begin a paragraph with the following syntax:
1.32      kristaps  388: .Bd -literal -offset indent
1.25      kristaps  389: \&.IP [head [width]]
1.32      kristaps  390: .Ed
                    391: .
                    392: .Pp
1.25      kristaps  393: This follows the behaviour of the
1.32      kristaps  394: .Sq TP
1.26      kristaps  395: except for the macro syntax (all arguments on the line, instead of
1.27      kristaps  396: having next-line scope).  If
1.32      kristaps  397: .Va width
1.27      kristaps  398: is specified, it's saved for later paragraph left-margins; if
                    399: unspecified, the saved or default width is used.
1.32      kristaps  400: .It IR
1.22      kristaps  401: Text is rendered alternately in italics and roman (the default font).
                    402: Whitespace between arguments is omitted in output.
1.32      kristaps  403: .It LP, P, PP
1.22      kristaps  404: Begin an undecorated paragraph.  The scope of a paragraph is closed by a
1.27      kristaps  405: subsequent paragraph, sub-section, section, or end of file.  The saved
                    406: paragraph left-margin width is re-set to the default.
1.32      kristaps  407: .It R
1.22      kristaps  408: Text is rendered in roman (the default font).
1.32      kristaps  409: .It RB
1.22      kristaps  410: Text is rendered alternately in roman (the default font) and bold face.
                    411: Whitespace between arguments is omitted in output.
1.32      kristaps  412: .It RE
1.30      kristaps  413: Explicitly close out the scope of a prior
1.32      kristaps  414: .Sq RS .
                    415: .It RI
1.22      kristaps  416: Text is rendered alternately in roman (the default font) and italics.
                    417: Whitespace between arguments is omitted in output.
1.32      kristaps  418: .It RS
1.30      kristaps  419: Begin a part setting the left margin.  The left margin controls the
                    420: offset, following an initial indentation, to un-indented text such as
                    421: that of
1.32      kristaps  422: .Sq PP .
1.30      kristaps  423: The width may be specified as following:
1.32      kristaps  424: .Bd -literal -offset indent
1.30      kristaps  425: \&.RS [width]
1.32      kristaps  426: .Ed
                    427: .
                    428: .Pp
1.30      kristaps  429: If
1.32      kristaps  430: .Va width
1.30      kristaps  431: is not specified, the saved or default width is used.
1.32      kristaps  432: .It SB
1.22      kristaps  433: Text is rendered in small size (one point smaller than the default font)
                    434: bold face.
1.32      kristaps  435: .It SH
1.22      kristaps  436: Begin a section.  The scope of a section is only closed by another
1.27      kristaps  437: section or the end of file.  The paragraph left-margin width is re-set
                    438: to the default.
1.32      kristaps  439: .It SM
1.22      kristaps  440: Text is rendered in small size (one point smaller than the default
                    441: font).
1.32      kristaps  442: .It SS
1.22      kristaps  443: Begin a sub-section.  The scope of a sub-section is closed by a
1.27      kristaps  444: subsequent sub-section, section, or end of file.  The paragraph
                    445: left-margin width is re-set to the default.
1.32      kristaps  446: .It TH
1.22      kristaps  447: Sets the title of the manual page with the following syntax:
1.32      kristaps  448: .Bd -literal -offset indent
1.30      kristaps  449: \&.TH title section [date [source [volume]]]
1.32      kristaps  450: .Ed
                    451: .
                    452: .Pp
1.22      kristaps  453: At least the
1.32      kristaps  454: .Va title
1.22      kristaps  455: and
1.32      kristaps  456: .Va section
1.22      kristaps  457: arguments must be provided.  The
1.32      kristaps  458: .Va date
1.22      kristaps  459: argument should be formatted as
1.32      kristaps  460: .Qq %b [%d] %Y
1.22      kristaps  461: format, described in
1.32      kristaps  462: .Xr strptime 3 .
1.22      kristaps  463: The
1.32      kristaps  464: .Va source
1.22      kristaps  465: string specifies the organisation providing the utility.  The
1.32      kristaps  466: .Va volume
1.22      kristaps  467: replaces the default rendered volume as dictated by the manual section.
1.32      kristaps  468: .It TP
1.25      kristaps  469: Begin a paragraph where the head, if exceeding the indentation width, is
1.24      kristaps  470: followed by a newline; if not, the body follows on the same line after a
1.25      kristaps  471: buffer to the indentation width.  Subsequent output lines are indented.
1.32      kristaps  472: .
                    473: .Pp
1.26      kristaps  474: The indentation width may be set as follows:
1.32      kristaps  475: .Bd -literal -offset indent
1.26      kristaps  476: \&.TP [width]
1.32      kristaps  477: .Ed
                    478: .
                    479: .Pp
1.26      kristaps  480: Where
1.32      kristaps  481: .Va width
1.27      kristaps  482: must be a properly-formed numeric width.  If
1.32      kristaps  483: .Va width
1.27      kristaps  484: is specified, it's saved for later paragraph left-margins; if
                    485: unspecified, the saved or default width is used.
1.32      kristaps  486: .It br
1.22      kristaps  487: Breaks the current line.  Consecutive invocations have no further effect.
1.32      kristaps  488: .It fi
1.22      kristaps  489: End literal mode begun by
1.32      kristaps  490: .Sq nf .
                    491: .It i
1.22      kristaps  492: Italicise arguments.  If no arguments are specified, all subsequent text
                    493: is italicised.
1.32      kristaps  494: .It na
1.31      kristaps  495: Don't alignment the right margin.
1.32      kristaps  496: .It nf
1.22      kristaps  497: Begin literal mode: all subsequent free-form lines have their end of
                    498: line boundaries preserved.  May be ended by
1.32      kristaps  499: .Sq fi .
                    500: .It r
1.22      kristaps  501: Fonts and styles (bold face, italics) reset to roman (default font).
1.32      kristaps  502: .It sp
1.22      kristaps  503: Insert n spaces, where n is the macro's positive numeric argument.  If
                    504: 0, this is equivalent to the
1.32      kristaps  505: .Sq br
1.22      kristaps  506: macro.
1.32      kristaps  507: .El
1.28      kristaps  508: .
                    509: .
1.18      kristaps  510: .Sh COMPATIBILITY
1.23      kristaps  511: This section documents compatibility with other roff implementations, at
                    512: this time limited to
1.32      kristaps  513: .Xr groff 1 .
                    514: .Bl -hyphen
                    515: .It
1.23      kristaps  516: In quoted literals, groff allowed pair-wise double-quotes to produce a
                    517: standalone double-quote in formatted output.  This idiosyncratic
                    518: behaviour is no longer applicable.
1.32      kristaps  519: .It
1.23      kristaps  520: The
1.32      kristaps  521: .Sq sp
1.23      kristaps  522: macro does not accept negative numbers.
1.32      kristaps  523: .It
1.23      kristaps  524: Blocks of whitespace are stripped from both macro and free-form text
                    525: lines (except when in literal mode), while groff would retain whitespace
                    526: in free-form text lines.
1.32      kristaps  527: .El
1.28      kristaps  528: .
                    529: .
1.1       kristaps  530: .Sh SEE ALSO
1.32      kristaps  531: .Xr mandoc 1 ,
                    532: .Xr mandoc_char 7
1.28      kristaps  533: .
                    534: .
1.1       kristaps  535: .Sh AUTHORS
                    536: The
1.32      kristaps  537: .Nm
1.23      kristaps  538: reference was written by
1.32      kristaps  539: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.28      kristaps  540: .
                    541: .
1.1       kristaps  542: .Sh CAVEATS
                    543: Do not use this language.  Use
1.32      kristaps  544: .Xr mdoc 7 ,
1.1       kristaps  545: instead.
1.28      kristaps  546: .

CVSweb