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

Annotation of mandoc/man.7, Revision 1.32

1.32    ! kristaps    1: .\"    $Id: man.7,v 1.31 2009/08/20 11:51:07 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.22      kristaps  142: \&.
                    143: \&.SH SYNOPSIS
                    144: \efBfoo\efR [\efB\e-options\efR] arguments...
                    145: \&.
                    146: \&.SH DESCRIPTION
                    147: The \efBfoo\efR utility does...
                    148: \&.
                    149: \&.\e\*q .SH RETURN VALUES
                    150: \&.\e\*q .SH ENVIRONMENT
                    151: \&.\e\*q .SH FILES
                    152: \&.\e\*q .SH EXAMPLES
                    153: \&.\e\*q .SH DIAGNOSTICS
                    154: \&.\e\*q .SH ERRORS
                    155: \&.\e\*q .SH SEE ALSO
                    156: \&.\e\*q \efBbar\efR(1)
                    157: \&.\e\*q .SH STANDARDS
                    158: \&.\e\*q .SH HISTORY
                    159: \&.\e\*q .SH AUTHORS
                    160: \&.\e\*q .SH CAVEATS
                    161: \&.\e\*q .SH BUGS
1.32    ! kristaps  162: .Ed
1.28      kristaps  163: .
                    164: .
1.22      kristaps  165: .Sh MACRO SYNTAX
1.2       kristaps  166: Macros are one to three three characters in length and begin with a
1.4       kristaps  167: control character ,
1.32    ! kristaps  168: .Sq \&. ,
1.2       kristaps  169: at the beginning of the line.  An arbitrary amount of whitespace may
                    170: sit between the control character and the macro name.  Thus,
1.32    ! kristaps  171: .Sq .PP
1.2       kristaps  172: and
1.32    ! kristaps  173: .Sq \&.\ \ \ PP
1.2       kristaps  174: are equivalent.
1.32    ! kristaps  175: .
        !           176: .Pp
1.1       kristaps  177: The
1.32    ! kristaps  178: .Nm
1.30      kristaps  179: macros are classified by scope: line scope or block scope.  Line
1.22      kristaps  180: macros are only scoped to the current line (and, in some situations,
                    181: the subsequent line).  Block macros are scoped to the current line and
                    182: subsequent lines until closed by another block macro.
1.28      kristaps  183: .
                    184: .
1.32    ! kristaps  185: .Ss Line Macros
1.30      kristaps  186: Line macros are generally scoped to the current line, with the body
                    187: consisting of zero or more arguments.  If a macro is scoped to the next
                    188: line and the line arguments are empty, the next line is used instead,
                    189: else the general syntax is used.  Thus:
1.32    ! kristaps  190: .Bd -literal -offset indent
1.30      kristaps  191: \&.I
1.4       kristaps  192: foo
1.32    ! kristaps  193: .Ed
        !           194: .
        !           195: .Pp
