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

Annotation of mandoc/man.7, Revision 1.82

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

CVSweb