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

Annotation of mandoc/man.7, Revision 1.143

1.143   ! schwarze    1: .\"    $Id: man.7,v 1.142 2019/01/01 03:45:29 schwarze Exp $
1.1       kristaps    2: .\"
1.115     schwarze    3: .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.142     schwarze    4: .\" Copyright (c) 2011-2015,2017,2018,2019 Ingo Schwarze <schwarze@openbsd.org>
1.139     schwarze    5: .\" Copyright (c) 2017 Anthony Bentley <bentley@openbsd.org>
1.122     schwarze    6: .\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
1.1       kristaps    7: .\"
                      8: .\" Permission to use, copy, modify, and distribute this software for any
1.10      kristaps    9: .\" purpose with or without fee is hereby granted, provided that the above
                     10: .\" copyright notice and this permission notice appear in all copies.
                     11: .\"
                     12: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     13: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     14: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     15: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     16: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     17: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     18: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   19: .\"
1.143   ! schwarze   20: .Dd $Mdocdate: January 1 2019 $
1.9       kristaps   21: .Dt MAN 7
1.1       kristaps   22: .Os
                     23: .Sh NAME
1.32      kristaps   24: .Nm man
1.111     schwarze   25: .Nd legacy formatting language for manual pages
1.1       kristaps   26: .Sh DESCRIPTION
1.140     schwarze   27: The
1.32      kristaps   28: .Nm man
1.140     schwarze   29: language was the standard formatting language for
                     30: .At
                     31: manual pages from 1979 to 1989.
                     32: Do not use it to write new manual pages: it is a purely presentational
                     33: language and lacks support for semantic markup.
1.19      kristaps   34: Use the
1.32      kristaps   35: .Xr mdoc 7
1.1       kristaps   36: language, instead.
1.32      kristaps   37: .Pp
1.111     schwarze   38: In a
1.32      kristaps   39: .Nm
1.111     schwarze   40: document, lines beginning with the control character
1.32      kristaps   41: .Sq \&.
1.111     schwarze   42: are called
                     43: .Dq macro lines .
                     44: The first word is the macro name.
                     45: It usually consists of two capital letters.
1.140     schwarze   46: For a list of portable macros, see
1.111     schwarze   47: .Sx MACRO OVERVIEW .
                     48: The words following the macro name are arguments to the macro.
                     49: .Pp
                     50: Lines not beginning with the control character are called
                     51: .Dq text lines .
                     52: They provide free-form text to be printed; the formatting of the text
                     53: depends on the respective processing context:
1.32      kristaps   54: .Bd -literal -offset indent
1.1       kristaps   55: \&.SH Macro lines change control state.
1.106     kristaps   56: Text lines are interpreted within the current state.
1.32      kristaps   57: .Ed
1.103     kristaps   58: .Pp
1.111     schwarze   59: Many aspects of the basic syntax of the
1.103     kristaps   60: .Nm
1.111     schwarze   61: language are based on the
                     62: .Xr roff 7
                     63: language; see the
                     64: .Em LANGUAGE SYNTAX
1.106     kristaps   65: and
1.111     schwarze   66: .Em MACRO SYNTAX
                     67: sections in the
                     68: .Xr roff 7
                     69: manual for details, in particular regarding
                     70: comments, escape sequences, whitespace, and quoting.
1.140     schwarze   71: .Pp
1.16      kristaps   72: Each
1.32      kristaps   73: .Nm
1.140     schwarze   74: document starts with the
1.143   ! schwarze   75: .Ic TH
1.140     schwarze   76: macro specifying the document's name and section, followed by the
                     77: .Sx NAME
                     78: section formatted as follows:
