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

Diff for /mandoc/man.7 between version 1.135 and 1.144

version 1.135, 2017/05/07 21:44:49 version 1.144, 2019/07/09 03:46:59
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2011-2015 Ingo Schwarze <schwarze@openbsd.org>  .\" Copyright (c) 2011-2015,2017,2018,2019 Ingo Schwarze <schwarze@openbsd.org>
   .\" Copyright (c) 2017 Anthony Bentley <bentley@openbsd.org>
 .\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>  .\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
Line 23 
Line 24 
 .Nm man  .Nm man
 .Nd legacy formatting language for manual pages  .Nd legacy formatting language for manual pages
 .Sh DESCRIPTION  .Sh DESCRIPTION
 Traditionally, the  The
 .Nm man  .Nm man
 language has been used to write  language was the standard formatting language for
 .Ux  .At
 manuals for the  manual pages from 1979 to 1989.
 .Xr man 1  Do not use it to write new manual pages: it is a purely presentational
 utility.  language and lacks support for semantic markup.
 It supports limited control of presentational details like fonts,  
 indentation and spacing.  
 This reference document describes the structure of manual pages  
 and the syntax and usage of the man language.  
 .Pp  
 .Bf -emphasis  
 Do not use  
 .Nm  
 to write your manuals:  
 .Ef  
 It lacks support for semantic markup.  
 Use the  Use the
 .Xr mdoc 7  .Xr mdoc 7
 language, instead.  language, instead.
Line 53  are called
Line 43  are called
 .Dq macro lines .  .Dq macro lines .
 The first word is the macro name.  The first word is the macro name.
 It usually consists of two capital letters.  It usually consists of two capital letters.
 For a list of available macros, see  For a list of portable macros, see
 .Sx MACRO OVERVIEW .  .Sx MACRO OVERVIEW .
 The words following the macro name are arguments to the macro.  The words following the macro name are arguments to the macro.
 .Pp  .Pp
