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

Annotation of mandoc/man.7, Revision 1.100

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

CVSweb