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

Annotation of mandoc/man.7, Revision 1.41

1.41    ! kristaps    1: .\"    $Id: man.7,v 1.40 2009/10/24 05:45:04 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: .
1.38      kristaps  122: .Ss Scaling Widths
                    123: Many macros support scaled widths for their arguments, such as
                    124: stipulating a two-inch paragraph indentation with the following:
                    125: .Bd -literal -offset indent
                    126: \&.HP 2i
                    127: .Ed
                    128: .
                    129: .Pp
                    130: The syntax for scaled widths is
                    131: .Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? ,
                    132: where a decimal must be preceded or proceeded by at least one digit.
                    133: Negative numbers, while accepted, are truncated to zero.  The following
                    134: scaling units are accepted:
                    135: .
                    136: .Pp
                    137: .Bl -tag -width Ds -offset indent -compact
                    138: .It c
                    139: centimetre
                    140: .It i
                    141: inch
                    142: .It P
                    143: pica (~1/6 inch)
                    144: .It p
                    145: point (~1/72 inch)
                    146: .It f
                    147: synonym for
                    148: .Sq u
                    149: .It v
                    150: default vertical span
                    151: .It m
                    152: width of rendered
                    153: .Sq m
                    154: .Pq em
                    155: character
                    156: .It n
                    157: width of rendered
                    158: .Sq n
                    159: .Pq en
                    160: character
                    161: .It u
                    162: default horizontal span
                    163: .It M
                    164: mini-em (~1/100 em)
                    165: .El
                    166: .Pp
                    167: Using anything other than
                    168: .Sq m ,
                    169: .Sq n ,
                    170: .Sq u ,
                    171: or
                    172: .Sq v
                    173: is necessarily non-portable across output media.  See
                    174: .Sx COMPATIBILITY .
                    175: .
                    176: .Pp
                    177: If a scaling unit is not provided, the numerical value is interpreted
                    178: under the default rules of
                    179: .Sq v
                    180: for vertical spaces and
                    181: .Sq u
                    182: for horizontal ones.
                    183: .Em Note :
                    184: this differs from
                    185: .Xr mdoc 7 ,
                    186: which, if a unit is not provided, will instead interpret the string as
                    187: literal text.
                    188: .
1.28      kristaps  189: .
1.22      kristaps  190: .Sh MANUAL STRUCTURE
1.16      kristaps  191: Each
1.32      kristaps  192: .Nm
1.16      kristaps  193: document must contain contains at least the
1.39      kristaps  194: .Sx \&TH
1.16      kristaps  195: macro describing the document's section and title.  It may occur
                    196: anywhere in the document, although conventionally, it appears as the
                    197: first macro.
1.32      kristaps  198: .
                    199: .Pp
1.22      kristaps  200: Beyond
1.39      kristaps  201: .Sx \&TH ,
1.22      kristaps  202: at least one macro or text node must appear in the document.  Documents
                    203: are generally structured as follows:
1.32      kristaps  204: .Bd -literal -offset indent
1.22      kristaps  205: \&.TH FOO 1 "13 Aug 2009"
                    206: \&.
                    207: \&.SH NAME
