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

Annotation of mandoc/man.7, Revision 1.49

1.49    ! kristaps    1: .\"    $Id: man.7,v 1.48 2009/11/09 05:11:46 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.44      kristaps   85: is also ignored.  Macro lines with only a control character and
1.22      kristaps   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.47      kristaps  112: escape followed by an indicator: B (bold), I, (italic), R (Roman), or P
1.48      kristaps  113: (revert to previous mode):
                    114: .Pp
                    115: .D1 \efBbold\efR \efIitalic\efP
                    116: .Pp
                    117: A numerical representation 3, 2, or 1 (bold, italic, and Roman,
                    118: respectively) may be used instead.
                    119: .Pp
                    120: Text may also be sized with the
                    121: .Sq \es
                    122: escape, whose syntax is one of
                    123: .Sq \es+-n
                    124: for one-digit numerals;
                    125: .Sq \es(+-nn
                    126: or
                    127: .Sq \es+-(nn
                    128: for two-digit numerals; and
                    129: .Sq \es[+-N] ,
                    130: .Sq \es+-[N] ,
                    131: .Sq \es'+-N' ,
                    132: or
                    133: .Sq \es+-'N'
                    134: for arbitrary-digit numerals:
                    135: .Pp
                    136: .D1 \es+1bigger\es-1
                    137: .D1 \es[+10]much bigger\es[-10]
                    138: .D1 \es+(10much bigger\es-(10
                    139: .D1 \es+'100'much much bigger\es-'100'
1.49    ! kristaps  140: .Pp
        !           141: Both
        !           142: .Sq \es
        !           143: and
        !           144: .Sq \ef
        !           145: attributes are forgotten when exiting a subsequent (or current) macro
        !           146: invocation.
1.28      kristaps  147: .
                    148: .
1.32      kristaps  149: .Ss Whitespace
1.17      kristaps  150: Unless specifically escaped, consecutive blocks of whitespace are pruned
                    151: from input.  These are later re-added, if applicable, by a front-end
                    152: utility such as
1.32      kristaps  153: .Xr mandoc 1 .
1.28      kristaps  154: .
1.44      kristaps  155: .
1.43      kristaps  156: .Ss Dates
                    157: The
                    158: .Sx \&TH
                    159: macro is the only
                    160: .Nm
                    161: macro that requires a date.  The form for this date is the ISO-8601
                    162: standard
                    163: .Cm YYYY-MM-DD .
                    164: .
                    165: .
1.38      kristaps  166: .Ss Scaling Widths
                    167: Many macros support scaled widths for their arguments, such as
                    168: stipulating a two-inch paragraph indentation with the following:
                    169: .Bd -literal -offset indent
                    170: \&.HP 2i
                    171: .Ed
                    172: .
                    173: .Pp
                    174: The syntax for scaled widths is
                    175: .Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? ,
                    176: where a decimal must be preceded or proceeded by at least one digit.
                    177: Negative numbers, while accepted, are truncated to zero.  The following
                    178: scaling units are accepted:
                    179: .
                    180: .Pp
                    181: .Bl -tag -width Ds -offset indent -compact
                    182: .It c
                    183: centimetre
                    184: .It i
                    185: inch
                    186: .It P
                    187: pica (~1/6 inch)
                    188: .It p
                    189: point (~1/72 inch)
                    190: .It f
                    191: synonym for
                    192: .Sq u
                    193: .It v
                    194: default vertical span
                    195: .It m
                    196: width of rendered
                    197: .Sq m
                    198: .Pq em
                    199: character
                    200: .It n
                    201: width of rendered
                    202: .Sq n
                    203: .Pq en
                    204: character
                    205: .It u
                    206: default horizontal span
                    207: .It M
                    208: mini-em (~1/100 em)
                    209: .El
                    210: .Pp
                    211: Using anything other than
                    212: .Sq m ,
                    213: .Sq n ,
                    214: .Sq u ,
                    215: or
                    216: .Sq v
1.44      kristaps  217: is necessarily non-portable across output media.
1.38      kristaps  218: .
                    219: .Pp
                    220: If a scaling unit is not provided, the numerical value is interpreted
                    221: under the default rules of
                    222: .Sq v
                    223: for vertical spaces and
                    224: .Sq u
                    225: for horizontal ones.
                    226: .Em Note :
                    227: this differs from
                    228: .Xr mdoc 7 ,
                    229: which, if a unit is not provided, will instead interpret the string as
                    230: literal text.
                    231: .
1.28      kristaps  232: .
1.22      kristaps  233: .Sh MANUAL STRUCTURE
1.16      kristaps  234: Each
1.32      kristaps  235: .Nm
1.16      kristaps  236: document must contain contains at least the
1.39      kristaps  237: .Sx \&TH
1.16      kristaps  238: macro describing the document's section and title.  It may occur
                    239: anywhere in the document, although conventionally, it appears as the
                    240: first macro.
1.32      kristaps  241: .
                    242: .Pp
1.22      kristaps  243: Beyond
1.39      kristaps  244: .Sx \&TH ,
1.22      kristaps  245: at least one macro or text node must appear in the document.  Documents
                    246: are generally structured as follows:
1.32      kristaps  247: .Bd -literal -offset indent
1.43      kristaps  248: \&.TH FOO 1 2009-10-10
1.22      kristaps  249: \&.
                    250: \&.SH NAME
1.29      kristaps  251: \efBfoo\efR \e(en a description goes here
1.33      kristaps  252: \&.\e\*q The next is for sections 2 & 3 only.
                    253: \&.\e\*q .SH LIBRARY
1.22      kristaps  254: \&.
                    255: \&.SH SYNOPSIS
                    256: \efBfoo\efR [\efB\e-options\efR] arguments...
                    257: \&.
                    258: \&.SH DESCRIPTION
1.33      kristaps  259: The \efBfoo\efR utility processes files...
1.22      kristaps  260: \&.
1.33      kristaps  261: \&.\e\*q .SH IMPLEMENTATION NOTES
                    262: \&.\e\*q The next is for sections 1 & 8 only.
                    263: \&.\e\*q .SH EXIT STATUS
                    264: \&.\e\*q The next is for sections 2, 3, & 9 only.
1.22      kristaps  265: \&.\e\*q .SH RETURN VALUES
1.33      kristaps  266: \&.\e\*q The next is for sections 1, 6, 7, & 8 only.
1.22      kristaps  267: \&.\e\*q .SH ENVIRONMENT
                    268: \&.\e\*q .SH FILES
                    269: \&.\e\*q .SH EXAMPLES
1.33      kristaps  270: \&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
1.22      kristaps  271: \&.\e\*q .SH DIAGNOSTICS
1.33      kristaps  272: \&.\e\*q The next is for sections 2, 3, & 9 only.
1.22      kristaps  273: \&.\e\*q .SH ERRORS
                    274: \&.\e\*q .SH SEE ALSO
1.42      kristaps  275: \&.\e\*q .BR foo ( 1 )
1.22      kristaps  276: \&.\e\*q .SH STANDARDS
                    277: \&.\e\*q .SH HISTORY
                    278: \&.\e\*q .SH AUTHORS
                    279: \&.\e\*q .SH CAVEATS
                    280: \&.\e\*q .SH BUGS
1.33      kristaps  281: \&.\e\*q .SH SECURITY CONSIDERATIONS
1.32      kristaps  282: .Ed
1.41      kristaps  283: .Pp
                    284: The sections in a
                    285: .Nm
                    286: document are conventionally ordered as they appear above.  Sections
                    287: should be composed as follows:
1.42      kristaps  288: .Bl -ohang -offset indent
                    289: .It Em NAME
1.41      kristaps  290: The name(s) and a short description of the documented material.  The
                    291: syntax for this is generally as follows:
                    292: .Pp
                    293: .D1 \efBname\efR \e(en description
1.42      kristaps  294: .It Em LIBRARY
1.41      kristaps  295: The name of the library containing the documented material, which is
                    296: assumed to be a function in a section 2 or 3 manual.  For functions in
                    297: the C library, this may be as follows:
                    298: .Pp
                    299: .D1 Standard C Library (libc, -lc)
1.42      kristaps  300: .It Em SYNOPSIS
1.41      kristaps  301: Documents the utility invocation syntax, function call syntax, or device
                    302: configuration.
                    303: .Pp
                    304: For the first, utilities (sections 1, 6, and 8), this is
                    305: generally structured as follows:
                    306: .Pp
                    307: .D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR...
                    308: .Pp
                    309: For the second, function calls (sections 2, 3, 9):
                    310: .Pp
1.44      kristaps  311: .D1 \&.B char *name(char *\efIarg\efR);
1.41      kristaps  312: .Pp
                    313: And for the third, configurations (section 4):
                    314: .Pp
1.44      kristaps  315: .D1 \&.B name* at cardbus ? function ?
1.41      kristaps  316: .Pp
1.42      kristaps  317: Manuals not in these sections generally don't need a
                    318: .Em SYNOPSIS .
                    319: .It Em DESCRIPTION
                    320: This expands upon the brief, one-line description in
                    321: .Em NAME .
                    322: It usually contains a break-down of the options (if documenting a
                    323: command).
                    324: .It Em IMPLEMENTATION NOTES
1.41      kristaps  325: Implementation-specific notes should be kept here.  This is useful when
                    326: implementing standard functions that may have side effects or notable
                    327: algorithmic implications.
1.42      kristaps  328: .It Em EXIT STATUS
                    329: Command exit status for section 1, 6, and 8 manuals.  This section is
                    330: the dual of
                    331: .Em RETURN VALUES ,
                    332: which is used for functions.  Historically, this information was
                    333: described in
                    334: .Em DIAGNOSTICS ,
                    335: a practise that is now discouraged.
                    336: .
                    337: .It Em RETURN VALUES
                    338: This section is the dual of
                    339: .Em EXIT STATUS ,
                    340: which is used for commands.  It documents the return values of functions
                    341: in sections 2, 3, and 9.
                    342: .
                    343: .It Em ENVIRONMENT
                    344: Documents any usages of environment variables, e.g.,
                    345: .Xr environ 7 .
                    346: .
                    347: .It Em FILES
                    348: Documents files used.  It's helpful to document both the file and a
                    349: short description of how the file is used (created, modified, etc.).
                    350: .
                    351: .It Em EXAMPLES
                    352: Example usages.  This often contains snippets of well-formed,
                    353: well-tested invocations.  Make doubly sure that your examples work
1.44      kristaps  354: properly!
1.42      kristaps  355: .
                    356: .It Em DIAGNOSTICS
                    357: Documents error conditions.  This is most useful in section 4 manuals.
                    358: Historically, this section was used in place of
                    359: .Em EXIT STATUS
                    360: for manuals in sections 1, 6, and 8; however, this practise is
                    361: discouraged.
                    362: .
                    363: .It Em ERRORS
                    364: Documents error handling in sections 2, 3, and 9.
                    365: .
                    366: .It Em SEE ALSO
                    367: References other manuals with related topics.  This section should exist
1.44      kristaps  368: for most manuals.
                    369: .Pp
                    370: .D1 \&.BR bar \&( 1 \&),
                    371: .Pp
                    372: Cross-references should conventionally be ordered
1.42      kristaps  373: first by section, then alphabetically.
                    374: .
                    375: .It Em STANDARDS
                    376: References any standards implemented or used, such as
                    377: .Pp
                    378: .D1 IEEE Std 1003.2 (\e(lqPOSIX.2\e(rq)
                    379: .Pp
                    380: If not adhering to any standards, the
                    381: .Em HISTORY
                    382: section should be used.
                    383: .
                    384: .It Em HISTORY
                    385: The history of any manual without a
                    386: .Em STANDARDS
                    387: section should be described in this section.
                    388: .
                    389: .It Em AUTHORS
                    390: Credits to authors, if applicable, should appear in this section.
                    391: Authors should generally be noted by both name and an e-mail address.
                    392: .
                    393: .It Em CAVEATS
                    394: Explanations of common misuses and misunderstandings should be explained
                    395: in this section.
                    396: .
                    397: .It Em BUGS
                    398: Extant bugs should be described in this section.
                    399: .
                    400: .It Em SECURITY CONSIDERATIONS
                    401: Documents any security precautions that operators should consider.
                    402: .
1.41      kristaps  403: .El
1.28      kristaps  404: .
                    405: .
1.22      kristaps  406: .Sh MACRO SYNTAX
1.2       kristaps  407: Macros are one to three three characters in length and begin with a
1.4       kristaps  408: control character ,
1.32      kristaps  409: .Sq \&. ,
1.2       kristaps  410: at the beginning of the line.  An arbitrary amount of whitespace may
1.39      kristaps  411: sit between the control character and the macro name.  Thus, the
                    412: following are equivalent:
                    413: .Bd -literal -offset indent
                    414: \&.PP
                    415: \&.\ \ \ PP
                    416: .Ed
1.32      kristaps  417: .
                    418: .Pp
1.1       kristaps  419: The
1.32      kristaps  420: .Nm
1.30      kristaps  421: macros are classified by scope: line scope or block scope.  Line
1.22      kristaps  422: macros are only scoped to the current line (and, in some situations,
                    423: the subsequent line).  Block macros are scoped to the current line and
                    424: subsequent lines until closed by another block macro.
1.28      kristaps  425: .
                    426: .
1.32      kristaps  427: .Ss Line Macros
1.30      kristaps  428: Line macros are generally scoped to the current line, with the body
                    429: consisting of zero or more arguments.  If a macro is scoped to the next
                    430: line and the line arguments are empty, the next line is used instead,
                    431: else the general syntax is used.  Thus:
1.32      kristaps  432: .Bd -literal -offset indent
1.30      kristaps  433: \&.I
1.4       kristaps  434: foo
1.32      kristaps  435: .Ed
                    436: .
                    437: .Pp
1.20      kristaps  438: is equivalent to
1.32      kristaps  439: .Sq \&.I foo .
1.44      kristaps  440: If next-line macros are invoked consecutively, only the last is used; in
                    441: other words, if a next-line macro is preceded by a block macro, it is
                    442: ignored.
1.32      kristaps  443: .Bd -literal -offset indent
1.22      kristaps  444: \&.YO \(lBbody...\(rB
                    445: \(lBbody...\(rB
1.32      kristaps  446: .Ed
                    447: .
                    448: .Pp
                    449: .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"
                    450: .It Em Macro Ta Em Arguments Ta Em Scope
1.39      kristaps  451: .It Sx \&B   Ta    n         Ta    next-line
                    452: .It Sx \&BI  Ta    n         Ta    current
                    453: .It Sx \&BR  Ta    n         Ta    current
                    454: .It Sx \&DT  Ta    0         Ta    current
                    455: .It Sx \&I   Ta    n         Ta    next-line
                    456: .It Sx \&IB  Ta    n         Ta    current
                    457: .It Sx \&IR  Ta    n         Ta    current
1.40      kristaps  458: .It Sx \&PD  Ta    n         Ta    current
1.39      kristaps  459: .It Sx \&R   Ta    n         Ta    next-line
                    460: .It Sx \&RB  Ta    n         Ta    current
                    461: .It Sx \&RI  Ta    n         Ta    current
                    462: .It Sx \&SB  Ta    n         Ta    next-line
                    463: .It Sx \&SM  Ta    n         Ta    next-line
                    464: .It Sx \&TH  Ta    >1, <6    Ta    current
                    465: .It Sx \&UC  Ta    n         Ta    current
                    466: .It Sx \&br  Ta    0         Ta    current
                    467: .It Sx \&fi  Ta    0         Ta    current
                    468: .It Sx \&i   Ta    n         Ta    current
                    469: .It Sx \&na  Ta    0         Ta    current
                    470: .It Sx \&nf  Ta    0         Ta    current
                    471: .It Sx \&r   Ta    0         Ta    current
                    472: .It Sx \&sp  Ta    1         Ta    current
1.32      kristaps  473: .El
                    474: .
                    475: .Pp
1.31      kristaps  476: The
1.40      kristaps  477: .Sx \&PD ,
1.39      kristaps  478: .Sx \&RS ,
                    479: .Sx \&RE ,
                    480: .Sx \&UC ,
                    481: .Sx \&br ,
                    482: .Sx \&fi ,
                    483: .Sx \&i ,
                    484: .Sx \&na ,
                    485: .Sx \&nf ,
                    486: .Sx \&r ,
1.22      kristaps  487: and
1.39      kristaps  488: .Sx \&sp
1.36      kristaps  489: macros should not be used.  They're included for compatibility.
1.28      kristaps  490: .
                    491: .
1.32      kristaps  492: .Ss Block Macros
1.30      kristaps  493: Block macros are comprised of a head and body.  Like for in-line macros,
                    494: the head is scoped to the current line and, in one circumstance, the
                    495: next line; the body is scoped to subsequent lines and is closed out by a
                    496: subsequent block macro invocation.
1.32      kristaps  497: .Bd -literal -offset indent
1.22      kristaps  498: \&.YO \(lBhead...\(rB
                    499: \(lBhead...\(rB
                    500: \(lBbody...\(rB
1.32      kristaps  501: .Ed
                    502: .
                    503: .Pp
1.30      kristaps  504: The closure of body scope may be to the section, where a macro is closed
                    505: by
1.39      kristaps  506: .Sx \&SH ;
1.30      kristaps  507: sub-section, closed by a section or
1.39      kristaps  508: .Sx \&SS ;
1.30      kristaps  509: part, closed by a section, sub-section, or
1.39      kristaps  510: .Sx \&RE ;
1.30      kristaps  511: or paragraph, closed by a section, sub-section, part,
1.39      kristaps  512: .Sx \&HP ,
                    513: .Sx \&IP ,
                    514: .Sx \&LP ,
                    515: .Sx \&P ,
                    516: .Sx \&PP ,
1.30      kristaps  517: or
1.39      kristaps  518: .Sx \&TP .
1.30      kristaps  519: No closure refers to an explicit block closing macro.
1.32      kristaps  520: .
                    521: .Pp
                    522: .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent
                    523: .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope
1.39      kristaps  524: .It Sx \&HP  Ta    <2        Ta    current    Ta    paragraph
                    525: .It Sx \&IP  Ta    <3        Ta    current    Ta    paragraph
                    526: .It Sx \&LP  Ta    0         Ta    current    Ta    paragraph
                    527: .It Sx \&P   Ta    0         Ta    current    Ta    paragraph
                    528: .It Sx \&PP  Ta    0         Ta    current    Ta    paragraph
                    529: .It Sx \&RE  Ta    0         Ta    current    Ta    none
                    530: .It Sx \&RS  Ta    1         Ta    current    Ta    part
                    531: .It Sx \&SH  Ta    >0        Ta    next-line  Ta    section
                    532: .It Sx \&SS  Ta    >0        Ta    next-line  Ta    sub-section
                    533: .It Sx \&TP  Ta    n         Ta    next-line  Ta    paragraph
1.32      kristaps  534: .El
                    535: .
                    536: .Pp
1.22      kristaps  537: If a block macro is next-line scoped, it may only be followed by in-line
                    538: macros (excluding
1.39      kristaps  539: .Sx \&DT ,
1.40      kristaps  540: .Sx \&PD ,
1.39      kristaps  541: .Sx \&TH ,
                    542: .Sx \&UC ,
                    543: .Sx \&br ,
                    544: .Sx \&na ,
                    545: .Sx \&sp ,
                    546: .Sx \&nf ,
1.22      kristaps  547: and
1.39      kristaps  548: .Sx \&fi ) .
1.28      kristaps  549: .
                    550: .
1.22      kristaps  551: .Sh REFERENCE
                    552: This section is a canonical reference to all macros, arranged
                    553: alphabetically.  For the scoping of individual macros, see
1.32      kristaps  554: .Sx MACRO SYNTAX .
1.28      kristaps  555: .
1.44      kristaps  556: .
1.39      kristaps  557: .Ss \&B
1.22      kristaps  558: Text is rendered in bold face.
1.44      kristaps  559: .Pp
                    560: See also
                    561: .Sx \&I ,
                    562: .Sx \&R ,
                    563: .Sx \&b ,
                    564: .Sx \&i ,
                    565: and
                    566: .Sx \&r .
                    567: .
                    568: .
1.39      kristaps  569: .Ss \&BI
1.22      kristaps  570: Text is rendered alternately in bold face and italic.  Thus,
1.32      kristaps  571: .Sq .BI this word and that
1.22      kristaps  572: causes
1.32      kristaps  573: .Sq this
1.22      kristaps  574: and
1.32      kristaps  575: .Sq and
1.22      kristaps  576: to render in bold face, while
1.32      kristaps  577: .Sq word
1.22      kristaps  578: and
1.32      kristaps  579: .Sq that
1.22      kristaps  580: render in italics.  Whitespace between arguments is omitted in output.
1.44      kristaps  581: .Pp
                    582: Examples:
1.46      kristaps  583: .Pp
                    584: .D1 \&.BI bold italic bold italic
1.44      kristaps  585: .Pp
                    586: The output of this example will be emboldened
                    587: .Dq bold
                    588: and italicised
                    589: .Dq italic ,
                    590: with spaces stripped between arguments.
                    591: .Pp
                    592: See also
                    593: .Sx \&IB ,
                    594: .Sx \&BR ,
                    595: .Sx \&RB ,
                    596: .Sx \&RI ,
                    597: and
                    598: .Sx \&IR .
                    599: .
                    600: .
1.39      kristaps  601: .Ss \&BR
1.22      kristaps  602: Text is rendered alternately in bold face and roman (the default font).
                    603: Whitespace between arguments is omitted in output.
1.44      kristaps  604: .Pp
                    605: See
                    606: .Sx \&BI
                    607: for an equivalent example.
                    608: .Pp
                    609: See also
                    610: .Sx \&BI ,
                    611: .Sx \&IB ,
                    612: .Sx \&RB ,
                    613: .Sx \&RI ,
                    614: and
                    615: .Sx \&IR .
                    616: .
                    617: .
1.39      kristaps  618: .Ss \&DT
1.36      kristaps  619: Has no effect.  Included for compatibility.
1.44      kristaps  620: .
                    621: .
1.39      kristaps  622: .Ss \&HP
1.23      kristaps  623: Begin a paragraph whose initial output line is left-justified, but
1.27      kristaps  624: subsequent output lines are indented, with the following syntax:
1.44      kristaps  625: .Bd -filled -offset indent
                    626: .Pf \. Sx \&HP
                    627: .Op Cm width
1.32      kristaps  628: .Ed
1.44      kristaps  629: .Pp
                    630: The
                    631: .Cm width
                    632: argument must conform to
                    633: .Sx Scaling Widths .
                    634: If specified, it's saved for later paragraph left-margins; if unspecified, the
                    635: saved or default width is used.
                    636: .Pp
                    637: See also
1.45      kristaps  638: .Sx \&IP ,
                    639: .Sx \&LP ,
                    640: .Sx \&P ,
                    641: .Sx \&PP ,
1.44      kristaps  642: and
1.45      kristaps  643: .Sx \&TP .
1.44      kristaps  644: .
1.32      kristaps  645: .
1.39      kristaps  646: .Ss \&I
1.22      kristaps  647: Text is rendered in italics.
1.44      kristaps  648: .Pp
                    649: See also
                    650: .Sx \&B ,
                    651: .Sx \&R ,
                    652: .Sx \&b ,
                    653: .Sx \&i ,
                    654: and
                    655: .Sx \&r .
                    656: .
                    657: .
1.39      kristaps  658: .Ss \&IB
1.22      kristaps  659: Text is rendered alternately in italics and bold face.  Whitespace
                    660: between arguments is omitted in output.
1.44      kristaps  661: .Pp
                    662: See
                    663: .Sx \&BI
                    664: for an equivalent example.
                    665: .Pp
                    666: See also
                    667: .Sx \&BI ,
                    668: .Sx \&BR ,
                    669: .Sx \&RB ,
                    670: .Sx \&RI ,
                    671: and
                    672: .Sx \&IR .
                    673: .
                    674: .
1.39      kristaps  675: .Ss \&IP
1.44      kristaps  676: Begin an indented paragraph with the following syntax:
                    677: .Bd -filled -offset indent
                    678: .Pf \. Sx \&IP
                    679: .Op Cm head Op Cm width
1.32      kristaps  680: .Ed
1.44      kristaps  681: .Pp
                    682: The
                    683: .Cm width
                    684: argument defines the width of the left margin and is defined by
                    685: .Sx Scaling Widths ,
                    686: It's saved for later paragraph left-margins; if unspecified, the saved or
                    687: default width is used.
                    688: .Pp
                    689: The
                    690: .Cm head
                    691: argument is used as a leading term, flushed to the left margin.  This is
                    692: useful for bulleted paragraphs and so on.
                    693: .Pp
                    694: See also
1.45      kristaps  695: .Sx \&HP ,
                    696: .Sx \&LP ,
                    697: .Sx \&P ,
                    698: .Sx \&PP ,
1.44      kristaps  699: and
1.45      kristaps  700: .Sx \&TP .
1.44      kristaps  701: .
1.32      kristaps  702: .
1.39      kristaps  703: .Ss \&IR
1.22      kristaps  704: Text is rendered alternately in italics and roman (the default font).
                    705: Whitespace between arguments is omitted in output.
1.44      kristaps  706: .Pp
                    707: See
                    708: .Sx \&BI
                    709: for an equivalent example.
                    710: .Pp
                    711: See also
                    712: .Sx \&BI ,
                    713: .Sx \&IB ,
                    714: .Sx \&BR ,
                    715: .Sx \&RB ,
                    716: and
                    717: .Sx \&RI .
                    718: .
                    719: .
1.39      kristaps  720: .Ss \&LP
1.22      kristaps  721: Begin an undecorated paragraph.  The scope of a paragraph is closed by a
1.27      kristaps  722: subsequent paragraph, sub-section, section, or end of file.  The saved
                    723: paragraph left-margin width is re-set to the default.
1.44      kristaps  724: .Pp
                    725: See also
1.45      kristaps  726: .Sx \&HP ,
                    727: .Sx \&IP ,
                    728: .Sx \&P ,
                    729: .Sx \&PP ,
1.44      kristaps  730: and
1.45      kristaps  731: .Sx \&TP .
1.44      kristaps  732: .
                    733: .
1.39      kristaps  734: .Ss \&P
                    735: Synonym for
                    736: .Sx \&LP .
1.44      kristaps  737: .Pp
                    738: See also
1.45      kristaps  739: .Sx \&HP ,
                    740: .Sx \&IP ,
                    741: .Sx \&LP ,
                    742: .Sx \&PP ,
1.44      kristaps  743: and
1.45      kristaps  744: .Sx \&TP .
1.44      kristaps  745: .
                    746: .
1.39      kristaps  747: .Ss \&PP
                    748: Synonym for
                    749: .Sx \&LP .
1.44      kristaps  750: .Pp
                    751: See also
1.45      kristaps  752: .Sx \&HP ,
                    753: .Sx \&IP ,
                    754: .Sx \&LP ,
                    755: .Sx \&P ,
1.44      kristaps  756: and
1.45      kristaps  757: .Sx \&TP .
1.44      kristaps  758: .
                    759: .
1.39      kristaps  760: .Ss \&R
1.22      kristaps  761: Text is rendered in roman (the default font).
1.44      kristaps  762: .Pp
                    763: See also
                    764: .Sx \&I ,
                    765: .Sx \&B ,
                    766: .Sx \&b ,
                    767: .Sx \&i ,
                    768: and
                    769: .Sx \&r .
                    770: .
                    771: .
1.39      kristaps  772: .Ss \&RB
1.22      kristaps  773: Text is rendered alternately in roman (the default font) and bold face.
                    774: Whitespace between arguments is omitted in output.
1.44      kristaps  775: .Pp
                    776: See
                    777: .Sx \&BI
                    778: for an equivalent example.
                    779: .Pp
                    780: See also
                    781: .Sx \&BI ,
                    782: .Sx \&IB ,
                    783: .Sx \&BR ,
                    784: .Sx \&RI ,
                    785: and
                    786: .Sx \&IR .
                    787: .
                    788: .
1.39      kristaps  789: .Ss \&RE
1.30      kristaps  790: Explicitly close out the scope of a prior
1.39      kristaps  791: .Sx \&RS .
1.44      kristaps  792: .
                    793: .
1.39      kristaps  794: .Ss \&RI
1.22      kristaps  795: Text is rendered alternately in roman (the default font) and italics.
                    796: Whitespace between arguments is omitted in output.
1.44      kristaps  797: .Pp
                    798: See
                    799: .Sx \&BI
                    800: for an equivalent example.
                    801: .Pp
                    802: See also
                    803: .Sx \&BI ,
                    804: .Sx \&IB ,
                    805: .Sx \&BR ,
                    806: .Sx \&RB ,
                    807: and
                    808: .Sx \&IR .
                    809: .
                    810: .
1.39      kristaps  811: .Ss \&RS
1.30      kristaps  812: Begin a part setting the left margin.  The left margin controls the
                    813: offset, following an initial indentation, to un-indented text such as
                    814: that of
1.39      kristaps  815: .Sx \&PP .
1.44      kristaps  816: This has the following syntax:
                    817: .Bd -filled -offset indent
                    818: .Pf \. Sx \&Rs
                    819: .Op Cm width
1.32      kristaps  820: .Ed
1.44      kristaps  821: .Pp
                    822: The
                    823: .Cm width
                    824: argument must conform to
                    825: .Sx Scaling Widths .
                    826: If not specified, the saved or default width is used.
                    827: .
1.32      kristaps  828: .
1.39      kristaps  829: .Ss \&SB
1.22      kristaps  830: Text is rendered in small size (one point smaller than the default font)
                    831: bold face.
1.44      kristaps  832: .
                    833: .
1.39      kristaps  834: .Ss \&SH
1.22      kristaps  835: Begin a section.  The scope of a section is only closed by another
1.27      kristaps  836: section or the end of file.  The paragraph left-margin width is re-set
                    837: to the default.
1.44      kristaps  838: .
                    839: .
1.39      kristaps  840: .Ss \&SM
1.22      kristaps  841: Text is rendered in small size (one point smaller than the default
                    842: font).
1.44      kristaps  843: .
                    844: .
1.39      kristaps  845: .Ss \&SS
1.22      kristaps  846: Begin a sub-section.  The scope of a sub-section is closed by a
1.27      kristaps  847: subsequent sub-section, section, or end of file.  The paragraph
                    848: left-margin width is re-set to the default.
1.44      kristaps  849: .
                    850: .
1.39      kristaps  851: .Ss \&TH
1.22      kristaps  852: Sets the title of the manual page with the following syntax:
1.44      kristaps  853: .Bd -filled -offset indent
                    854: .Pf \. Sx \&TH
                    855: .Cm title section
                    856: .Op Cm date Op Cm source Op Cm volume
                    857: .Ed
1.43      kristaps  858: .Pp
                    859: At least the upper-case document title
                    860: .Cm title
                    861: and numeric manual section
1.44      kristaps  862: .Cm section
1.43      kristaps  863: arguments must be provided.  The
                    864: .Cm date
                    865: argument should be formatted as described in
                    866: .Sx Dates :
                    867: if it does not conform, the current date is used instead.  The
1.44      kristaps  868: .Cm source
1.43      kristaps  869: string specifies the organisation providing the utility.  The
1.44      kristaps  870: .Cm volume
1.43      kristaps  871: string replaces the default rendered volume, which is dictated by the
                    872: manual section.
                    873: .Pp
                    874: Examples:
1.46      kristaps  875: .Pp
                    876: .D1 \&.TH CVS 5 "1992-02-12" GNU
1.32      kristaps  877: .
1.44      kristaps  878: .
1.39      kristaps  879: .Ss \&TP
1.25      kristaps  880: Begin a paragraph where the head, if exceeding the indentation width, is
1.24      kristaps  881: followed by a newline; if not, the body follows on the same line after a
1.25      kristaps  882: buffer to the indentation width.  Subsequent output lines are indented.
1.44      kristaps  883: The syntax is as follows:
                    884: .Bd -filled -offset indent
                    885: .Pf \. Sx \&TP
                    886: .Op Cm width
1.32      kristaps  887: .Ed
                    888: .Pp
1.44      kristaps  889: The
                    890: .Cm width
                    891: argument must conform to
                    892: .Sx Scaling Widths .
                    893: If specified, it's saved for later paragraph left-margins; if
1.27      kristaps  894: unspecified, the saved or default width is used.
1.44      kristaps  895: .Pp
                    896: See also
1.45      kristaps  897: .Sx \&HP ,
                    898: .Sx \&IP ,
                    899: .Sx \&LP ,
                    900: .Sx \&P ,
1.44      kristaps  901: and
1.45      kristaps  902: .Sx \&PP .
1.44      kristaps  903: .
                    904: .
1.40      kristaps  905: .Ss \&PD
                    906: Has no effect.  Included for compatibility.
1.44      kristaps  907: .
                    908: .
1.39      kristaps  909: .Ss \&UC
1.37      kristaps  910: Has no effect.  Included for compatibility.
1.44      kristaps  911: .
                    912: .
1.39      kristaps  913: .Ss \&br
1.22      kristaps  914: Breaks the current line.  Consecutive invocations have no further effect.
1.44      kristaps  915: .Pp
                    916: See also
                    917: .Sx \&sp .
                    918: .
                    919: .
1.39      kristaps  920: .Ss \&fi
1.22      kristaps  921: End literal mode begun by
1.39      kristaps  922: .Sx \&nf .
1.44      kristaps  923: .
                    924: .
1.39      kristaps  925: .Ss \&i
1.22      kristaps  926: Italicise arguments.  If no arguments are specified, all subsequent text
                    927: is italicised.
1.44      kristaps  928: .Pp
                    929: See also
                    930: .Sx \&B ,
                    931: .Sx \&I ,
                    932: .Sx \&R .
                    933: .Sx \&b ,
                    934: and
                    935: .Sx \&r .
                    936: .
                    937: .
1.39      kristaps  938: .Ss \&na
1.36      kristaps  939: Don't align to the right margin.
1.44      kristaps  940: .
                    941: .
1.39      kristaps  942: .Ss \&nf
1.22      kristaps  943: Begin literal mode: all subsequent free-form lines have their end of
                    944: line boundaries preserved.  May be ended by
1.39      kristaps  945: .Sx \&fi .
1.44      kristaps  946: .
                    947: .
1.39      kristaps  948: .Ss \&r
1.22      kristaps  949: Fonts and styles (bold face, italics) reset to roman (default font).
1.44      kristaps  950: .Pp
                    951: See also
                    952: .Sx \&B ,
                    953: .Sx \&I ,
                    954: .Sx \&R ,
                    955: .Sx \&b ,
                    956: and
                    957: .Sx \&i .
                    958: .
                    959: .
1.39      kristaps  960: .Ss \&sp
1.44      kristaps  961: Insert vertical spaces into output with the following syntax:
                    962: .Bd -filled -offset indent
                    963: .Pf \. Sx \&sp
                    964: .Op Cm height
                    965: .Ed
                    966: .Pp
                    967: Insert
                    968: .Cm height
                    969: spaces, which must conform to
                    970: .Sx Scaling Widths .
                    971: If 0, this is equivalent to the
1.39      kristaps  972: .Sx \&br
1.44      kristaps  973: macro.  Defaults to 1, if unspecified.
                    974: .Pp
                    975: See also
                    976: .Sx \&br .
1.28      kristaps  977: .
                    978: .
1.18      kristaps  979: .Sh COMPATIBILITY
1.23      kristaps  980: This section documents compatibility with other roff implementations, at
                    981: this time limited to
1.32      kristaps  982: .Xr groff 1 .
                    983: .Bl -hyphen
                    984: .It
1.23      kristaps  985: In quoted literals, groff allowed pair-wise double-quotes to produce a
                    986: standalone double-quote in formatted output.  This idiosyncratic
                    987: behaviour is no longer applicable.
1.32      kristaps  988: .It
1.23      kristaps  989: The
1.32      kristaps  990: .Sq sp
1.23      kristaps  991: macro does not accept negative numbers.
1.32      kristaps  992: .It
1.23      kristaps  993: Blocks of whitespace are stripped from both macro and free-form text
                    994: lines (except when in literal mode), while groff would retain whitespace
                    995: in free-form text lines.
1.32      kristaps  996: .El
1.28      kristaps  997: .
                    998: .
1.1       kristaps  999: .Sh SEE ALSO
1.32      kristaps 1000: .Xr mandoc 1 ,
                   1001: .Xr mandoc_char 7
1.28      kristaps 1002: .
                   1003: .
1.1       kristaps 1004: .Sh AUTHORS
                   1005: The
1.32      kristaps 1006: .Nm
1.23      kristaps 1007: reference was written by
1.32      kristaps 1008: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.28      kristaps 1009: .
                   1010: .
1.1       kristaps 1011: .Sh CAVEATS
                   1012: Do not use this language.  Use
1.32      kristaps 1013: .Xr mdoc 7 ,
1.1       kristaps 1014: instead.
1.28      kristaps 1015: .

CVSweb