1.32      kristaps   79: .Bd -literal -offset indent
1.140     schwarze   80: \&.TH PROGNAME 1 1979-01-10
1.22      kristaps   81: \&.SH NAME
1.124     schwarze   82: \efBprogname\efR \e(en one line about what it does
1.32      kristaps   83: .Ed
1.110     schwarze   84: .Sh MACRO OVERVIEW
                     85: This overview is sorted such that macros of similar purpose are listed
1.140     schwarze   86: together.
                     87: Deprecated and non-portable macros are not included in the overview,
                     88: but can be found in the alphabetical reference below.
1.110     schwarze   89: .Ss Page header and footer meta-data
1.140     schwarze   90: .Bl -column "RS, RE" description
1.143   ! schwarze   91: .It Ic TH Ta set the title: Ar name section date Op Ar source Op Ar volume
        !            92: .It Ic AT Ta display AT&T UNIX version in the page footer (<= 1 argument)
        !            93: .It Ic UC Ta display BSD version in the page footer (<= 1 argument)
1.110     schwarze   94: .El
                     95: .Ss Sections and paragraphs
1.140     schwarze   96: .Bl -column "RS, RE" description
1.143   ! schwarze   97: .It Ic SH Ta section header (one line)
        !            98: .It Ic SS Ta subsection header (one line)
        !            99: .It Ic PP Ta start an undecorated paragraph (no arguments)
        !           100: .It Ic RS , RE Ta reset the left margin: Op Ar width
        !           101: .It Ic IP Ta indented paragraph: Op Ar head Op Ar width
        !           102: .It Ic TP Ta tagged paragraph: Op Ar width
        !           103: .It Ic PD Ta set vertical paragraph distance: Op Ar height
        !           104: .It Ic in Ta additional indent: Op Ar width
1.110     schwarze  105: .El
                    106: .Ss Physical markup
1.140     schwarze  107: .Bl -column "RS, RE" description
1.143   ! schwarze  108: .It Ic B Ta boldface font
        !           109: .It Ic I Ta italic font
        !           110: .It Ic SB Ta small boldface font
        !           111: .It Ic SM Ta small roman font
        !           112: .It Ic BI Ta alternate between boldface and italic fonts
        !           113: .It Ic BR Ta alternate between boldface and roman fonts
        !           114: .It Ic IB Ta alternate between italic and boldface fonts
        !           115: .It Ic IR Ta alternate between italic and roman fonts
        !           116: .It Ic RB Ta alternate between roman and boldface fonts
        !           117: .It Ic RI Ta alternate between roman and italic fonts
1.110     schwarze  118: .El
1.111     schwarze  119: .Sh MACRO REFERENCE
1.22      kristaps  120: This section is a canonical reference to all macros, arranged
1.68      kristaps  121: alphabetically.
                    122: For the scoping of individual macros, see
1.32      kristaps  123: .Sx MACRO SYNTAX .
1.143   ! schwarze  124: .Bl -tag -width 3n
        !           125: .It Ic AT
1.72      joerg     126: Sets the volume for the footer for compatibility with man pages from
1.123     schwarze  127: .At
1.72      joerg     128: releases.
                    129: The optional arguments specify which release it is from.
1.143   ! schwarze  130: .It Ic B
1.22      kristaps  131: Text is rendered in bold face.
1.143   ! schwarze  132: .It Ic BI
1.68      kristaps  133: Text is rendered alternately in bold face and italic.
                    134: Thus,
1.32      kristaps  135: .Sq .BI this word and that
1.22      kristaps  136: causes
1.32      kristaps  137: .Sq this
1.22      kristaps  138: and
1.32      kristaps  139: .Sq and
1.55      kristaps  140: to render in bold face, while
1.32      kristaps  141: .Sq word
1.22      kristaps  142: and
1.32      kristaps  143: .Sq that
1.68      kristaps  144: render in italics.
                    145: Whitespace between arguments is omitted in output.
1.44      kristaps  146: .Pp
1.140     schwarze  147: Example:
1.46      kristaps  148: .Pp
1.93      kristaps  149: .Dl \&.BI bold italic bold italic
1.143   ! schwarze  150: .It Ic BR
1.22      kristaps  151: Text is rendered alternately in bold face and roman (the default font).
                    152: Whitespace between arguments is omitted in output.
1.44      kristaps  153: See also
1.143   ! schwarze  154: .Ic BI .
        !           155: .It Ic DT
1.135     schwarze  156: Restore the default tabulator positions.
                    157: They are at intervals of 0.5 inches.
                    158: This has no effect unless the tabulator positions were changed with the
                    159: .Xr roff 7
1.143   ! schwarze  160: .Ic ta
1.135     schwarze  161: request.
1.143   ! schwarze  162: .It Ic EE
1.140     schwarze  163: This is a non-standard GNU extension.
1.116     schwarze  164: In
                    165: .Xr mandoc 1 ,
1.142     schwarze  166: it does the same as the
                    167: .Xr roff 7
1.143   ! schwarze  168: .Ic fi
1.142     schwarze  169: request (switch to fill mode).
1.143   ! schwarze  170: .It Ic EX
1.140     schwarze  171: This is a non-standard GNU extension.
1.116     schwarze  172: In
                    173: .Xr mandoc 1 ,
1.142     schwarze  174: it does the same as the
                    175: .Xr roff 7
1.143   ! schwarze  176: .Ic nf
1.142     schwarze  177: request (switch to no-fill mode).
1.143   ! schwarze  178: .It Ic HP
1.23      kristaps  179: Begin a paragraph whose initial output line is left-justified, but
1.27      kristaps  180: subsequent output lines are indented, with the following syntax:
1.143   ! schwarze  181: .Pp
        !           182: .D1 Pf . Ic HP Op Ar width
1.44      kristaps  183: .Pp
                    184: The
1.130     schwarze  185: .Ar width
1.117     schwarze  186: argument is a
                    187: .Xr roff 7
                    188: scaling width.
1.141     schwarze  189: If specified, it's saved for later paragraph left margins;
                    190: if unspecified, the saved or default width is used.
                    191: .Pp
                    192: This macro is portable, but deprecated
                    193: because it has no good representation in HTML output,
                    194: usually ending up indistinguishable from
1.143   ! schwarze  195: .Ic PP .
        !           196: .It Ic I
1.22      kristaps  197: Text is rendered in italics.
1.143   ! schwarze  198: .It Ic IB
1.80      kristaps  199: Text is rendered alternately in italics and bold face.
                    200: Whitespace between arguments is omitted in output.
1.44      kristaps  201: See also
1.143   ! schwarze  202: .Ic BI .
        !           203: .It Ic IP
1.44      kristaps  204: Begin an indented paragraph with the following syntax:
1.143   ! schwarze  205: .Pp
        !           206: .D1 Pf . Ic IP Op Ar head Op Ar width
1.44      kristaps  207: .Pp
                    208: The
1.130     schwarze  209: .Ar width
1.117     schwarze  210: argument is a
                    211: .Xr roff 7
                    212: scaling width defining the left margin.
1.44      kristaps  213: It's saved for later paragraph left-margins; if unspecified, the saved or
                    214: default width is used.
                    215: .Pp
                    216: The
1.130     schwarze  217: .Ar head
1.68      kristaps  218: argument is used as a leading term, flushed to the left margin.
                    219: This is useful for bulleted paragraphs and so on.
1.143   ! schwarze  220: .It Ic IR
1.22      kristaps  221: Text is rendered alternately in italics and roman (the default font).
                    222: Whitespace between arguments is omitted in output.
1.44      kristaps  223: See also
1.143   ! schwarze  224: .Ic BI .
        !           225: .It Ic LP
1.140     schwarze  226: A synonym for
1.143   ! schwarze  227: .Ic PP .
        !           228: .It Ic ME
1.140     schwarze  229: End a mailto block started with
1.143   ! schwarze  230: .Ic MT .
1.140     schwarze  231: This is a non-standard GNU extension.
1.143   ! schwarze  232: .It Ic MT
1.136     schwarze  233: Begin a mailto block.
1.140     schwarze  234: This is a non-standard GNU extension.
1.136     schwarze  235: It has the following syntax:
1.143   ! schwarze  236: .Bd -unfilled -offset indent
        !           237: .Pf . Ic MT Ar address
1.136     schwarze  238: link description to be shown
1.143   ! schwarze  239: .Pf . Ic ME
1.136     schwarze  240: .Ed
1.143   ! schwarze  241: .It Ic OP
1.113     kristaps  242: Optional command-line argument.
1.140     schwarze  243: This is a non-standard GNU extension.
1.114     schwarze  244: It has the following syntax:
1.143   ! schwarze  245: .Pp
        !           246: .D1 Pf . Ic OP Ar key Op Ar value
1.113     kristaps  247: .Pp
                    248: The
1.130     schwarze  249: .Ar key
1.113     kristaps  250: is usually a command-line flag and
1.130     schwarze  251: .Ar value
1.113     kristaps  252: its argument.
1.143   ! schwarze  253: .It Ic P
1.140     schwarze  254: A synonym for
1.143   ! schwarze  255: .Ic PP .
        !           256: .It Ic PD
1.118     schwarze  257: Specify the vertical space to be inserted before each new paragraph.
                    258: .br
                    259: The syntax is as follows:
1.143   ! schwarze  260: .Pp
        !           261: .D1 Pf . Ic PD Op Ar height
1.118     schwarze  262: .Pp
                    263: The
1.130     schwarze  264: .Ar height
1.118     schwarze  265: argument is a
                    266: .Xr roff 7
                    267: scaling width.
                    268: It defaults to
                    269: .Cm 1v .
                    270: If the unit is omitted,
                    271: .Cm v
                    272: is assumed.
                    273: .Pp
                    274: This macro affects the spacing before any subsequent instances of
1.143   ! schwarze  275: .Ic HP ,
        !           276: .Ic IP ,
        !           277: .Ic LP ,
        !           278: .Ic P ,
        !           279: .Ic PP ,
        !           280: .Ic SH ,
        !           281: .Ic SS ,
        !           282: .Ic SY ,
1.44      kristaps  283: and
1.143   ! schwarze  284: .Ic TP .
        !           285: .It Ic PP
1.140     schwarze  286: Begin an undecorated paragraph.
                    287: The scope of a paragraph is closed by a subsequent paragraph,
                    288: sub-section, section, or end of file.
                    289: The saved paragraph left-margin width is reset to the default.
1.143   ! schwarze  290: .It Ic RB
1.22      kristaps  291: Text is rendered alternately in roman (the default font) and bold face.
                    292: Whitespace between arguments is omitted in output.
1.44      kristaps  293: See also
1.143   ! schwarze  294: .Ic BI .
        !           295: .It Ic RE
1.30      kristaps  296: Explicitly close out the scope of a prior
1.143   ! schwarze  297: .Ic RS .
1.129     schwarze  298: The default left margin is restored to the state before that
1.143   ! schwarze  299: .Ic RS
1.102     kristaps  300: invocation.
1.129     schwarze  301: .Pp
                    302: The syntax is as follows:
1.143   ! schwarze  303: .Pp
        !           304: .D1 Pf . Ic RE Op Ar level
1.129     schwarze  305: .Pp
                    306: Without an argument, the most recent
1.143   ! schwarze  307: .Ic RS
1.129     schwarze  308: block is closed out.
                    309: If
                    310: .Ar level
                    311: is 1, all open
1.143   ! schwarze  312: .Ic RS
1.129     schwarze  313: blocks are closed out.
                    314: Otherwise,
                    315: .Ar level No \(mi 1
                    316: nested
1.143   ! schwarze  317: .Ic RS
1.129     schwarze  318: blocks remain open.
1.143   ! schwarze  319: .It Ic RI
1.22      kristaps  320: Text is rendered alternately in roman (the default font) and italics.
                    321: Whitespace between arguments is omitted in output.
1.44      kristaps  322: See also
1.143   ! schwarze  323: .Ic BI .
        !           324: .It Ic RS
1.102     kristaps  325: Temporarily reset the default left margin.
1.44      kristaps  326: This has the following syntax:
1.143   ! schwarze  327: .Pp
        !           328: .D1 Pf . Ic RS Op Ar width
1.44      kristaps  329: .Pp
                    330: The
1.130     schwarze  331: .Ar width
1.117     schwarze  332: argument is a
                    333: .Xr roff 7
                    334: scaling width.
1.55      kristaps  335: If not specified, the saved or default width is used.
1.102     kristaps  336: .Pp
                    337: See also
1.143   ! schwarze  338: .Ic RE .
        !           339: .It Ic SB
1.22      kristaps  340: Text is rendered in small size (one point smaller than the default font)
                    341: bold face.
1.143   ! schwarze  342: .It Ic SH
1.68      kristaps  343: Begin a section.
                    344: The scope of a section is only closed by another section or the end of
                    345: file.
1.78      schwarze  346: The paragraph left-margin width is reset to the default.
1.143   ! schwarze  347: .It Ic SM
1.22      kristaps  348: Text is rendered in small size (one point smaller than the default
                    349: font).
1.143   ! schwarze  350: .It Ic SS
1.68      kristaps  351: Begin a sub-section.
                    352: The scope of a sub-section is closed by a subsequent sub-section,
                    353: section, or end of file.
1.78      schwarze  354: The paragraph left-margin width is reset to the default.
1.143   ! schwarze  355: .It Ic SY
1.139     schwarze  356: Begin a synopsis block with the following syntax:
                    357: .Bd -unfilled -offset indent
1.143   ! schwarze  358: .Pf . Ic SY Ar command
1.139     schwarze  359: .Ar arguments
1.143   ! schwarze  360: .Pf . Ic YS
1.139     schwarze  361: .Ed
                    362: .Pp
                    363: This is a non-standard GNU extension
                    364: and very rarely used even in GNU manual pages.
                    365: Formatting is similar to
1.143   ! schwarze  366: .Ic IP .
        !           367: .It Ic TH
1.140     schwarze  368: Set the name of the manual page for use in the page header
1.128     schwarze  369: and footer with the following syntax:
1.143   ! schwarze  370: .Pp
        !           371: .D1 Pf . Ic TH Ar name section date Op Ar source Op Ar volume
1.43      kristaps  372: .Pp
1.99      schwarze  373: Conventionally, the document
1.140     schwarze  374: .Ar name
1.99      schwarze  375: is given in all caps.
1.141     schwarze  376: The
                    377: .Ar section
                    378: is usually a single digit, in a few cases followed by a letter.
1.99      schwarze  379: The recommended
                    380: .Ar date
                    381: format is
                    382: .Sy YYYY-MM-DD
                    383: as specified in the ISO-8601 standard;
                    384: if the argument does not conform, it is printed verbatim.
                    385: If the
                    386: .Ar date
                    387: is empty or not specified, the current date is used.
                    388: The optional
                    389: .Ar source
1.68      kristaps  390: string specifies the organisation providing the utility.
1.128     schwarze  391: When unspecified,
                    392: .Xr mandoc 1
                    393: uses its
                    394: .Fl Ios
                    395: argument.
1.68      kristaps  396: The
1.99      schwarze  397: .Ar volume
1.141     schwarze  398: string replaces the default volume title of the
                    399: .Ar section .
1.43      kristaps  400: .Pp
                    401: Examples:
1.46      kristaps  402: .Pp
1.93      kristaps  403: .Dl \&.TH CVS 5 "1992-02-12" GNU
1.143   ! schwarze  404: .It Ic TP
1.25      kristaps  405: Begin a paragraph where the head, if exceeding the indentation width, is
1.141     schwarze  406: followed by a newline; if not, the body follows on the same line after
                    407: advancing to the indentation width.
1.68      kristaps  408: Subsequent output lines are indented.
1.44      kristaps  409: The syntax is as follows:
1.141     schwarze  410: .Bd -unfilled -offset indent
1.143   ! schwarze  411: .Pf . Ic TP Op Ar width
1.141     schwarze  412: .Ar head No \e" one line
                    413: .Ar body
1.32      kristaps  414: .Ed
                    415: .Pp
1.44      kristaps  416: The
1.130     schwarze  417: .Ar width
1.117     schwarze  418: argument is a
                    419: .Xr roff 7
                    420: scaling width.
1.44      kristaps  421: If specified, it's saved for later paragraph left-margins; if
1.27      kristaps  422: unspecified, the saved or default width is used.
1.143   ! schwarze  423: .It Ic TQ
1.138     schwarze  424: Like
1.143   ! schwarze  425: .Ic TP ,
1.138     schwarze  426: except that no vertical spacing is inserted before the paragraph.
1.140     schwarze  427: This is a non-standard GNU extension
                    428: and very rarely used even in GNU manual pages.
1.143   ! schwarze  429: .It Ic UC
1.72      joerg     430: Sets the volume for the footer for compatibility with man pages from
1.120     schwarze  431: .Bx
                    432: releases.
1.72      joerg     433: The optional first argument specifies which release it is from.
1.143   ! schwarze  434: .It Ic UE
1.140     schwarze  435: End a uniform resource identifier block started with
1.143   ! schwarze  436: .Ic UR .
1.140     schwarze  437: This is a non-standard GNU extension.
1.143   ! schwarze  438: .It Ic UR
1.121     schwarze  439: Begin a uniform resource identifier block.
1.140     schwarze  440: This is a non-standard GNU extension.
1.121     schwarze  441: It has the following syntax:
1.143   ! schwarze  442: .Bd -unfilled -offset indent
        !           443: .Pf . Ic UR Ar uri
1.121     schwarze  444: link description to be shown
1.143   ! schwarze  445: .Pf . Ic UE
1.121     schwarze  446: .Ed
1.143   ! schwarze  447: .It Ic YS
1.140     schwarze  448: End a synopsis block started with
1.143   ! schwarze  449: .Ic SY .
1.139     schwarze  450: This is a non-standard GNU extension.
1.143   ! schwarze  451: .It Ic in
1.79      kristaps  452: Indent relative to the current indentation:
                    453: .Pp
1.143   ! schwarze  454: .D1 Pf . Ic in Op Ar width
1.79      kristaps  455: .Pp
                    456: If
1.130     schwarze  457: .Ar width
1.79      kristaps  458: is signed, the new offset is relative.
                    459: Otherwise, it is absolute.
                    460: This value is reset upon the next paragraph, section, or sub-section.
1.143   ! schwarze  461: .El
1.111     schwarze  462: .Sh MACRO SYNTAX
                    463: The
                    464: .Nm
                    465: macros are classified by scope: line scope or block scope.
                    466: Line macros are only scoped to the current line (and, in some
                    467: situations, the subsequent line).
                    468: Block macros are scoped to the current line and subsequent lines until
                    469: closed by another block macro.
                    470: .Ss Line Macros
                    471: Line macros are generally scoped to the current line, with the body
                    472: consisting of zero or more arguments.
                    473: If a macro is scoped to the next line and the line arguments are empty,
                    474: the next line, which must be text, is used instead.
                    475: Thus:
                    476: .Bd -literal -offset indent
                    477: \&.I
                    478: foo
                    479: .Ed
                    480: .Pp
                    481: is equivalent to
1.143   ! schwarze  482: .Sq .I foo .
1.111     schwarze  483: If next-line macros are invoked consecutively, only the last is used.
                    484: If a next-line macro is followed by a non-next-line macro, an error is
1.134     schwarze  485: raised.
1.111     schwarze  486: .Pp
                    487: The syntax is as follows:
                    488: .Bd -literal -offset indent
                    489: \&.YO \(lBbody...\(rB
                    490: \(lBbody...\(rB
                    491: .Ed
                    492: .Bl -column "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" -offset indent
                    493: .It Em Macro Ta Em Arguments Ta Em Scope     Ta Em Notes
1.143   ! schwarze  494: .It Ic AT  Ta    <=1       Ta    current   Ta    \&
        !           495: .It Ic B   Ta    n         Ta    next-line Ta    \&
        !           496: .It Ic BI  Ta    n         Ta    current   Ta    \&
        !           497: .It Ic BR  Ta    n         Ta    current   Ta    \&
        !           498: .It Ic DT  Ta    0         Ta    current   Ta    \&
        !           499: .It Ic EE  Ta    0         Ta    current   Ta    GNU
        !           500: .It Ic EX  Ta    0         Ta    current   Ta    GNU
        !           501: .It Ic I   Ta    n         Ta    next-line Ta    \&
        !           502: .It Ic IB  Ta    n         Ta    current   Ta    \&
        !           503: .It Ic IR  Ta    n         Ta    current   Ta    \&
        !           504: .It Ic OP  Ta    >=1       Ta    current   Ta    GNU
        !           505: .It Ic PD  Ta    1         Ta    current   Ta    \&
        !           506: .It Ic RB  Ta    n         Ta    current   Ta    \&
        !           507: .It Ic RI  Ta    n         Ta    current   Ta    \&
        !           508: .It Ic SB  Ta    n         Ta    next-line Ta    \&
        !           509: .It Ic SM  Ta    n         Ta    next-line Ta    \&
        !           510: .It Ic TH  Ta    >1, <6    Ta    current   Ta    \&
        !           511: .It Ic UC  Ta    <=1       Ta    current   Ta    \&
        !           512: .It Ic in  Ta    1         Ta    current   Ta    Xr roff 7
1.111     schwarze  513: .El
                    514: .Ss Block Macros
                    515: Block macros comprise a head and body.
                    516: As with in-line macros, the head is scoped to the current line and, in
                    517: one circumstance, the next line (the next-line stipulations as in
                    518: .Sx Line Macros
                    519: apply here as well).
                    520: .Pp
                    521: The syntax is as follows:
                    522: .Bd -literal -offset indent
                    523: \&.YO \(lBhead...\(rB
                    524: \(lBhead...\(rB
                    525: \(lBbody...\(rB
                    526: .Ed
                    527: .Pp
                    528: The closure of body scope may be to the section, where a macro is closed
                    529: by
1.143   ! schwarze  530: .Ic SH ;
1.111     schwarze  531: sub-section, closed by a section or
1.143   ! schwarze  532: .Ic SS ;
1.140     schwarze  533: or paragraph, closed by a section, sub-section,
1.143   ! schwarze  534: .Ic HP ,
        !           535: .Ic IP ,
        !           536: .Ic LP ,
        !           537: .Ic P ,
        !           538: .Ic PP ,
        !           539: .Ic RE ,
        !           540: .Ic SY ,
1.111     schwarze  541: or
1.143   ! schwarze  542: .Ic TP .
1.111     schwarze  543: No closure refers to an explicit block closing macro.
                    544: .Pp
                    545: As a rule, block macros may not be nested; thus, calling a block macro
                    546: while another block macro scope is open, and the open scope is not
                    547: implicitly closed, is syntactically incorrect.
                    548: .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" -offset indent
                    549: .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope  Ta Em Notes
1.143   ! schwarze  550: .It Ic HP  Ta    <2        Ta    current    Ta    paragraph   Ta    \&
        !           551: .It Ic IP  Ta    <3        Ta    current    Ta    paragraph   Ta    \&
        !           552: .It Ic LP  Ta    0         Ta    current    Ta    paragraph   Ta    \&
        !           553: .It Ic ME  Ta    0         Ta    none       Ta    none        Ta    GNU
        !           554: .It Ic MT  Ta    1         Ta    current    Ta    to \&ME     Ta    GNU
        !           555: .It Ic P   Ta    0         Ta    current    Ta    paragraph   Ta    \&
        !           556: .It Ic PP  Ta    0         Ta    current    Ta    paragraph   Ta    \&
        !           557: .It Ic RE  Ta    <=1       Ta    current    Ta    none        Ta    \&
        !           558: .It Ic RS  Ta    1         Ta    current    Ta    to \&RE     Ta    \&
        !           559: .It Ic SH  Ta    >0        Ta    next-line  Ta    section     Ta    \&
        !           560: .It Ic SS  Ta    >0        Ta    next-line  Ta    sub-section Ta    \&
        !           561: .It Ic SY  Ta    1         Ta    current    Ta    to \&YS     Ta    GNU
        !           562: .It Ic TP  Ta    n         Ta    next-line  Ta    paragraph   Ta    \&
        !           563: .It Ic TQ  Ta    n         Ta    next-line  Ta    paragraph   Ta    GNU
        !           564: .It Ic UE  Ta    0         Ta    current    Ta    none        Ta    GNU
        !           565: .It Ic UR  Ta    1         Ta    current    Ta    part        Ta    GNU
        !           566: .It Ic YS  Ta    0         Ta    none       Ta    none        Ta    GNU
1.111     schwarze  567: .El
                    568: .Pp
                    569: If a block macro is next-line scoped, it may only be followed by in-line
                    570: macros for decorating text.
                    571: .Ss Font handling
                    572: In
                    573: .Nm
                    574: documents, both
                    575: .Sx Physical markup
                    576: macros and
                    577: .Xr roff 7
                    578: .Ql \ef
                    579: font escape sequences can be used to choose fonts.
                    580: In text lines, the effect of manual font selection by escape sequences
                    581: only lasts until the next macro invocation; in macro lines, it only lasts
                    582: until the end of the macro scope.
                    583: Note that macros like
1.143   ! schwarze  584: .Ic BR
1.111     schwarze  585: open and close a font scope for each argument.
1.1       kristaps  586: .Sh SEE ALSO
1.89      schwarze  587: .Xr man 1 ,
1.32      kristaps  588: .Xr mandoc 1 ,
1.98      kristaps  589: .Xr eqn 7 ,
1.89      schwarze  590: .Xr mandoc_char 7 ,
1.94      kristaps  591: .Xr mdoc 7 ,
                    592: .Xr roff 7 ,
                    593: .Xr tbl 7
1.78      schwarze  594: .Sh HISTORY
                    595: The
                    596: .Nm
                    597: language first appeared as a macro package for the roff typesetting
                    598: system in
                    599: .At v7 .
                    600: It was later rewritten by James Clark as a macro package for groff.
1.113     kristaps  601: Eric S. Raymond wrote the extended
                    602: .Nm
                    603: macros for groff in 2007.
1.78      schwarze  604: The stand-alone implementation that is part of the
                    605: .Xr mandoc 1
                    606: utility written by Kristaps Dzonsons appeared in
1.80      kristaps  607: .Ox 4.6 .
1.1       kristaps  608: .Sh AUTHORS
1.78      schwarze  609: This
1.32      kristaps  610: .Nm
1.23      kristaps  611: reference was written by
1.119     schwarze  612: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

CVSweb