1.20      kristaps  196: is equivalent to
1.32    ! kristaps  197: .Sq \&.I foo .
1.22      kristaps  198: .\" PARAGRAPH
1.30      kristaps  199: Consecutive next-line scope invocations are disallowed.
1.32    ! kristaps  200: .Bd -literal -offset indent
1.22      kristaps  201: \&.YO \(lBbody...\(rB
                    202: \(lBbody...\(rB
1.32    ! kristaps  203: .Ed
        !           204: .
        !           205: .Pp
1.30      kristaps  206: It is considered an error when next-line scope is open at the end of
                    207: file.
1.32    ! kristaps  208: .
        !           209: .Pp
        !           210: .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"
        !           211: .It Em Macro Ta Em Arguments Ta Em Scope
        !           212: .It    B     Ta    n         Ta    next-line
        !           213: .It    BI    Ta    n         Ta    current
        !           214: .It    BR    Ta    n         Ta    current
        !           215: .It    DT    Ta    0         Ta    current
        !           216: .It    I     Ta    n         Ta    next-line
        !           217: .It    IB    Ta    n         Ta    current
        !           218: .It    IR    Ta    n         Ta    current
        !           219: .It    R     Ta    n         Ta    next-line
        !           220: .It    RB    Ta    n         Ta    current
        !           221: .It    RI    Ta    n         Ta    current
        !           222: .It    SB    Ta    n         Ta    next-line
        !           223: .It    SM    Ta    n         Ta    next-line
        !           224: .It    TH    Ta    >1, <6    Ta    current
        !           225: .It    br    Ta    0         Ta    current
        !           226: .It    fi    Ta    0         Ta    current
        !           227: .It    i     Ta    n         Ta    current
        !           228: .It    na    Ta    0         Ta    current
        !           229: .It    nf    Ta    0         Ta    current
        !           230: .It    r     Ta    0         Ta    current
        !           231: .It    sp    Ta    1         Ta    current
        !           232: .El
        !           233: .
        !           234: .Pp
1.31      kristaps  235: The
1.32    ! kristaps  236: .Sq RS ,
        !           237: .Sq RE ,
        !           238: .Sq br ,
        !           239: .Sq fi ,
        !           240: .Sq i ,
        !           241: .Sq na ,
        !           242: .Sq nf ,
        !           243: .Sq r ,
1.22      kristaps  244: and
1.32    ! kristaps  245: .Sq sp
1.22      kristaps  246: macros aren't historically part of
1.32    ! kristaps  247: .Nm
1.22      kristaps  248: and should not be used.  They're included for compatibility.
1.28      kristaps  249: .
                    250: .
1.32    ! kristaps  251: .Ss Block Macros
1.30      kristaps  252: Block macros are comprised of a head and body.  Like for in-line macros,
                    253: the head is scoped to the current line and, in one circumstance, the
                    254: next line; the body is scoped to subsequent lines and is closed out by a
                    255: subsequent block macro invocation.
1.32    ! kristaps  256: .Bd -literal -offset indent
1.22      kristaps  257: \&.YO \(lBhead...\(rB
                    258: \(lBhead...\(rB
                    259: \(lBbody...\(rB
1.32    ! kristaps  260: .Ed
        !           261: .
        !           262: .Pp
1.30      kristaps  263: The closure of body scope may be to the section, where a macro is closed
                    264: by
1.32    ! kristaps  265: .Sq SH ;
1.30      kristaps  266: sub-section, closed by a section or
1.32    ! kristaps  267: .Sq SS ;
1.30      kristaps  268: part, closed by a section, sub-section, or
1.32    ! kristaps  269: .Sq RE ;
1.30      kristaps  270: or paragraph, closed by a section, sub-section, part,
1.32    ! kristaps  271: .Sq HP ,
        !           272: .Sq IP ,
        !           273: .Sq LP ,
        !           274: .Sq P ,
        !           275: .Sq PP ,
1.30      kristaps  276: or
1.32    ! kristaps  277: .Sq TP .
1.30      kristaps  278: No closure refers to an explicit block closing macro.
1.32    ! kristaps  279: .
        !           280: .Pp
1.30      kristaps  281: It is considered an error when part or next-line scope is open at the
                    282: end of file.
1.32    ! kristaps  283: .
        !           284: .Pp
        !           285: .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent
        !           286: .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope
        !           287: .It   HP     Ta    <2        Ta    current    Ta    paragraph
        !           288: .It   IP     Ta    <3        Ta    current    Ta    paragraph
        !           289: .It   LP     Ta    0         Ta    current    Ta    paragraph
        !           290: .It   P      Ta    0         Ta    current    Ta    paragraph
        !           291: .It   PP     Ta    0         Ta    current    Ta    paragraph
        !           292: .It   RE     Ta    0         Ta    current    Ta    none
        !           293: .It   RS     Ta    1         Ta    current    Ta    part
        !           294: .It   SH     Ta    >0        Ta    current    Ta    section
        !           295: .It   SS     Ta    >0        Ta    current    Ta    sub-section
        !           296: .It   TP     Ta    n         Ta    next-line  Ta    paragraph
        !           297: .El
        !           298: .
        !           299: .Pp
1.22      kristaps  300: If a block macro is next-line scoped, it may only be followed by in-line
                    301: macros (excluding
1.32    ! kristaps  302: .Sq DT ,
        !           303: .Sq TH ,
        !           304: .Sq br ,
        !           305: .Sq na ,
        !           306: .Sq sp ,
        !           307: .Sq nf ,
1.22      kristaps  308: and
1.32    ! kristaps  309: .Sq fi ) .
1.28      kristaps  310: .
                    311: .
1.22      kristaps  312: .Sh REFERENCE
                    313: This section is a canonical reference to all macros, arranged
                    314: alphabetically.  For the scoping of individual macros, see
1.32    ! kristaps  315: .Sx MACRO SYNTAX .
1.28      kristaps  316: .
                    317: .
1.32    ! kristaps  318: .Ss Definitions
1.26      kristaps  319: In this reference, a numerical width may be either a standalone natural
                    320: number (such as 3, 4, 10, etc.) or a natural number followed by a width
                    321: multiplier
1.32    ! kristaps  322: .Qq n ,
1.26      kristaps  323: corresponding to the width of the formatted letter n, or
1.32    ! kristaps  324: .Qq m ,
1.26      kristaps  325: corresponding to the width of the formatted letter m.  The latter is the
1.27      kristaps  326: default, if unspecified.  Thus,
1.32    ! kristaps  327: .Bd -literal -offset indent
1.27      kristaps  328: \&.HP 12n
1.32    ! kristaps  329: .Ed
        !           330: .
        !           331: .Pp
1.27      kristaps  332: indicates an offset of 12
1.32    ! kristaps  333: .Qq n
        !           334: .Ns -sized
1.27      kristaps  335: letters.
1.28      kristaps  336: .
                    337: .
1.32    ! kristaps  338: .Ss Macro Reference
        !           339: .Bl -tag -width Ds
        !           340: .It B
1.22      kristaps  341: Text is rendered in bold face.
1.32    ! kristaps  342: .It BI
1.22      kristaps  343: Text is rendered alternately in bold face and italic.  Thus,
1.32    ! kristaps  344: .Sq .BI this word and that
1.22      kristaps  345: causes
1.32    ! kristaps  346: .Sq this
1.22      kristaps  347: and
1.32    ! kristaps  348: .Sq and
1.22      kristaps  349: to render in bold face, while
1.32    ! kristaps  350: .Sq word
1.22      kristaps  351: and
1.32    ! kristaps  352: .Sq that
1.22      kristaps  353: render in italics.  Whitespace between arguments is omitted in output.
1.32    ! kristaps  354: .It BR
1.22      kristaps  355: Text is rendered alternately in bold face and roman (the default font).
                    356: Whitespace between arguments is omitted in output.
1.32    ! kristaps  357: .It DT
1.31      kristaps  358: Re-set the tab spacing to 0.5 inches.
1.32    ! kristaps  359: .It HP
1.23      kristaps  360: Begin a paragraph whose initial output line is left-justified, but
1.27      kristaps  361: subsequent output lines are indented, with the following syntax:
1.32    ! kristaps  362: .Bd -literal -offset indent
1.27      kristaps  363: \&.HP [width]
1.32    ! kristaps  364: .Ed
        !           365: .
        !           366: .Pp
1.27      kristaps  367: If
1.32    ! kristaps  368: .Va width
1.27      kristaps  369: is specified, it's saved for later paragraph left-margins; if
                    370: unspecified, the saved or default width is used.
1.32    ! kristaps  371: .It I
1.22      kristaps  372: Text is rendered in italics.
1.32    ! kristaps  373: .It IB
1.22      kristaps  374: Text is rendered alternately in italics and bold face.  Whitespace
                    375: between arguments is omitted in output.
1.32    ! kristaps  376: .It IP
1.25      kristaps  377: Begin a paragraph with the following syntax:
1.32    ! kristaps  378: .Bd -literal -offset indent
1.25      kristaps  379: \&.IP [head [width]]
1.32    ! kristaps  380: .Ed
        !           381: .
        !           382: .Pp
1.25      kristaps  383: This follows the behaviour of the
1.32    ! kristaps  384: .Sq TP
1.26      kristaps  385: except for the macro syntax (all arguments on the line, instead of
1.27      kristaps  386: having next-line scope).  If
1.32    ! kristaps  387: .Va width
1.27      kristaps  388: is specified, it's saved for later paragraph left-margins; if
                    389: unspecified, the saved or default width is used.
1.32    ! kristaps  390: .It IR
1.22      kristaps  391: Text is rendered alternately in italics and roman (the default font).
                    392: Whitespace between arguments is omitted in output.
1.32    ! kristaps  393: .It LP, P, PP
1.22      kristaps  394: Begin an undecorated paragraph.  The scope of a paragraph is closed by a
1.27      kristaps  395: subsequent paragraph, sub-section, section, or end of file.  The saved
                    396: paragraph left-margin width is re-set to the default.
1.32    ! kristaps  397: .It R
1.22      kristaps  398: Text is rendered in roman (the default font).
1.32    ! kristaps  399: .It RB
1.22      kristaps  400: Text is rendered alternately in roman (the default font) and bold face.
                    401: Whitespace between arguments is omitted in output.
1.32    ! kristaps  402: .It RE
1.30      kristaps  403: Explicitly close out the scope of a prior
1.32    ! kristaps  404: .Sq RS .
        !           405: .It RI
1.22      kristaps  406: Text is rendered alternately in roman (the default font) and italics.
                    407: Whitespace between arguments is omitted in output.
1.32    ! kristaps  408: .It RS
1.30      kristaps  409: Begin a part setting the left margin.  The left margin controls the
                    410: offset, following an initial indentation, to un-indented text such as
                    411: that of
1.32    ! kristaps  412: .Sq PP .
1.30      kristaps  413: The width may be specified as following:
1.32    ! kristaps  414: .Bd -literal -offset indent
1.30      kristaps  415: \&.RS [width]
1.32    ! kristaps  416: .Ed
        !           417: .
        !           418: .Pp
1.30      kristaps  419: If
1.32    ! kristaps  420: .Va width
1.30      kristaps  421: is not specified, the saved or default width is used.
1.32    ! kristaps  422: .It SB
1.22      kristaps  423: Text is rendered in small size (one point smaller than the default font)
                    424: bold face.
1.32    ! kristaps  425: .It SH
1.22      kristaps  426: Begin a section.  The scope of a section is only closed by another
1.27      kristaps  427: section or the end of file.  The paragraph left-margin width is re-set
                    428: to the default.
1.32    ! kristaps  429: .It SM
1.22      kristaps  430: Text is rendered in small size (one point smaller than the default
                    431: font).
1.32    ! kristaps  432: .It SS
1.22      kristaps  433: Begin a sub-section.  The scope of a sub-section is closed by a
1.27      kristaps  434: subsequent sub-section, section, or end of file.  The paragraph
                    435: left-margin width is re-set to the default.
1.32    ! kristaps  436: .It TH
1.22      kristaps  437: Sets the title of the manual page with the following syntax:
1.32    ! kristaps  438: .Bd -literal -offset indent
1.30      kristaps  439: \&.TH title section [date [source [volume]]]
1.32    ! kristaps  440: .Ed
        !           441: .
        !           442: .Pp
1.22      kristaps  443: At least the
1.32    ! kristaps  444: .Va title
1.22      kristaps  445: and
1.32    ! kristaps  446: .Va section
1.22      kristaps  447: arguments must be provided.  The
1.32    ! kristaps  448: .Va date
1.22      kristaps  449: argument should be formatted as
1.32    ! kristaps  450: .Qq %b [%d] %Y
1.22      kristaps  451: format, described in
1.32    ! kristaps  452: .Xr strptime 3 .
1.22      kristaps  453: The
1.32    ! kristaps  454: .Va source
1.22      kristaps  455: string specifies the organisation providing the utility.  The
1.32    ! kristaps  456: .Va volume
1.22      kristaps  457: replaces the default rendered volume as dictated by the manual section.
1.32    ! kristaps  458: .It TP
1.25      kristaps  459: Begin a paragraph where the head, if exceeding the indentation width, is
1.24      kristaps  460: followed by a newline; if not, the body follows on the same line after a
1.25      kristaps  461: buffer to the indentation width.  Subsequent output lines are indented.
1.32    ! kristaps  462: .
        !           463: .Pp
1.26      kristaps  464: The indentation width may be set as follows:
1.32    ! kristaps  465: .Bd -literal -offset indent
1.26      kristaps  466: \&.TP [width]
1.32    ! kristaps  467: .Ed
        !           468: .
        !           469: .Pp
1.26      kristaps  470: Where
1.32    ! kristaps  471: .Va width
1.27      kristaps  472: must be a properly-formed numeric width.  If
1.32    ! kristaps  473: .Va width
1.27      kristaps  474: is specified, it's saved for later paragraph left-margins; if
                    475: unspecified, the saved or default width is used.
1.32    ! kristaps  476: .It br
1.22      kristaps  477: Breaks the current line.  Consecutive invocations have no further effect.
1.32    ! kristaps  478: .It fi
1.22      kristaps  479: End literal mode begun by
1.32    ! kristaps  480: .Sq nf .
        !           481: .It i
1.22      kristaps  482: Italicise arguments.  If no arguments are specified, all subsequent text
                    483: is italicised.
1.32    ! kristaps  484: .It na
1.31      kristaps  485: Don't alignment the right margin.
1.32    ! kristaps  486: .It nf
1.22      kristaps  487: Begin literal mode: all subsequent free-form lines have their end of
                    488: line boundaries preserved.  May be ended by
1.32    ! kristaps  489: .Sq fi .
        !           490: .It r
1.22      kristaps  491: Fonts and styles (bold face, italics) reset to roman (default font).
1.32    ! kristaps  492: .It sp
1.22      kristaps  493: Insert n spaces, where n is the macro's positive numeric argument.  If
                    494: 0, this is equivalent to the
1.32    ! kristaps  495: .Sq br
1.22      kristaps  496: macro.
1.32    ! kristaps  497: .El
1.28      kristaps  498: .
                    499: .
1.18      kristaps  500: .Sh COMPATIBILITY
1.23      kristaps  501: This section documents compatibility with other roff implementations, at
                    502: this time limited to
1.32    ! kristaps  503: .Xr groff 1 .
        !           504: .Bl -hyphen
        !           505: .It
1.23      kristaps  506: In quoted literals, groff allowed pair-wise double-quotes to produce a
                    507: standalone double-quote in formatted output.  This idiosyncratic
                    508: behaviour is no longer applicable.
1.32    ! kristaps  509: .It
1.23      kristaps  510: The
1.32    ! kristaps  511: .Sq sp
1.23      kristaps  512: macro does not accept negative numbers.
1.32    ! kristaps  513: .It
1.23      kristaps  514: Blocks of whitespace are stripped from both macro and free-form text
                    515: lines (except when in literal mode), while groff would retain whitespace
                    516: in free-form text lines.
1.32    ! kristaps  517: .El
1.28      kristaps  518: .
                    519: .
1.1       kristaps  520: .Sh SEE ALSO
1.32    ! kristaps  521: .Xr mandoc 1 ,
        !           522: .Xr mandoc_char 7
1.28      kristaps  523: .
                    524: .
1.1       kristaps  525: .Sh AUTHORS
                    526: The
1.32    ! kristaps  527: .Nm
1.23      kristaps  528: reference was written by
1.32    ! kristaps  529: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.28      kristaps  530: .
                    531: .
1.1       kristaps  532: .Sh CAVEATS
                    533: Do not use this language.  Use
1.32    ! kristaps  534: .Xr mdoc 7 ,
1.1       kristaps  535: instead.
1.28      kristaps  536: .

CVSweb