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

Annotation of mandoc/man.7, Revision 1.72

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

CVSweb