1.29      kristaps  208: \efBfoo\efR \e(en a description goes here
1.33      kristaps  209: \&.\e\*q The next is for sections 2 & 3 only.
                    210: \&.\e\*q .SH LIBRARY
1.22      kristaps  211: \&.
                    212: \&.SH SYNOPSIS
                    213: \efBfoo\efR [\efB\e-options\efR] arguments...
                    214: \&.
                    215: \&.SH DESCRIPTION
1.33      kristaps  216: The \efBfoo\efR utility processes files...
1.22      kristaps  217: \&.
1.33      kristaps  218: \&.\e\*q .SH IMPLEMENTATION NOTES
                    219: \&.\e\*q The next is for sections 1 & 8 only.
                    220: \&.\e\*q .SH EXIT STATUS
                    221: \&.\e\*q The next is for sections 2, 3, & 9 only.
1.22      kristaps  222: \&.\e\*q .SH RETURN VALUES
1.33      kristaps  223: \&.\e\*q The next is for sections 1, 6, 7, & 8 only.
1.22      kristaps  224: \&.\e\*q .SH ENVIRONMENT
                    225: \&.\e\*q .SH FILES
                    226: \&.\e\*q .SH EXAMPLES
1.33      kristaps  227: \&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
1.22      kristaps  228: \&.\e\*q .SH DIAGNOSTICS
1.33      kristaps  229: \&.\e\*q The next is for sections 2, 3, & 9 only.
1.22      kristaps  230: \&.\e\*q .SH ERRORS
                    231: \&.\e\*q .SH SEE ALSO
                    232: \&.\e\*q \efBbar\efR(1)
                    233: \&.\e\*q .SH STANDARDS
                    234: \&.\e\*q .SH HISTORY
                    235: \&.\e\*q .SH AUTHORS
                    236: \&.\e\*q .SH CAVEATS
                    237: \&.\e\*q .SH BUGS
1.33      kristaps  238: \&.\e\*q .SH SECURITY CONSIDERATIONS
1.32      kristaps  239: .Ed
1.41    ! kristaps  240: .Pp
        !           241: The sections in a
        !           242: .Nm
        !           243: document are conventionally ordered as they appear above.  Sections
        !           244: should be composed as follows:
        !           245: .Bl -tag -width Ds -offset Ds
        !           246: .It NAME
        !           247: The name(s) and a short description of the documented material.  The
        !           248: syntax for this is generally as follows:
        !           249: .Pp
        !           250: .D1 \efBname\efR \e(en description
        !           251: .It LIBRARY
        !           252: The name of the library containing the documented material, which is
        !           253: assumed to be a function in a section 2 or 3 manual.  For functions in
        !           254: the C library, this may be as follows:
        !           255: .Pp
        !           256: .D1 Standard C Library (libc, -lc)
        !           257: .It SYNOPSIS
        !           258: Documents the utility invocation syntax, function call syntax, or device
        !           259: configuration.
        !           260: .Pp
        !           261: For the first, utilities (sections 1, 6, and 8), this is
        !           262: generally structured as follows:
        !           263: .Pp
        !           264: .D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR...
        !           265: .Pp
        !           266: For the second, function calls (sections 2, 3, 9):
        !           267: .Pp
        !           268: .D1 \. Ns Sx \&B No char *name(char *\efIarg\efR);
        !           269: .Pp
        !           270: And for the third, configurations (section 4):
        !           271: .Pp
        !           272: .D1 \. Ns Sx \&B No name* at cardbus ? function ?
        !           273: .Pp
        !           274: Manuals not in these sections generally don't need a SYNOPSIS.
        !           275: .It DESCRIPTION
        !           276: This expands upon the brief, one-line description in NAME.  It usually
        !           277: contains a break-down of the options (if documenting a command).
        !           278: .It IMPLEMENTATION NOTES
        !           279: Implementation-specific notes should be kept here.  This is useful when
        !           280: implementing standard functions that may have side effects or notable
        !           281: algorithmic implications.
        !           282: .It EXIT STATUS
        !           283: .It RETURN VALUES
        !           284: .It ENVIRONMENT
        !           285: .It FILES
        !           286: .It EXAMPLES
        !           287: .It DIAGNOSTICS
        !           288: .It ERRORS
        !           289: .It SEE ALSO
        !           290: .It STANDARDS
        !           291: .It HISTORY
        !           292: .It AUTHORS
        !           293: .It CAVEATS
        !           294: .It BUGS
        !           295: .It SECURITY CONSIDERATIONS
        !           296: .El
1.28      kristaps  297: .
                    298: .
1.22      kristaps  299: .Sh MACRO SYNTAX
1.2       kristaps  300: Macros are one to three three characters in length and begin with a
1.4       kristaps  301: control character ,
1.32      kristaps  302: .Sq \&. ,
1.2       kristaps  303: at the beginning of the line.  An arbitrary amount of whitespace may
1.39      kristaps  304: sit between the control character and the macro name.  Thus, the
                    305: following are equivalent:
                    306: .Bd -literal -offset indent
                    307: \&.PP
                    308: \&.\ \ \ PP
                    309: .Ed
1.32      kristaps  310: .
                    311: .Pp
1.1       kristaps  312: The
1.32      kristaps  313: .Nm
1.30      kristaps  314: macros are classified by scope: line scope or block scope.  Line
1.22      kristaps  315: macros are only scoped to the current line (and, in some situations,
                    316: the subsequent line).  Block macros are scoped to the current line and
                    317: subsequent lines until closed by another block macro.
1.28      kristaps  318: .
                    319: .
1.32      kristaps  320: .Ss Line Macros
1.30      kristaps  321: Line macros are generally scoped to the current line, with the body
                    322: consisting of zero or more arguments.  If a macro is scoped to the next
                    323: line and the line arguments are empty, the next line is used instead,
                    324: else the general syntax is used.  Thus:
1.32      kristaps  325: .Bd -literal -offset indent
1.30      kristaps  326: \&.I
1.4       kristaps  327: foo
1.32      kristaps  328: .Ed
                    329: .
                    330: .Pp
1.20      kristaps  331: is equivalent to
1.32      kristaps  332: .Sq \&.I foo .
1.35      kristaps  333: If next-line macros are invoked consecutively, only the last is used.
                    334: If a next-line macro is proceded by a block macro, it is ignored.
1.32      kristaps  335: .Bd -literal -offset indent
1.22      kristaps  336: \&.YO \(lBbody...\(rB
                    337: \(lBbody...\(rB
1.32      kristaps  338: .Ed
                    339: .
                    340: .Pp
                    341: .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"
                    342: .It Em Macro Ta Em Arguments Ta Em Scope
1.39      kristaps  343: .It Sx \&B   Ta    n         Ta    next-line
                    344: .It Sx \&BI  Ta    n         Ta    current
                    345: .It Sx \&BR  Ta    n         Ta    current
                    346: .It Sx \&DT  Ta    0         Ta    current
                    347: .It Sx \&I   Ta    n         Ta    next-line
                    348: .It Sx \&IB  Ta    n         Ta    current
                    349: .It Sx \&IR  Ta    n         Ta    current
1.40      kristaps  350: .It Sx \&PD  Ta    n         Ta    current
1.39      kristaps  351: .It Sx \&R   Ta    n         Ta    next-line
                    352: .It Sx \&RB  Ta    n         Ta    current
                    353: .It Sx \&RI  Ta    n         Ta    current
                    354: .It Sx \&SB  Ta    n         Ta    next-line
                    355: .It Sx \&SM  Ta    n         Ta    next-line
                    356: .It Sx \&TH  Ta    >1, <6    Ta    current
                    357: .It Sx \&UC  Ta    n         Ta    current
                    358: .It Sx \&br  Ta    0         Ta    current
                    359: .It Sx \&fi  Ta    0         Ta    current
                    360: .It Sx \&i   Ta    n         Ta    current
                    361: .It Sx \&na  Ta    0         Ta    current
                    362: .It Sx \&nf  Ta    0         Ta    current
                    363: .It Sx \&r   Ta    0         Ta    current
                    364: .It Sx \&sp  Ta    1         Ta    current
1.32      kristaps  365: .El
                    366: .
                    367: .Pp
1.31      kristaps  368: The
1.40      kristaps  369: .Sx \&PD ,
1.39      kristaps  370: .Sx \&RS ,
                    371: .Sx \&RE ,
                    372: .Sx \&UC ,
                    373: .Sx \&br ,
                    374: .Sx \&fi ,
                    375: .Sx \&i ,
                    376: .Sx \&na ,
                    377: .Sx \&nf ,
                    378: .Sx \&r ,
1.22      kristaps  379: and
1.39      kristaps  380: .Sx \&sp
1.36      kristaps  381: macros should not be used.  They're included for compatibility.
1.28      kristaps  382: .
                    383: .
1.32      kristaps  384: .Ss Block Macros
1.30      kristaps  385: Block macros are comprised of a head and body.  Like for in-line macros,
                    386: the head is scoped to the current line and, in one circumstance, the
                    387: next line; the body is scoped to subsequent lines and is closed out by a
                    388: subsequent block macro invocation.
1.32      kristaps  389: .Bd -literal -offset indent
1.22      kristaps  390: \&.YO \(lBhead...\(rB
                    391: \(lBhead...\(rB
                    392: \(lBbody...\(rB
1.32      kristaps  393: .Ed
                    394: .
                    395: .Pp
1.30      kristaps  396: The closure of body scope may be to the section, where a macro is closed
                    397: by
1.39      kristaps  398: .Sx \&SH ;
1.30      kristaps  399: sub-section, closed by a section or
1.39      kristaps  400: .Sx \&SS ;
1.30      kristaps  401: part, closed by a section, sub-section, or
1.39      kristaps  402: .Sx \&RE ;
1.30      kristaps  403: or paragraph, closed by a section, sub-section, part,
1.39      kristaps  404: .Sx \&HP ,
                    405: .Sx \&IP ,
                    406: .Sx \&LP ,
                    407: .Sx \&P ,
                    408: .Sx \&PP ,
1.30      kristaps  409: or
1.39      kristaps  410: .Sx \&TP .
1.30      kristaps  411: No closure refers to an explicit block closing macro.
1.32      kristaps  412: .
                    413: .Pp
                    414: .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent
                    415: .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope
1.39      kristaps  416: .It Sx \&HP  Ta    <2        Ta    current    Ta    paragraph
                    417: .It Sx \&IP  Ta    <3        Ta    current    Ta    paragraph
                    418: .It Sx \&LP  Ta    0         Ta    current    Ta    paragraph
                    419: .It Sx \&P   Ta    0         Ta    current    Ta    paragraph
                    420: .It Sx \&PP  Ta    0         Ta    current    Ta    paragraph
                    421: .It Sx \&RE  Ta    0         Ta    current    Ta    none
                    422: .It Sx \&RS  Ta    1         Ta    current    Ta    part
                    423: .It Sx \&SH  Ta    >0        Ta    next-line  Ta    section
                    424: .It Sx \&SS  Ta    >0        Ta    next-line  Ta    sub-section
                    425: .It Sx \&TP  Ta    n         Ta    next-line  Ta    paragraph
1.32      kristaps  426: .El
                    427: .
                    428: .Pp
1.22      kristaps  429: If a block macro is next-line scoped, it may only be followed by in-line
                    430: macros (excluding
1.39      kristaps  431: .Sx \&DT ,
1.40      kristaps  432: .Sx \&PD ,
1.39      kristaps  433: .Sx \&TH ,
                    434: .Sx \&UC ,
                    435: .Sx \&br ,
                    436: .Sx \&na ,
                    437: .Sx \&sp ,
                    438: .Sx \&nf ,
1.22      kristaps  439: and
1.39      kristaps  440: .Sx \&fi ) .
1.28      kristaps  441: .
                    442: .
1.22      kristaps  443: .Sh REFERENCE
                    444: This section is a canonical reference to all macros, arranged
                    445: alphabetically.  For the scoping of individual macros, see
1.32      kristaps  446: .Sx MACRO SYNTAX .
1.28      kristaps  447: .
1.39      kristaps  448: .Ss \&B
1.22      kristaps  449: Text is rendered in bold face.
1.39      kristaps  450: .Ss \&BI
1.22      kristaps  451: Text is rendered alternately in bold face and italic.  Thus,
1.32      kristaps  452: .Sq .BI this word and that
1.22      kristaps  453: causes
1.32      kristaps  454: .Sq this
1.22      kristaps  455: and
1.32      kristaps  456: .Sq and
1.22      kristaps  457: to render in bold face, while
1.32      kristaps  458: .Sq word
1.22      kristaps  459: and
1.32      kristaps  460: .Sq that
1.22      kristaps  461: render in italics.  Whitespace between arguments is omitted in output.
1.39      kristaps  462: .Ss \&BR
1.22      kristaps  463: Text is rendered alternately in bold face and roman (the default font).
                    464: Whitespace between arguments is omitted in output.
1.39      kristaps  465: .Ss \&DT
1.36      kristaps  466: Has no effect.  Included for compatibility.
1.39      kristaps  467: .Ss \&HP
1.23      kristaps  468: Begin a paragraph whose initial output line is left-justified, but
1.27      kristaps  469: subsequent output lines are indented, with the following syntax:
1.32      kristaps  470: .Bd -literal -offset indent
1.27      kristaps  471: \&.HP [width]
1.32      kristaps  472: .Ed
                    473: .
                    474: .Pp
1.38      kristaps  475: If scaling width
1.32      kristaps  476: .Va width
1.27      kristaps  477: is specified, it's saved for later paragraph left-margins; if
                    478: unspecified, the saved or default width is used.
1.39      kristaps  479: .Ss \&I
1.22      kristaps  480: Text is rendered in italics.
1.39      kristaps  481: .Ss \&IB
1.22      kristaps  482: Text is rendered alternately in italics and bold face.  Whitespace
                    483: between arguments is omitted in output.
1.39      kristaps  484: .Ss \&IP
1.25      kristaps  485: Begin a paragraph with the following syntax:
1.32      kristaps  486: .Bd -literal -offset indent
1.25      kristaps  487: \&.IP [head [width]]
1.32      kristaps  488: .Ed
                    489: .
                    490: .Pp
1.25      kristaps  491: This follows the behaviour of the
1.39      kristaps  492: .Sx \&TP
1.26      kristaps  493: except for the macro syntax (all arguments on the line, instead of
1.27      kristaps  494: having next-line scope).  If
1.32      kristaps  495: .Va width
1.27      kristaps  496: is specified, it's saved for later paragraph left-margins; if
                    497: unspecified, the saved or default width is used.
1.39      kristaps  498: .Ss \&IR
1.22      kristaps  499: Text is rendered alternately in italics and roman (the default font).
                    500: Whitespace between arguments is omitted in output.
1.39      kristaps  501: .Ss \&LP
1.22      kristaps  502: Begin an undecorated paragraph.  The scope of a paragraph is closed by a
1.27      kristaps  503: subsequent paragraph, sub-section, section, or end of file.  The saved
                    504: paragraph left-margin width is re-set to the default.
1.39      kristaps  505: .Ss \&P
                    506: Synonym for
                    507: .Sx \&LP .
                    508: .Ss \&PP
                    509: Synonym for
                    510: .Sx \&LP .
                    511: .Ss \&R
1.22      kristaps  512: Text is rendered in roman (the default font).
1.39      kristaps  513: .Ss \&RB
1.22      kristaps  514: Text is rendered alternately in roman (the default font) and bold face.
                    515: Whitespace between arguments is omitted in output.
1.39      kristaps  516: .Ss \&RE
1.30      kristaps  517: Explicitly close out the scope of a prior
1.39      kristaps  518: .Sx \&RS .
                    519: .Ss \&RI
1.22      kristaps  520: Text is rendered alternately in roman (the default font) and italics.
                    521: Whitespace between arguments is omitted in output.
1.39      kristaps  522: .Ss \&RS
1.30      kristaps  523: Begin a part setting the left margin.  The left margin controls the
                    524: offset, following an initial indentation, to un-indented text such as
                    525: that of
1.39      kristaps  526: .Sx \&PP .
1.38      kristaps  527: A scaling width may be specified as following:
1.32      kristaps  528: .Bd -literal -offset indent
1.30      kristaps  529: \&.RS [width]
1.32      kristaps  530: .Ed
                    531: .
                    532: .Pp
1.30      kristaps  533: If
1.32      kristaps  534: .Va width
1.30      kristaps  535: is not specified, the saved or default width is used.
1.39      kristaps  536: .Ss \&SB
1.22      kristaps  537: Text is rendered in small size (one point smaller than the default font)
                    538: bold face.
1.39      kristaps  539: .Ss \&SH
1.22      kristaps  540: Begin a section.  The scope of a section is only closed by another
1.27      kristaps  541: section or the end of file.  The paragraph left-margin width is re-set
                    542: to the default.
1.39      kristaps  543: .Ss \&SM
1.22      kristaps  544: Text is rendered in small size (one point smaller than the default
                    545: font).
1.39      kristaps  546: .Ss \&SS
1.22      kristaps  547: Begin a sub-section.  The scope of a sub-section is closed by a
1.27      kristaps  548: subsequent sub-section, section, or end of file.  The paragraph
                    549: left-margin width is re-set to the default.
1.39      kristaps  550: .Ss \&TH
1.22      kristaps  551: Sets the title of the manual page with the following syntax:
1.32      kristaps  552: .Bd -literal -offset indent
1.30      kristaps  553: \&.TH title section [date [source [volume]]]
1.32      kristaps  554: .Ed
                    555: .
                    556: .Pp
1.22      kristaps  557: At least the
1.32      kristaps  558: .Va title
1.22      kristaps  559: and
1.32      kristaps  560: .Va section
1.22      kristaps  561: arguments must be provided.  The
1.32      kristaps  562: .Va date
1.22      kristaps  563: argument should be formatted as
1.32      kristaps  564: .Qq %b [%d] %Y
1.22      kristaps  565: format, described in
1.32      kristaps  566: .Xr strptime 3 .
1.22      kristaps  567: The
1.32      kristaps  568: .Va source
1.22      kristaps  569: string specifies the organisation providing the utility.  The
1.32      kristaps  570: .Va volume
1.22      kristaps  571: replaces the default rendered volume as dictated by the manual section.
1.39      kristaps  572: .Ss \&TP
1.25      kristaps  573: Begin a paragraph where the head, if exceeding the indentation width, is
1.24      kristaps  574: followed by a newline; if not, the body follows on the same line after a
1.25      kristaps  575: buffer to the indentation width.  Subsequent output lines are indented.
1.32      kristaps  576: .
                    577: .Pp
1.38      kristaps  578: The indentation scaling width may be set as follows:
1.32      kristaps  579: .Bd -literal -offset indent
1.26      kristaps  580: \&.TP [width]
1.32      kristaps  581: .Ed
                    582: .
                    583: .Pp
1.38      kristaps  584: If
1.32      kristaps  585: .Va width
1.27      kristaps  586: is specified, it's saved for later paragraph left-margins; if
                    587: unspecified, the saved or default width is used.
1.40      kristaps  588: .Ss \&PD
                    589: Has no effect.  Included for compatibility.
1.39      kristaps  590: .Ss \&UC
1.37      kristaps  591: Has no effect.  Included for compatibility.
1.39      kristaps  592: .Ss \&br
1.22      kristaps  593: Breaks the current line.  Consecutive invocations have no further effect.
1.39      kristaps  594: .Ss \&fi
1.22      kristaps  595: End literal mode begun by
1.39      kristaps  596: .Sx \&nf .
                    597: .Ss \&i
1.22      kristaps  598: Italicise arguments.  If no arguments are specified, all subsequent text
                    599: is italicised.
1.39      kristaps  600: .Ss \&na
1.36      kristaps  601: Don't align to the right margin.
1.39      kristaps  602: .Ss \&nf
1.22      kristaps  603: Begin literal mode: all subsequent free-form lines have their end of
                    604: line boundaries preserved.  May be ended by
1.39      kristaps  605: .Sx \&fi .
                    606: .Ss \&r
1.22      kristaps  607: Fonts and styles (bold face, italics) reset to roman (default font).
1.39      kristaps  608: .Ss \&sp
1.22      kristaps  609: Insert n spaces, where n is the macro's positive numeric argument.  If
                    610: 0, this is equivalent to the
1.39      kristaps  611: .Sx \&br
1.22      kristaps  612: macro.
1.28      kristaps  613: .
                    614: .
1.18      kristaps  615: .Sh COMPATIBILITY
1.23      kristaps  616: This section documents compatibility with other roff implementations, at
                    617: this time limited to
1.32      kristaps  618: .Xr groff 1 .
                    619: .Bl -hyphen
                    620: .It
1.23      kristaps  621: In quoted literals, groff allowed pair-wise double-quotes to produce a
                    622: standalone double-quote in formatted output.  This idiosyncratic
                    623: behaviour is no longer applicable.
1.32      kristaps  624: .It
1.23      kristaps  625: The
1.32      kristaps  626: .Sq sp
1.23      kristaps  627: macro does not accept negative numbers.
1.32      kristaps  628: .It
1.23      kristaps  629: Blocks of whitespace are stripped from both macro and free-form text
                    630: lines (except when in literal mode), while groff would retain whitespace
                    631: in free-form text lines.
1.32      kristaps  632: .El
1.28      kristaps  633: .
                    634: .
1.1       kristaps  635: .Sh SEE ALSO
1.32      kristaps  636: .Xr mandoc 1 ,
                    637: .Xr mandoc_char 7
1.28      kristaps  638: .
                    639: .
1.1       kristaps  640: .Sh AUTHORS
                    641: The
1.32      kristaps  642: .Nm
1.23      kristaps  643: reference was written by
1.32      kristaps  644: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.28      kristaps  645: .
                    646: .
1.1       kristaps  647: .Sh CAVEATS
                    648: Do not use this language.  Use
1.32      kristaps  649: .Xr mdoc 7 ,
1.1       kristaps  650: instead.
1.28      kristaps  651: .

CVSweb