Line 78  sections in the
Line 68  sections in the
 .Xr roff 7  .Xr roff 7
 manual for details, in particular regarding  manual for details, in particular regarding
 comments, escape sequences, whitespace, and quoting.  comments, escape sequences, whitespace, and quoting.
 .Sh MANUAL STRUCTURE  .Pp
 Each  Each
 .Nm  .Nm
 document must contain the  document starts with the
 .Sx \&TH  .Ic TH
 macro describing the document's section and title.  macro specifying the document's name and section, followed by the
 It may occur anywhere in the document, although conventionally it  .Sx NAME
 appears as the first macro.  section formatted as follows:
 .Pp  
 Beyond  
 .Sx \&TH ,  
 at least one macro or text line must appear in the document.  
 .Pp  
 The following is a well-formed skeleton  
 .Nm  
 file for a utility  
 .Qq progname :  
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.TH PROGNAME 1 2009-10-10  \&.TH PROGNAME 1 1979-01-10
 \&.SH NAME  \&.SH NAME
 \efBprogname\efR \e(en one line about what it does  \efBprogname\efR \e(en one line about what it does
 \&.\e\(dq .SH LIBRARY  
 \&.\e\(dq For sections 2, 3, and 9 only.  
 \&.\e\(dq Not used in OpenBSD.  
 \&.SH SYNOPSIS  
 \efBprogname\efR [\efB\e-options\efR] \efIfile ...\efR  
 \&.SH DESCRIPTION  
 The \efBfoo\efR utility processes files ...  
 \&.\e\(dq .Sh CONTEXT  
 \&.\e\(dq For section 9 functions only.  
 \&.\e\(dq .SH IMPLEMENTATION NOTES  
 \&.\e\(dq Not used in OpenBSD.  
 \&.\e\(dq .SH RETURN VALUES  
 \&.\e\(dq For sections 2, 3, and 9 function return values only.  
 \&.\e\(dq .SH ENVIRONMENT  
 \&.\e\(dq For sections 1, 6, 7, and 8 only.  
 \&.\e\(dq .SH FILES  
 \&.\e\(dq .SH EXIT STATUS  
 \&.\e\(dq For sections 1, 6, and 8 only.  
 \&.\e\(dq .SH EXAMPLES  
 \&.\e\(dq .SH DIAGNOSTICS  
 \&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.  
 \&.\e\(dq .SH ERRORS  
 \&.\e\(dq For sections 2, 3, 4, and 9 errno settings only.  
 \&.\e\(dq .SH SEE ALSO  
 \&.\e\(dq .BR foobar ( 1 )  
 \&.\e\(dq .SH STANDARDS  
 \&.\e\(dq .SH HISTORY  
 \&.\e\(dq .SH AUTHORS  
 \&.\e\(dq .SH CAVEATS  
 \&.\e\(dq .SH BUGS  
 \&.\e\(dq .SH SECURITY CONSIDERATIONS  
 \&.\e\(dq Not used in OpenBSD.  
 .Ed  .Ed
 .Pp  
 The sections in a  
 .Nm  
 document are conventionally ordered as they appear above.  
 Sections should be composed as follows:  
 .Bl -ohang -offset indent  
 .It Em NAME  
 The name(s) and a short description of the documented material.  
 The syntax for this is generally as follows:  
 .Pp  
 .D1 \efBname\efR \e(en description  
 .It Em LIBRARY  
 The name of the library containing the documented material, which is  
 assumed to be a function in a section 2 or 3 manual.  
 For functions in the C library, this may be as follows:  
 .Pp  
 .D1 Standard C Library (libc, -lc)  
 .It Em SYNOPSIS  
 Documents the utility invocation syntax, function call syntax, or device  
 configuration.  
 .Pp  
 For the first, utilities (sections 1, 6, and 8), this is  
 generally structured as follows:  
 .Pp  
 .D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR...  
 .Pp  
 For the second, function calls (sections 2, 3, 9):  
 .Pp  
 .D1 \&.B char *name(char *\efIarg\efR);  
 .Pp  
 And for the third, configurations (section 4):  
 .Pp  
 .D1 \&.B name* at cardbus ? function ?  
 .Pp  
 Manuals not in these sections generally don't need a  
 .Em SYNOPSIS .  
 .It Em DESCRIPTION  
 This expands upon the brief, one-line description in  
 .Em NAME .  
 It usually contains a break-down of the options (if documenting a  
 command).  
 .It Em CONTEXT  
 This section lists the contexts in which functions can be called in section 9.  
 The contexts are autoconf, process, or interrupt.  
 .It Em IMPLEMENTATION NOTES  
 Implementation-specific notes should be kept here.  
 This is useful when implementing standard functions that may have side  
 effects or notable algorithmic implications.  
 .It Em RETURN VALUES  
 This section documents the return values of functions in sections 2, 3, and 9.  
 .It Em ENVIRONMENT  
 Documents any usages of environment variables, e.g.,  
 .Xr environ 7 .  
 .It Em FILES  
 Documents files used.  
 It's helpful to document both the file name and a short description of how  
 the file is used (created, modified, etc.).  
 .It Em EXIT STATUS  
 This section documents the command exit status for  
 section 1, 6, and 8 utilities.  
 Historically, this information was described in  
 .Em DIAGNOSTICS ,  
 a practise that is now discouraged.  
 .It Em EXAMPLES  
 Example usages.  
 This often contains snippets of well-formed,  
 well-tested invocations.  
 Make sure that examples work properly!  
 .It Em DIAGNOSTICS  
 Documents error conditions.  
 In section 4 and 9 manuals, these are usually messages  
 printed by the kernel to the console and to the kernel log.  
 In section 1, 6, 7, and 8, these are usually messages  
 printed by userland programs to the standard error output.  
 .Pp  
 Historically, this section was used in place of  
 .Em EXIT STATUS  
 for manuals in sections 1, 6, and 8; however, this practise is  
 discouraged.  
 .It Em ERRORS  
 Documents  
 .Xr errno 2  
 settings in sections 2, 3, 4, and 9.  
 .It Em SEE ALSO  
 References other manuals with related topics.  
 This section should exist for most manuals.  
 .Pp  
 .D1 \&.BR bar \&( 1 \&),  
 .Pp  
 Cross-references should conventionally be ordered  
 first by section, then alphabetically.  
 .It Em STANDARDS  
 References any standards implemented or used, such as  
 .Pp  
 .D1 IEEE Std 1003.2 (\e(lqPOSIX.2\e(rq)  
 .Pp  
 If not adhering to any standards, the  
 .Em HISTORY  
 section should be used.  
 .It Em HISTORY  
 A brief history of the subject, including where support first appeared.  
 .It Em AUTHORS  
 Credits to the person or persons who wrote the code and/or documentation.  
 Authors should generally be noted by both name and email address.  
 .It Em CAVEATS  
 Common misuses and misunderstandings should be explained  
 in this section.  
 .It Em BUGS  
 Known bugs, limitations, and work-arounds should be described  
 in this section.  
 .It Em SECURITY CONSIDERATIONS  
 Documents any security precautions that operators should consider.  
 .El  
 .Sh MACRO OVERVIEW  .Sh MACRO OVERVIEW
 This overview is sorted such that macros of similar purpose are listed  This overview is sorted such that macros of similar purpose are listed
 together, to help find the best macro for any given purpose.  together.
 Deprecated macros are not included in the overview, but can be found  Deprecated and non-portable macros are not included in the overview,
 in the alphabetical reference below.  but can be found in the alphabetical reference below.
 .Ss Page header and footer meta-data  .Ss Page header and footer meta-data
 .Bl -column "PP, LP, P" description  .Bl -column "RS, RE" description
 .It Sx TH Ta set the title: Ar title section date Op Ar source Op Ar volume  .It Ic TH Ta set the title: Ar name section date Op Ar source Op Ar volume
 .It Sx AT Ta display AT&T UNIX version in the page footer (<= 1 argument)  .It Ic AT Ta display AT&T UNIX version in the page footer (<= 1 argument)
 .It Sx UC Ta display BSD version in the page footer (<= 1 argument)  .It Ic UC Ta display BSD version in the page footer (<= 1 argument)
 .El  .El
 .Ss Sections and paragraphs  .Ss Sections and paragraphs
 .Bl -column "PP, LP, P" description  .Bl -column "RS, RE" description
 .It Sx SH Ta section header (one line)  .It Ic SH Ta section header (one line)
 .It Sx SS Ta subsection header (one line)  .It Ic SS Ta subsection header (one line)
 .It Sx PP , LP , P Ta start an undecorated paragraph (no arguments)  .It Ic PP Ta start an undecorated paragraph (no arguments)
 .It Sx RS , RE Ta reset the left margin: Op Ar width  .It Ic RS , RE Ta reset the left margin: Op Ar width
 .It Sx IP Ta indented paragraph: Op Ar head Op Ar width  .It Ic IP Ta indented paragraph: Op Ar head Op Ar width
 .It Sx TP Ta tagged paragraph: Op Ar width  .It Ic TP Ta tagged paragraph: Op Ar width
 .It Sx HP Ta hanged paragraph: Op Ar width  .It Ic PD Ta set vertical paragraph distance: Op Ar height
 .It Sx PD Ta set vertical paragraph distance: Op Ar height  .It Ic in Ta additional indent: Op Ar width
 .It Sx fi , nf Ta fill mode and no-fill mode (no arguments)  
 .It Sx in Ta additional indent: Op Ar width  
 .El  .El
 .Ss Physical markup  .Ss Physical markup
 .Bl -column "PP, LP, P" description  .Bl -column "RS, RE" description
 .It Sx B Ta boldface font  .It Ic B Ta boldface font
 .It Sx I Ta italic font  .It Ic I Ta italic font
 .It Sx R Ta roman (default) font  .It Ic SB Ta small boldface font
 .It Sx SB Ta small boldface font  .It Ic SM Ta small roman font
 .It Sx SM Ta small roman font  .It Ic BI Ta alternate between boldface and italic fonts
 .It Sx BI Ta alternate between boldface and italic fonts  .It Ic BR Ta alternate between boldface and roman fonts
 .It Sx BR Ta alternate between boldface and roman fonts  .It Ic IB Ta alternate between italic and boldface fonts
 .It Sx IB Ta alternate between italic and boldface fonts  .It Ic IR Ta alternate between italic and roman fonts
 .It Sx IR Ta alternate between italic and roman fonts  .It Ic RB Ta alternate between roman and boldface fonts
 .It Sx RB Ta alternate between roman and boldface fonts  .It Ic RI Ta alternate between roman and italic fonts
 .It Sx RI Ta alternate between roman and italic fonts  
 .El  .El
 .Sh MACRO REFERENCE  .Sh MACRO REFERENCE
 This section is a canonical reference to all macros, arranged  This section is a canonical reference to all macros, arranged
 alphabetically.  alphabetically.
 For the scoping of individual macros, see  For the scoping of individual macros, see
 .Sx MACRO SYNTAX .  .Sx MACRO SYNTAX .
 .Ss \&AT  .Bl -tag -width 3n
   .It Ic AT
 Sets the volume for the footer for compatibility with man pages from  Sets the volume for the footer for compatibility with man pages from
 .At  .At
 releases.  releases.
 The optional arguments specify which release it is from.  The optional arguments specify which release it is from.
 .Ss \&B  .It Ic B
 Text is rendered in bold face.  Text is rendered in bold face.
 .Pp  .It Ic BI
 See also  
 .Sx \&I  
 and  
 .Sx \&R .  
 .Ss \&BI  
 Text is rendered alternately in bold face and italic.  Text is rendered alternately in bold face and italic.
 Thus,  Thus,
 .Sq .BI this word and that  .Sq .BI this word and that
Line 315  and
Line 144  and
 render in italics.  render in italics.
 Whitespace between arguments is omitted in output.  Whitespace between arguments is omitted in output.
 .Pp  .Pp
 Examples:  Example:
 .Pp  .Pp
 .Dl \&.BI bold italic bold italic  .Dl \&.BI bold italic bold italic
 .Pp  .It Ic BR
 The output of this example will be emboldened  
 .Dq bold  
 and italicised  
 .Dq italic ,  
 with spaces stripped between arguments.  
 .Pp  
 See also  
 .Sx \&IB ,  
 .Sx \&BR ,  
 .Sx \&RB ,  
 .Sx \&RI ,  
 and  
 .Sx \&IR .  
 .Ss \&BR  
 Text is rendered alternately in bold face and roman (the default font).  Text is rendered alternately in bold face and roman (the default font).
 Whitespace between arguments is omitted in output.  Whitespace between arguments is omitted in output.
 .Pp  
 See  
 .Sx \&BI  
 for an equivalent example.  
 .Pp  
 See also  See also
 .Sx \&BI ,  .Ic BI .
 .Sx \&IB ,  .It Ic DT
 .Sx \&RB ,  
 .Sx \&RI ,  
 and  
 .Sx \&IR .  
 .Ss \&DT  
 Restore the default tabulator positions.  Restore the default tabulator positions.
 They are at intervals of 0.5 inches.  They are at intervals of 0.5 inches.
 This has no effect unless the tabulator positions were changed with the  This has no effect unless the tabulator positions were changed with the
 .Xr roff 7  .Xr roff 7
 .Ic \&ta  .Ic ta
 request.  request.
 .Ss \&EE  .It Ic EE
 This is a non-standard GNU extension, included only for compatibility.  This is a non-standard Version 9
   .At
   extension later adopted by GNU.
 In  In
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 it does the same as  it does the same as the
 .Sx \&fi .  .Xr roff 7
 .Ss \&EX  .Ic fi
 This is a non-standard GNU extension, included only for compatibility.  request (switch to fill mode).
   .It Ic EX
   This is a non-standard Version 9
   .At
   extension later adopted by GNU.
 In  In
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 it does the same as  it does the same as the
 .Sx \&nf .  .Xr roff 7
 .Ss \&HP  .Ic nf
   request (switch to no-fill mode).
   .It Ic HP
 Begin a paragraph whose initial output line is left-justified, but  Begin a paragraph whose initial output line is left-justified, but
 subsequent output lines are indented, with the following syntax:  subsequent output lines are indented, with the following syntax:
 .Bd -filled -offset indent  
 .Pf \. Sx \&HP  
 .Op Ar width  
 .Ed  
 .Pp  .Pp
   .D1 Pf . Ic HP Op Ar width
   .Pp
 The  The
 .Ar width  .Ar width
 argument is a  argument is a
 .Xr roff 7  .Xr roff 7
 scaling width.  scaling width.
 If specified, it's saved for later paragraph left-margins; if unspecified, the  If specified, it's saved for later paragraph left margins;
 saved or default width is used.  if unspecified, the saved or default width is used.
 .Pp  .Pp
 See also  This macro is portable, but deprecated
 .Sx \&IP ,  because it has no good representation in HTML output,
 .Sx \&LP ,  usually ending up indistinguishable from
 .Sx \&P ,  .Ic PP .
 .Sx \&PP ,  .It Ic I
 and  
 .Sx \&TP .  
 .Ss \&I  
 Text is rendered in italics.  Text is rendered in italics.
 .Pp  .It Ic IB
 See also  
 .Sx \&B  
 and  
 .Sx \&R .  
 .Ss \&IB  
 Text is rendered alternately in italics and bold face.  Text is rendered alternately in italics and bold face.
 Whitespace between arguments is omitted in output.  Whitespace between arguments is omitted in output.
 .Pp  
 See  
 .Sx \&BI  
 for an equivalent example.  
 .Pp  
 See also  See also
 .Sx \&BI ,  .Ic BI .
 .Sx \&BR ,  .It Ic IP
 .Sx \&RB ,  
 .Sx \&RI ,  
 and  
 .Sx \&IR .  
 .Ss \&IP  
 Begin an indented paragraph with the following syntax:  Begin an indented paragraph with the following syntax:
 .Bd -filled -offset indent  
 .Pf \. Sx \&IP  
 .Op Ar head Op Ar width  
 .Ed  
 .Pp  .Pp
   .D1 Pf . Ic IP Op Ar head Op Ar width
   .Pp
 The  The
 .Ar width  .Ar width
 argument is a  argument is a
Line 430  The
Line 221  The
 .Ar head  .Ar head
 argument is used as a leading term, flushed to the left margin.  argument is used as a leading term, flushed to the left margin.
 This is useful for bulleted paragraphs and so on.  This is useful for bulleted paragraphs and so on.
 .Pp  .It Ic IR
 See also  
 .Sx \&HP ,  
 .Sx \&LP ,  
 .Sx \&P ,  
 .Sx \&PP ,  
 and  
 .Sx \&TP .  
 .Ss \&IR  
 Text is rendered alternately in italics and roman (the default font).  Text is rendered alternately in italics and roman (the default font).
 Whitespace between arguments is omitted in output.  Whitespace between arguments is omitted in output.
 .Pp  
 See  
 .Sx \&BI  
 for an equivalent example.  
 .Pp  
 See also  See also
 .Sx \&BI ,  .Ic BI .
 .Sx \&IB ,  .It Ic LP
 .Sx \&BR ,  A synonym for
 .Sx \&RB ,  .Ic PP .
 and  .It Ic ME
 .Sx \&RI .  End a mailto block started with
 .Ss \&LP  .Ic MT .
 Begin an undecorated paragraph.  This is a non-standard GNU extension.
 The scope of a paragraph is closed by a subsequent paragraph,  .It Ic MT
 sub-section, section, or end of file.  Begin a mailto block.
 The saved paragraph left-margin width is reset to the default.  This is a non-standard GNU extension.
 .Pp  
 See also  
 .Sx \&HP ,  
 .Sx \&IP ,  
 .Sx \&P ,  
 .Sx \&PP ,  
 and  
 .Sx \&TP .  
 .Ss \&OP  
 Optional command-line argument.  
 This is a non-standard GNU extension, included only for compatibility.  
 It has the following syntax:  It has the following syntax:
 .Bd -filled -offset indent  .Bd -unfilled -offset indent
 .Pf \. Sx \&OP  .Pf . Ic MT Ar address
 .Ar key Op Ar value  link description to be shown
   .Pf . Ic ME
 .Ed  .Ed
   .It Ic OP
   Optional command-line argument.
   This is a non-standard GNU extension.
   It has the following syntax:
 .Pp  .Pp
   .D1 Pf . Ic OP Ar key Op Ar value
   .Pp
 The  The
 .Ar key  .Ar key
 is usually a command-line flag and  is usually a command-line flag and
 .Ar value  .Ar value
 its argument.  its argument.
 .Ss \&P  .It Ic P
 Synonym for  A synonym for
 .Sx \&LP .  .Ic PP .
 .Pp  .It Ic PD
 See also  
 .Sx \&HP ,  
 .Sx \&IP ,  
 .Sx \&LP ,  
 .Sx \&PP ,  
 and  
 .Sx \&TP .  
 .Ss \&PD  
 Specify the vertical space to be inserted before each new paragraph.  Specify the vertical space to be inserted before each new paragraph.
 .br  .br
 The syntax is as follows:  The syntax is as follows:
 .Bd -filled -offset indent  
 .Pf \. Sx \&PD  
 .Op Ar height  
 .Ed  
 .Pp  .Pp
   .D1 Pf . Ic PD Op Ar height
   .Pp
 The  The
 .Ar height  .Ar height
 argument is a  argument is a
Line 512  If the unit is omitted,
Line 276  If the unit is omitted,
 is assumed.  is assumed.
 .Pp  .Pp
 This macro affects the spacing before any subsequent instances of  This macro affects the spacing before any subsequent instances of
 .Sx \&HP ,  .Ic HP ,
 .Sx \&IP ,  .Ic IP ,
 .Sx \&LP ,  .Ic LP ,
 .Sx \&P ,  .Ic P ,
 .Sx \&PP ,  .Ic PP ,
 .Sx \&SH ,  .Ic SH ,
 .Sx \&SS ,  .Ic SS ,
   .Ic SY ,
 and  and
 .Sx \&TP .  .Ic TP .
 .Ss \&PP  .It Ic PP
 Synonym for  Begin an undecorated paragraph.
 .Sx \&LP .  The scope of a paragraph is closed by a subsequent paragraph,
 .Pp  sub-section, section, or end of file.
 See also  The saved paragraph left-margin width is reset to the default.
 .Sx \&HP ,  .It Ic RB
 .Sx \&IP ,  
 .Sx \&LP ,  
 .Sx \&P ,  
 and  
 .Sx \&TP .  
 .Ss \&R  
 Text is rendered in roman (the default font).  
 .Pp  
 See also  
 .Sx \&I  
 and  
 .Sx \&B .  
 .Ss \&RB  
 Text is rendered alternately in roman (the default font) and bold face.  Text is rendered alternately in roman (the default font) and bold face.
 Whitespace between arguments is omitted in output.  Whitespace between arguments is omitted in output.
 .Pp  
 See  
 .Sx \&BI  
 for an equivalent example.  
 .Pp  
 See also  See also
 .Sx \&BI ,  .Ic BI .
 .Sx \&IB ,  .It Ic RE
 .Sx \&BR ,  
 .Sx \&RI ,  
 and  
 .Sx \&IR .  
 .Ss \&RE  
 Explicitly close out the scope of a prior  Explicitly close out the scope of a prior
 .Sx \&RS .  .Ic RS .
 The default left margin is restored to the state before that  The default left margin is restored to the state before that
 .Sx \&RS  .Ic RS
 invocation.  invocation.
 .Pp  .Pp
 The syntax is as follows:  The syntax is as follows:
 .Bd -filled -offset indent  
 .Pf \. Sx \&RE  
 .Op Ar level  
 .Ed  
 .Pp  .Pp
   .D1 Pf . Ic RE Op Ar level
   .Pp
 Without an argument, the most recent  Without an argument, the most recent
 .Sx \&RS  .Ic RS
 block is closed out.  block is closed out.
 If  If
 .Ar level  .Ar level
 is 1, all open  is 1, all open
 .Sx \&RS  .Ic RS
 blocks are closed out.  blocks are closed out.
 Otherwise,  Otherwise,
 .Ar level No \(mi 1  .Ar level No \(mi 1
 nested  nested
 .Sx \&RS  .Ic RS
 blocks remain open.  blocks remain open.
 .Ss \&RI  .It Ic RI
 Text is rendered alternately in roman (the default font) and italics.  Text is rendered alternately in roman (the default font) and italics.
 Whitespace between arguments is omitted in output.  Whitespace between arguments is omitted in output.
 .Pp  
 See  
 .Sx \&BI  
 for an equivalent example.  
 .Pp  
 See also  See also
 .Sx \&BI ,  .Ic BI .
 .Sx \&IB ,  .It Ic RS
 .Sx \&BR ,  
 .Sx \&RB ,  
 and  
 .Sx \&IR .  
 .Ss \&RS  
 Temporarily reset the default left margin.  Temporarily reset the default left margin.
 This has the following syntax:  This has the following syntax:
 .Bd -filled -offset indent  
 .Pf \. Sx \&RS  
 .Op Ar width  
 .Ed  
 .Pp  .Pp
   .D1 Pf . Ic RS Op Ar width
   .Pp
 The  The
 .Ar width  .Ar width
 argument is a  argument is a
Line 611  scaling width.
Line 339  scaling width.
 If not specified, the saved or default width is used.  If not specified, the saved or default width is used.
 .Pp  .Pp
 See also  See also
 .Sx \&RE .  .Ic RE .
 .Ss \&SB  .It Ic SB
 Text is rendered in small size (one point smaller than the default font)  Text is rendered in small size (one point smaller than the default font)
 bold face.  bold face.
 .Ss \&SH  .It Ic SH
 Begin a section.  Begin a section.
 The scope of a section is only closed by another section or the end of  The scope of a section is only closed by another section or the end of
 file.  file.
 The paragraph left-margin width is reset to the default.  The paragraph left-margin width is reset to the default.
 .Ss \&SM  .It Ic SM
 Text is rendered in small size (one point smaller than the default  Text is rendered in small size (one point smaller than the default
 font).  font).
 .Ss \&SS  .It Ic SS
 Begin a sub-section.  Begin a sub-section.
 The scope of a sub-section is closed by a subsequent sub-section,  The scope of a sub-section is closed by a subsequent sub-section,
 section, or end of file.  section, or end of file.
 The paragraph left-margin width is reset to the default.  The paragraph left-margin width is reset to the default.
 .Ss \&TH  .It Ic SY
 Sets the title of the manual page for use in the page header  Begin a synopsis block with the following syntax:
 and footer with the following syntax:  .Bd -unfilled -offset indent
 .Bd -filled -offset indent  .Pf . Ic SY Ar command
 .Pf \. Sx \&TH  .Ar arguments
 .Ar title section date  .Pf . Ic YS
 .Op Ar source Op Ar volume  
 .Ed  .Ed
 .Pp  .Pp
   This is a non-standard GNU extension
   and very rarely used even in GNU manual pages.
   Formatting is similar to
   .Ic IP .
   .It Ic TH
   Set the name of the manual page for use in the page header
   and footer with the following syntax:
   .Pp
   .D1 Pf . Ic TH Ar name section date Op Ar source Op Ar volume
   .Pp
 Conventionally, the document  Conventionally, the document
 .Ar title  .Ar name
 is given in all caps.  is given in all caps.
   The
   .Ar section
   is usually a single digit, in a few cases followed by a letter.
 The recommended  The recommended
 .Ar date  .Ar date
 format is  format is
Line 659  uses its
Line 399  uses its
 argument.  argument.
 The  The
 .Ar volume  .Ar volume
 string replaces the default rendered volume, which is dictated by the  string replaces the default volume title of the
 manual section.  .Ar section .
 .Pp  .Pp
 Examples:  Examples:
 .Pp  .Pp
 .Dl \&.TH CVS 5 "1992-02-12" GNU  .Dl \&.TH CVS 5 "1992-02-12" GNU
 .Ss \&TP  .It Ic TP
 Begin a paragraph where the head, if exceeding the indentation width, is  Begin a paragraph where the head, if exceeding the indentation width, is
 followed by a newline; if not, the body follows on the same line after a  followed by a newline; if not, the body follows on the same line after
 buffer to the indentation width.  advancing to the indentation width.
 Subsequent output lines are indented.  Subsequent output lines are indented.
 The syntax is as follows:  The syntax is as follows:
 .Bd -filled -offset indent  .Bd -unfilled -offset indent
 .Pf \. Sx \&TP  .Pf . Ic TP Op Ar width
 .Op Ar width  .Ar head No \e" one line
   .Ar body
 .Ed  .Ed
 .Pp  .Pp
 The  The
Line 683  argument is a
Line 424  argument is a
 scaling width.  scaling width.
 If specified, it's saved for later paragraph left-margins; if  If specified, it's saved for later paragraph left-margins; if
 unspecified, the saved or default width is used.  unspecified, the saved or default width is used.
 .Pp  .It Ic TQ
 See also  Like
 .Sx \&HP ,  .Ic TP ,
 .Sx \&IP ,  except that no vertical spacing is inserted before the paragraph.
 .Sx \&LP ,  This is a non-standard GNU extension
 .Sx \&P ,  and very rarely used even in GNU manual pages.
 and  .It Ic UC
 .Sx \&PP .  
 .Ss \&UC  
 Sets the volume for the footer for compatibility with man pages from  Sets the volume for the footer for compatibility with man pages from
 .Bx  .Bx
 releases.  releases.
 The optional first argument specifies which release it is from.  The optional first argument specifies which release it is from.
 .Ss \&UE  .It Ic UE
 End a uniform resource identifier block.  End a uniform resource identifier block started with
 This is a non-standard GNU extension, included only for compatibility.  .Ic UR .
 See  This is a non-standard GNU extension.
 .Sx \&UE .  .It Ic UR
 .Ss \&UR  
 Begin a uniform resource identifier block.  Begin a uniform resource identifier block.
 This is a non-standard GNU extension, included only for compatibility.  This is a non-standard GNU extension.
 It has the following syntax:  It has the following syntax:
 .Bd -literal -offset indent  .Bd -unfilled -offset indent
 .Pf \. Sx \&UR Ar uri  .Pf . Ic UR Ar uri
 link description to be shown  link description to be shown
 .Pf \. Sx UE  .Pf . Ic UE
 .Ed  .Ed
 .Ss \&fi  .It Ic YS
 End literal mode begun by  End a synopsis block started with
 .Sx \&nf .  .Ic SY .
 .Ss \&in  This is a non-standard GNU extension.
   .It Ic in
 Indent relative to the current indentation:  Indent relative to the current indentation:
 .Pp  .Pp
 .D1 Pf \. Sx \&in Op Ar width  .D1 Pf . Ic in Op Ar width
 .Pp  .Pp
 If  If
 .Ar width  .Ar width
 is signed, the new offset is relative.  is signed, the new offset is relative.
 Otherwise, it is absolute.  Otherwise, it is absolute.
 This value is reset upon the next paragraph, section, or sub-section.  This value is reset upon the next paragraph, section, or sub-section.
 .Ss \&nf  .El
 Begin literal mode: all subsequent free-form lines have their end of  
 line boundaries preserved.  
 May be ended by  
 .Sx \&fi .  
 Literal mode is implicitly ended by  
 .Sx \&SH  
 or  
 .Sx \&SS .  
 .Sh MACRO SYNTAX  .Sh MACRO SYNTAX
 The  The
 .Nm  .Nm
Line 752  foo
Line 483  foo
 .Ed  .Ed
 .Pp  .Pp
 is equivalent to  is equivalent to
 .Sq \&.I foo .  .Sq .I foo .
 If next-line macros are invoked consecutively, only the last is used.  If next-line macros are invoked consecutively, only the last is used.
 If a next-line macro is followed by a non-next-line macro, an error is  If a next-line macro is followed by a non-next-line macro, an error is
 raised.  raised.
Line 764  The syntax is as follows:
Line 495  The syntax is as follows:
 .Ed  .Ed
 .Bl -column "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" -offset indent  .Bl -column "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" -offset indent
 .It Em Macro Ta Em Arguments Ta Em Scope     Ta Em Notes  .It Em Macro Ta Em Arguments Ta Em Scope     Ta Em Notes
 .It Sx \&AT  Ta    <=1       Ta    current   Ta    \&  .It Ic AT  Ta    <=1       Ta    current   Ta    \&
 .It Sx \&B   Ta    n         Ta    next-line Ta    \&  .It Ic B   Ta    n         Ta    next-line Ta    \&
 .It Sx \&BI  Ta    n         Ta    current   Ta    \&  .It Ic BI  Ta    n         Ta    current   Ta    \&
 .It Sx \&BR  Ta    n         Ta    current   Ta    \&  .It Ic BR  Ta    n         Ta    current   Ta    \&
 .It Sx \&DT  Ta    0         Ta    current   Ta    \&  .It Ic DT  Ta    0         Ta    current   Ta    \&
 .It Sx \&EE  Ta    0         Ta    current   Ta    compat  .It Ic EE  Ta    0         Ta    current   Ta    Version 9 At
 .It Sx \&EX  Ta    0         Ta    current   Ta    compat  .It Ic EX  Ta    0         Ta    current   Ta    Version 9 At
 .It Sx \&I   Ta    n         Ta    next-line Ta    \&  .It Ic I   Ta    n         Ta    next-line Ta    \&
 .It Sx \&IB  Ta    n         Ta    current   Ta    \&  .It Ic IB  Ta    n         Ta    current   Ta    \&
 .It Sx \&IR  Ta    n         Ta    current   Ta    \&  .It Ic IR  Ta    n         Ta    current   Ta    \&
 .It Sx \&OP  Ta    0, 1      Ta    current   Ta    compat  .It Ic OP  Ta    >=1       Ta    current   Ta    GNU
 .It Sx \&PD  Ta    1         Ta    current   Ta    \&  .It Ic PD  Ta    1         Ta    current   Ta    \&
 .It Sx \&R   Ta    n         Ta    next-line Ta    \&  .It Ic RB  Ta    n         Ta    current   Ta    \&
 .It Sx \&RB  Ta    n         Ta    current   Ta    \&  .It Ic RI  Ta    n         Ta    current   Ta    \&
 .It Sx \&RI  Ta    n         Ta    current   Ta    \&  .It Ic SB  Ta    n         Ta    next-line Ta    \&
 .It Sx \&SB  Ta    n         Ta    next-line Ta    \&  .It Ic SM  Ta    n         Ta    next-line Ta    \&
 .It Sx \&SM  Ta    n         Ta    next-line Ta    \&  .It Ic TH  Ta    >1, <6    Ta    current   Ta    \&
 .It Sx \&TH  Ta    >1, <6    Ta    current   Ta    \&  .It Ic UC  Ta    <=1       Ta    current   Ta    \&
 .It Sx \&UC  Ta    <=1       Ta    current   Ta    \&  .It Ic in  Ta    1         Ta    current   Ta    Xr roff 7
 .It Sx \&fi  Ta    0         Ta    current   Ta    compat  
 .It Sx \&in  Ta    1         Ta    current   Ta    compat  
 .It Sx \&nf  Ta    0         Ta    current   Ta    compat  
 .El  .El
 .Pp  
 Macros marked as  
 .Qq compat  
 are included for compatibility with the significant corpus of existing  
 manuals that mix dialects of roff.  
 These macros should not be used for portable  
 .Nm  
 manuals.  
 .Ss Block Macros  .Ss Block Macros
 Block macros comprise a head and body.  Block macros comprise a head and body.
 As with in-line macros, the head is scoped to the current line and, in  As with in-line macros, the head is scoped to the current line and, in
Line 811  The syntax is as follows:
Line 531  The syntax is as follows:
 .Pp  .Pp
 The closure of body scope may be to the section, where a macro is closed  The closure of body scope may be to the section, where a macro is closed
 by  by
 .Sx \&SH ;  .Ic SH ;
 sub-section, closed by a section or  sub-section, closed by a section or
 .Sx \&SS ;  .Ic SS ;
 part, closed by a section, sub-section, or  or paragraph, closed by a section, sub-section,
 .Sx \&RE ;  .Ic HP ,
 or paragraph, closed by a section, sub-section, part,  .Ic IP ,
 .Sx \&HP ,  .Ic LP ,
 .Sx \&IP ,  .Ic P ,
 .Sx \&LP ,  .Ic PP ,
 .Sx \&P ,  .Ic RE ,
 .Sx \&PP ,  .Ic SY ,
 or  or
 .Sx \&TP .  .Ic TP .
 No closure refers to an explicit block closing macro.  No closure refers to an explicit block closing macro.
 .Pp  .Pp
 As a rule, block macros may not be nested; thus, calling a block macro  As a rule, block macros may not be nested; thus, calling a block macro
Line 831  while another block macro scope is open, and the open 
Line 551  while another block macro scope is open, and the open 
 implicitly closed, is syntactically incorrect.  implicitly closed, is syntactically incorrect.
 .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" -offset indent  .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" -offset indent
 .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope  Ta Em Notes  .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope  Ta Em Notes
 .It Sx \&HP  Ta    <2        Ta    current    Ta    paragraph   Ta    \&  .It Ic HP  Ta    <2        Ta    current    Ta    paragraph   Ta    \&
 .It Sx \&IP  Ta    <3        Ta    current    Ta    paragraph   Ta    \&  .It Ic IP  Ta    <3        Ta    current    Ta    paragraph   Ta    \&
 .It Sx \&LP  Ta    0         Ta    current    Ta    paragraph   Ta    \&  .It Ic LP  Ta    0         Ta    current    Ta    paragraph   Ta    \&
 .It Sx \&P   Ta    0         Ta    current    Ta    paragraph   Ta    \&  .It Ic ME  Ta    0         Ta    none       Ta    none        Ta    GNU
 .It Sx \&PP  Ta    0         Ta    current    Ta    paragraph   Ta    \&  .It Ic MT  Ta    1         Ta    current    Ta    to \&ME     Ta    GNU
 .It Sx \&RE  Ta    0         Ta    current    Ta    none        Ta    compat  .It Ic P   Ta    0         Ta    current    Ta    paragraph   Ta    \&
 .It Sx \&RS  Ta    1         Ta    current    Ta    part        Ta    compat  .It Ic PP  Ta    0         Ta    current    Ta    paragraph   Ta    \&
 .It Sx \&SH  Ta    >0        Ta    next-line  Ta    section     Ta    \&  .It Ic RE  Ta    <=1       Ta    current    Ta    none        Ta    \&
 .It Sx \&SS  Ta    >0        Ta    next-line  Ta    sub-section Ta    \&  .It Ic RS  Ta    1         Ta    current    Ta    to \&RE     Ta    \&
 .It Sx \&TP  Ta    n         Ta    next-line  Ta    paragraph   Ta    \&  .It Ic SH  Ta    >0        Ta    next-line  Ta    section     Ta    \&
 .It Sx \&UE  Ta    0         Ta    current    Ta    none        Ta    compat  .It Ic SS  Ta    >0        Ta    next-line  Ta    sub-section Ta    \&
 .It Sx \&UR  Ta    1         Ta    current    Ta    part        Ta    compat  .It Ic SY  Ta    1         Ta    current    Ta    to \&YS     Ta    GNU
   .It Ic TP  Ta    n         Ta    next-line  Ta    paragraph   Ta    \&
   .It Ic TQ  Ta    n         Ta    next-line  Ta    paragraph   Ta    GNU
   .It Ic UE  Ta    0         Ta    current    Ta    none        Ta    GNU
   .It Ic UR  Ta    1         Ta    current    Ta    part        Ta    GNU
   .It Ic YS  Ta    0         Ta    none       Ta    none        Ta    GNU
 .El  .El
 .Pp  .Pp
 Macros marked  
 .Qq compat  
 are as mentioned in  
 .Sx Line Macros .  
 .Pp  
 If a block macro is next-line scoped, it may only be followed by in-line  If a block macro is next-line scoped, it may only be followed by in-line
 macros for decorating text.  macros for decorating text.
 .Ss Font handling  .Ss Font handling
Line 865  In text lines, the effect of manual font selection by 
Line 585  In text lines, the effect of manual font selection by 
 only lasts until the next macro invocation; in macro lines, it only lasts  only lasts until the next macro invocation; in macro lines, it only lasts
 until the end of the macro scope.  until the end of the macro scope.
 Note that macros like  Note that macros like
 .Sx \&BR  .Ic BR
 open and close a font scope for each argument.  open and close a font scope for each argument.
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr man 1 ,  .Xr man 1 ,
Line 894  This
Line 614  This
 .Nm  .Nm
 reference was written by  reference was written by
 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
 .Sh CAVEATS  
 Do not use this language.  
 Use  
 .Xr mdoc 7 ,  
 instead.  
Legend:
Removed from v.1.135  
changed lines
  Added in v.1.144
CVSweb