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

Diff for /mandoc/man.7 between version 1.18 and 1.44

version 1.18, 2009/07/04 09:00:41 version 1.44, 2009/11/02 09:53:15
Line 17 
Line 17 
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt MAN 7  .Dt MAN 7
 .Os  .Os
 .\" SECTION  .
   .
 .Sh NAME  .Sh NAME
 .Nm man  .Nm man
 .Nd man language reference  .Nd man language reference
 .\" SECTION  .
   .
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm man  .Nm man
 language was historically used to format  language was historically used to format
 .Ux  .Ux
 manuals.  This reference document describes the syntax and structure of  manuals.  This reference document describes its syntax, structure, and
 this language.  usage.
   .
 .Pp  .Pp
 .Em \&Do not  .Bf -emphasis
 use  Do not use
 .Nm  .Nm
 to write your manuals.  Use the  to write your manuals.
   .Ef
   Use the
 .Xr mdoc 7  .Xr mdoc 7
 language, instead.  language, instead.
 .\" PARAGRAPH  .
 .Pp  .Pp
 An  An
 .Nm  .Nm
 document follows simple rules:  lines beginning with the control  document follows simple rules:  lines beginning with the control
 character  character
 .Sq \&.  .Sq \&.
 are parsed for macros.  Other lines are interpreted within the scope of  are parsed for macros.  Other lines are interpreted within the scope of
 prior macros:  prior macros:
Line 49  prior macros:
Line 54  prior macros:
 \&.SH Macro lines change control state.  \&.SH Macro lines change control state.
 Other lines are interpreted within the current state.  Other lines are interpreted within the current state.
 .Ed  .Ed
 .\" SECTION  .
   .
 .Sh INPUT ENCODING  .Sh INPUT ENCODING
 .Nm  .Nm
 documents may contain only graphable 7-bit ASCII characters, the  documents may contain only graphable 7-bit ASCII characters, the
 space character  space character, and the tabs character.  All manuals must have
 .Sq \  ,  
 and tabs  
 .Sq \et .  
 All manuals must have  
 .Ux  .Ux
 .Sq \en  line termination.
 line termination.  .
 .Pp  .Pp
 Blank lines are acceptable; where found, the output will assert a  Blank lines are acceptable; where found, the output will assert a
 vertical space.  vertical space.
   .
 .Pp  .Pp
 The  The
 .Sq \ec  .Sq \ec
Line 71  escape is common in historical
Line 74  escape is common in historical
 .Nm  .Nm
 documents; if encountered at the end of a word, it ensures that the  documents; if encountered at the end of a word, it ensures that the
 subsequent word isn't off-set by whitespace.  subsequent word isn't off-set by whitespace.
 .\" SUB-SECTION  .
   .
 .Ss Comments  .Ss Comments
 Anything following a  Text following a
 .Sq \e"  .Sq \e\*" ,
 delimiter is considered a comment (unless the  whether in a macro or free-form text line, is ignored to the end of
 .Sq \e  line.  A macro line with only a control character and comment escape,
 itself has been escaped) and is ignored to the end of line.  .Sq \&.\e" ,
 Furthermore, a macro line with only a control character  is also ignored.  Macro lines with only a control character and
 .Sq \. ,  optionally whitespace are stripped from input.
 optionally followed by whitespace, is ignored.  .
 .\" SUB-SECTION  .
 .Ss Special Characters  .Ss Special Characters
 Special character sequences begin with the escape character  Special characters may occur in both macro and free-form lines.
   Sequences begin with the escape character
 .Sq \e  .Sq \e
 followed by either an open-parenthesis  followed by either an open-parenthesis
 .Sq \&(  .Sq \&(
 for two-character sequences; an open-bracket  for two-character sequences; an open-bracket
 .Sq \&[  .Sq \&[
 for n-character sequences (terminated at a close-bracket  for n-character sequences (terminated at a close-bracket
 .Sq \&] ) ;  .Sq \&] ) ;
 or a single one-character sequence.  or a single one-character sequence.  See
 .Pp  .Xr mandoc_char 7
 Characters may alternatively be escaped by a slash-asterisk,  for a complete list.  Examples include
 .Sq \e* ,  .Sq \e(em
 with the same combinations as described above.  .Pq em-dash
 .Pp  and
 Terms may also be text-decorated using the  .Sq \ee
   .Pq back-slash .
   .
   .
   .Ss Text Decoration
   Terms may be text-decorated using the
 .Sq \ef  .Sq \ef
 escape followed by a text-decoration letter: B (bold), I, (italic), or P  escape followed by an indicator: B (bold), I, (italic), or P and R
 and R (Roman, or reset).  (Roman, or reset).
 .\" SUB-SECTION  .
   .
 .Ss Whitespace  .Ss Whitespace
 Unless specifically escaped, consecutive blocks of whitespace are pruned  Unless specifically escaped, consecutive blocks of whitespace are pruned
 from input.  These are later re-added, if applicable, by a front-end  from input.  These are later re-added, if applicable, by a front-end
 utility such as  utility such as
 .Xr mandoc 1 .  .Xr mandoc 1 .
 .\" SECTION  .
 .Sh STRUCTURE  .
   .Ss Dates
   The
   .Sx \&TH
   macro is the only
   .Nm
   macro that requires a date.  The form for this date is the ISO-8601
   standard
   .Cm YYYY-MM-DD .
   .
   .
   .Ss Scaling Widths
   Many macros support scaled widths for their arguments, such as
   stipulating a two-inch paragraph indentation with the following:
   .Bd -literal -offset indent
   \&.HP 2i
   .Ed
   .
   .Pp
   The syntax for scaled widths is
   .Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? ,
   where a decimal must be preceded or proceeded by at least one digit.
   Negative numbers, while accepted, are truncated to zero.  The following
   scaling units are accepted:
   .
   .Pp
   .Bl -tag -width Ds -offset indent -compact
   .It c
   centimetre
   .It i
   inch
   .It P
   pica (~1/6 inch)
   .It p
   point (~1/72 inch)
   .It f
   synonym for
   .Sq u
   .It v
   default vertical span
   .It m
   width of rendered
   .Sq m
   .Pq em
   character
   .It n
   width of rendered
   .Sq n
   .Pq en
   character
   .It u
   default horizontal span
   .It M
   mini-em (~1/100 em)
   .El
   .Pp
   Using anything other than
   .Sq m ,
   .Sq n ,
   .Sq u ,
   or
   .Sq v
   is necessarily non-portable across output media.
   .
   .Pp
   If a scaling unit is not provided, the numerical value is interpreted
   under the default rules of
   .Sq v
   for vertical spaces and
   .Sq u
   for horizontal ones.
   .Em Note :
   this differs from
   .Xr mdoc 7 ,
   which, if a unit is not provided, will instead interpret the string as
   literal text.
   .
   .
   .Sh MANUAL STRUCTURE
 Each  Each
 .Nm  .Nm
 document must contain contains at least the  document must contain contains at least the
 .Sq \&.TH  .Sx \&TH
 macro describing the document's section and title.  It may occur  macro describing the document's section and title.  It may occur
 anywhere in the document, although conventionally, it appears as the  anywhere in the document, although conventionally, it appears as the
 first macro.  first macro.
   .
 .Pp  .Pp
 Beyond the  Beyond
 .Sq \&.TH ,  .Sx \&TH ,
 at least one macro or text node must appear in the document.  at least one macro or text node must appear in the document.  Documents
 .\" SECTION  are generally structured as follows:
 .Sh SYNTAX  .Bd -literal -offset indent
   \&.TH FOO 1 2009-10-10
   \&.
   \&.SH NAME
   \efBfoo\efR \e(en a description goes here
   \&.\e\*q The next is for sections 2 & 3 only.
   \&.\e\*q .SH LIBRARY
   \&.
   \&.SH SYNOPSIS
   \efBfoo\efR [\efB\e-options\efR] arguments...
   \&.
   \&.SH DESCRIPTION
   The \efBfoo\efR utility processes files...
   \&.
   \&.\e\*q .SH IMPLEMENTATION NOTES
   \&.\e\*q The next is for sections 1 & 8 only.
   \&.\e\*q .SH EXIT STATUS
   \&.\e\*q The next is for sections 2, 3, & 9 only.
   \&.\e\*q .SH RETURN VALUES
   \&.\e\*q The next is for sections 1, 6, 7, & 8 only.
   \&.\e\*q .SH ENVIRONMENT
   \&.\e\*q .SH FILES
   \&.\e\*q .SH EXAMPLES
   \&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
   \&.\e\*q .SH DIAGNOSTICS
   \&.\e\*q The next is for sections 2, 3, & 9 only.
   \&.\e\*q .SH ERRORS
   \&.\e\*q .SH SEE ALSO
   \&.\e\*q .BR foo ( 1 )
   \&.\e\*q .SH STANDARDS
   \&.\e\*q .SH HISTORY
   \&.\e\*q .SH AUTHORS
   \&.\e\*q .SH CAVEATS
   \&.\e\*q .SH BUGS
   \&.\e\*q .SH SECURITY CONSIDERATIONS
   .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 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 EXIT STATUS
   Command exit status for section 1, 6, and 8 manuals.  This section is
   the dual of
   .Em RETURN VALUES ,
   which is used for functions.  Historically, this information was
   described in
   .Em DIAGNOSTICS ,
   a practise that is now discouraged.
   .
   .It Em RETURN VALUES
   This section is the dual of
   .Em EXIT STATUS ,
   which is used for commands.  It 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 and a
   short description of how the file is used (created, modified, etc.).
   .
   .It Em EXAMPLES
   Example usages.  This often contains snippets of well-formed,
   well-tested invocations.  Make doubly sure that your examples work
   properly!
   .
   .It Em DIAGNOSTICS
   Documents error conditions.  This is most useful in section 4 manuals.
   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 error handling in sections 2, 3, 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
   The history of any manual without a
   .Em STANDARDS
   section should be described in this section.
   .
   .It Em AUTHORS
   Credits to authors, if applicable, should appear in this section.
   Authors should generally be noted by both name and an e-mail address.
   .
   .It Em CAVEATS
   Explanations of common misuses and misunderstandings should be explained
   in this section.
   .
   .It Em BUGS
   Extant bugs should be described in this section.
   .
   .It Em SECURITY CONSIDERATIONS
   Documents any security precautions that operators should consider.
   .
   .El
   .
   .
   .Sh MACRO SYNTAX
 Macros are one to three three characters in length and begin with a  Macros are one to three three characters in length and begin with a
 control character ,  control character ,
 .Sq \&. ,  .Sq \&. ,
 at the beginning of the line.  An arbitrary amount of whitespace may  at the beginning of the line.  An arbitrary amount of whitespace may
 sit between the control character and the macro name.  Thus,  sit between the control character and the macro name.  Thus, the
 .Sq \&.PP  following are equivalent:
 and  .Bd -literal -offset indent
 .Sq \&.\ \ \ \&PP  \&.PP
 are equivalent.  \&.\ \ \ PP
   .Ed
   .
 .Pp  .Pp
 All  The
 .Nm  .Nm
 macros follow the same structural rules:  macros are classified by scope: line scope or block scope.  Line
   macros are only scoped to the current line (and, in some situations,
   the subsequent line).  Block macros are scoped to the current line and
   subsequent lines until closed by another block macro.
   .
   .
   .Ss Line Macros
   Line macros are generally scoped to the current line, with the body
   consisting of zero or more arguments.  If a macro is scoped to the next
   line and the line arguments are empty, the next line is used instead,
   else the general syntax is used.  Thus:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.YO \(lBbody...\(rB  \&.I
   foo
 .Ed  .Ed
   .
 .Pp  .Pp
   is equivalent to
   .Sq \&.I foo .
   If next-line macros are invoked consecutively, only the last is used; in
   other words, if a next-line macro is preceded by a block macro, it is
   ignored.
   .Bd -literal -offset indent
   \&.YO \(lBbody...\(rB
   \(lBbody...\(rB
   .Ed
   .
   .Pp
   .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"
   .It Em Macro Ta Em Arguments Ta Em Scope
   .It Sx \&B   Ta    n         Ta    next-line
   .It Sx \&BI  Ta    n         Ta    current
   .It Sx \&BR  Ta    n         Ta    current
   .It Sx \&DT  Ta    0         Ta    current
   .It Sx \&I   Ta    n         Ta    next-line
   .It Sx \&IB  Ta    n         Ta    current
   .It Sx \&IR  Ta    n         Ta    current
   .It Sx \&PD  Ta    n         Ta    current
   .It Sx \&R   Ta    n         Ta    next-line
   .It Sx \&RB  Ta    n         Ta    current
   .It Sx \&RI  Ta    n         Ta    current
   .It Sx \&SB  Ta    n         Ta    next-line
   .It Sx \&SM  Ta    n         Ta    next-line
   .It Sx \&TH  Ta    >1, <6    Ta    current
   .It Sx \&UC  Ta    n         Ta    current
   .It Sx \&br  Ta    0         Ta    current
   .It Sx \&fi  Ta    0         Ta    current
   .It Sx \&i   Ta    n         Ta    current
   .It Sx \&na  Ta    0         Ta    current
   .It Sx \&nf  Ta    0         Ta    current
   .It Sx \&r   Ta    0         Ta    current
   .It Sx \&sp  Ta    1         Ta    current
   .El
   .
   .Pp
 The  The
 .Dq body  .Sx \&PD ,
 consists of zero or more arguments to the macro.  .Sx \&RS ,
   .Sx \&RE ,
   .Sx \&UC ,
   .Sx \&br ,
   .Sx \&fi ,
   .Sx \&i ,
   .Sx \&na ,
   .Sx \&nf ,
   .Sx \&r ,
   and
   .Sx \&sp
   macros should not be used.  They're included for compatibility.
   .
   .
   .Ss Block Macros
   Block macros are comprised of a head and body.  Like for in-line macros,
   the head is scoped to the current line and, in one circumstance, the
   next line; the body is scoped to subsequent lines and is closed out by a
   subsequent block macro invocation.
   .Bd -literal -offset indent
   \&.YO \(lBhead...\(rB
   \(lBhead...\(rB
   \(lBbody...\(rB
   .Ed
   .
 .Pp  .Pp
 .Nm  The closure of body scope may be to the section, where a macro is closed
 has a primitive notion of multi-line scope for the following macros:  by
 .Sq \&.TM ,  .Sx \&SH ;
 .Sq \&.SM ,  sub-section, closed by a section or
 .Sq \&.SB ,  .Sx \&SS ;
 .Sq \&.BI ,  part, closed by a section, sub-section, or
 .Sq \&.IB ,  .Sx \&RE ;
 .Sq \&.BR ,  or paragraph, closed by a section, sub-section, part,
 .Sq \&.RB ,  .Sx \&HP ,
 .Sq \&.R ,  .Sx \&IP ,
 .Sq \&.B ,  .Sx \&LP ,
 .Sq \&.I ,  .Sx \&P ,
 .Sq \&.IR  .Sx \&PP ,
   or
   .Sx \&TP .
   No closure refers to an explicit block closing macro.
   .
   .Pp
   .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent
   .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope
   .It Sx \&HP  Ta    <2        Ta    current    Ta    paragraph
   .It Sx \&IP  Ta    <3        Ta    current    Ta    paragraph
   .It Sx \&LP  Ta    0         Ta    current    Ta    paragraph
   .It Sx \&P   Ta    0         Ta    current    Ta    paragraph
   .It Sx \&PP  Ta    0         Ta    current    Ta    paragraph
   .It Sx \&RE  Ta    0         Ta    current    Ta    none
   .It Sx \&RS  Ta    1         Ta    current    Ta    part
   .It Sx \&SH  Ta    >0        Ta    next-line  Ta    section
   .It Sx \&SS  Ta    >0        Ta    next-line  Ta    sub-section
   .It Sx \&TP  Ta    n         Ta    next-line  Ta    paragraph
   .El
   .
   .Pp
   If a block macro is next-line scoped, it may only be followed by in-line
   macros (excluding
   .Sx \&DT ,
   .Sx \&PD ,
   .Sx \&TH ,
   .Sx \&UC ,
   .Sx \&br ,
   .Sx \&na ,
   .Sx \&sp ,
   .Sx \&nf ,
 and  and
 .Sq \&.RI .  .Sx \&fi ) .
 When these macros are invoked without arguments, the subsequent line is  .
 considered a continuation of the macro.  Thus:  .
 .Bd -literal -offset indent  .Sh REFERENCE
 \&.RI  This section is a canonical reference to all macros, arranged
 foo  alphabetically.  For the scoping of individual macros, see
   .Sx MACRO SYNTAX .
   .
   .
   .Ss \&B
   Text is rendered in bold face.
   .Pp
   See also
   .Sx \&I ,
   .Sx \&R ,
   .Sx \&b ,
   .Sx \&i ,
   and
   .Sx \&r .
   .
   .
   .Ss \&BI
   Text is rendered alternately in bold face and italic.  Thus,
   .Sq .BI this word and that
   causes
   .Sq this
   and
   .Sq and
   to render in bold face, while
   .Sq word
   and
   .Sq that
   render in italics.  Whitespace between arguments is omitted in output.
   .Pp
   Examples:
   .Bd -filled -offset indent
   .Pf \. Sx \&BI
   bold italic bold italic
 .Ed  .Ed
 .Pp  .Pp
 is equivalent to  The output of this example will be emboldened
 .Sq \&.RI foo .  .Dq bold
 If two consecutive lines exhibit the latter behaviour,  and italicised
 an error is raised.  Thus, the following is not acceptable:  .Dq italic ,
 .Bd -literal -offset indent  with spaces stripped between arguments.
 \&.RI  .Pp
 \&.I  See also
 Hello, world.  .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).
   Whitespace between arguments is omitted in output.
   .Pp
   See
   .Sx \&BI
   for an equivalent example.
   .Pp
   See also
   .Sx \&BI ,
   .Sx \&IB ,
   .Sx \&RB ,
   .Sx \&RI ,
   and
   .Sx \&IR .
   .
   .
   .Ss \&DT
   Has no effect.  Included for compatibility.
   .
   .
   .Ss \&HP
   Begin a paragraph whose initial output line is left-justified, but
   subsequent output lines are indented, with the following syntax:
   .Bd -filled -offset indent
   .Pf \. Sx \&HP
   .Op Cm width
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Sq \&.TP  .Cm width
 macro is similar, but does not need an empty argument line to trigger  argument must conform to
 the behaviour.  .Sx Scaling Widths .
 .\" SECTION  If specified, it's saved for later paragraph left-margins; if unspecified, the
 .Sh MACROS  saved or default width is used.
 This section contains a complete list of all  
 .Nm  
 macros and corresponding number of arguments.  
 .Pp  .Pp
 .Bl -column "MacroX" "Arguments" -compact -offset indent  See also
 .It Em Macro Ta Em Arguments  .Sx IP ,
 .It \&.TH    Ta    >1, <6  .Sx LP ,
 .It \&.SH    Ta    >0  .Sx P ,
 .It \&.SS    Ta    >0  .Sx PP ,
 .It \&.TP    Ta    n  and
 .It \&.LP    Ta    0  .Sx TP .
 .It \&.PP    Ta    0  .
 .It \&.P     Ta    0  .
 .It \&.IP    Ta    <3  .Ss \&I
 .It \&.HP    Ta    <2  Text is rendered in italics.
 .It \&.SM    Ta    n  
 .It \&.SB    Ta    n  
 .It \&.BI    Ta    n  
 .It \&.IB    Ta    n  
 .It \&.BR    Ta    n  
 .It \&.RB    Ta    n  
 .It \&.R     Ta    n  
 .It \&.B     Ta    n  
 .It \&.I     Ta    n  
 .It \&.IR    Ta    n  
 .It \&.RI    Ta    n  
 .El  
 .Pp  .Pp
 Although not historically part of the  See also
 .Nm  .Sx \&B ,
 system, the following macros are also supported:  .Sx \&R ,
   .Sx \&b ,
   .Sx \&i ,
   and
   .Sx \&r .
   .
   .
   .Ss \&IB
   Text is rendered alternately in italics and bold face.  Whitespace
   between arguments is omitted in output.
 .Pp  .Pp
 .Bl -column "MacroX" "Arguments" -compact -offset indent  See
 .It Em Macro Ta Em Arguments  .Sx \&BI
 .It \&.br    Ta    0  for an equivalent example.
 .It \&.i     Ta    n  
 .El  
 .Pp  .Pp
 These follow the same calling conventions as the above  See also
 .Nm  .Sx \&BI ,
 macros.  .Sx \&BR ,
 .\" SECTION  .Sx \&RB ,
 .Sh COMPATIBILITY  .Sx \&RI ,
   and
   .Sx \&IR .
   .
   .
   .Ss \&IP
   Begin an indented paragraph with the following syntax:
   .Bd -filled -offset indent
   .Pf \. Sx \&IP
   .Op Cm head Op Cm width
   .Ed
   .Pp
   The
   .Cm width
   argument defines the width of the left margin and is defined by
   .Sx Scaling Widths ,
   It's saved for later paragraph left-margins; if unspecified, the saved or
   default width is used.
   .Pp
   The
   .Cm head
   argument is used as a leading term, flushed to the left margin.  This is
   useful for bulleted paragraphs and so on.
   .Pp
   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).
   Whitespace between arguments is omitted in output.
   .Pp
 See  See
 .Xr mdoc 7  .Sx \&BI
 for groff compatibility notes.  for an equivalent example.
 .\" SECTION  .Pp
   See also
   .Sx \&BI ,
   .Sx \&IB ,
   .Sx \&BR ,
   .Sx \&RB ,
   and
   .Sx \&RI .
   .
   .
   .Ss \&LP
   Begin an undecorated paragraph.  The scope of a paragraph is closed by a
   subsequent paragraph, sub-section, section, or end of file.  The saved
   paragraph left-margin width is re-set to the default.
   .Pp
   See also
   .Sx HP ,
   .Sx IP ,
   .Sx P ,
   .Sx PP ,
   and
   .Sx TP .
   .
   .
   .Ss \&P
   Synonym for
   .Sx \&LP .
   .Pp
   See also
   .Sx HP ,
   .Sx IP ,
   .Sx LP ,
   .Sx PP ,
   and
   .Sx TP .
   .
   .
   .Ss \&PP
   Synonym for
   .Sx \&LP .
   .Pp
   See also
   .Sx HP ,
   .Sx IP ,
   .Sx LP ,
   .Sx P ,
   and
   .Sx TP .
   .
   .
   .Ss \&R
   Text is rendered in roman (the default font).
   .Pp
   See also
   .Sx \&I ,
   .Sx \&B ,
   .Sx \&b ,
   .Sx \&i ,
   and
   .Sx \&r .
   .
   .
   .Ss \&RB
   Text is rendered alternately in roman (the default font) and bold face.
   Whitespace between arguments is omitted in output.
   .Pp
   See
   .Sx \&BI
   for an equivalent example.
   .Pp
   See also
   .Sx \&BI ,
   .Sx \&IB ,
   .Sx \&BR ,
   .Sx \&RI ,
   and
   .Sx \&IR .
   .
   .
   .Ss \&RE
   Explicitly close out the scope of a prior
   .Sx \&RS .
   .
   .
   .Ss \&RI
   Text is rendered alternately in roman (the default font) and italics.
   Whitespace between arguments is omitted in output.
   .Pp
   See
   .Sx \&BI
   for an equivalent example.
   .Pp
   See also
   .Sx \&BI ,
   .Sx \&IB ,
   .Sx \&BR ,
   .Sx \&RB ,
   and
   .Sx \&IR .
   .
   .
   .Ss \&RS
   Begin a part setting the left margin.  The left margin controls the
   offset, following an initial indentation, to un-indented text such as
   that of
   .Sx \&PP .
   This has the following syntax:
   .Bd -filled -offset indent
   .Pf \. Sx \&Rs
   .Op Cm width
   .Ed
   .Pp
   The
   .Cm width
   argument must conform to
   .Sx Scaling Widths .
   If not specified, the saved or default width is used.
   .
   .
   .Ss \&SB
   Text is rendered in small size (one point smaller than the default font)
   bold face.
   .
   .
   .Ss \&SH
   Begin a section.  The scope of a section is only closed by another
   section or the end of file.  The paragraph left-margin width is re-set
   to the default.
   .
   .
   .Ss \&SM
   Text is rendered in small size (one point smaller than the default
   font).
   .
   .
   .Ss \&SS
   Begin a sub-section.  The scope of a sub-section is closed by a
   subsequent sub-section, section, or end of file.  The paragraph
   left-margin width is re-set to the default.
   .
   .
   .Ss \&TH
   Sets the title of the manual page with the following syntax:
   .Bd -filled -offset indent
   .Pf \. Sx \&TH
   .Cm title section
   .Op Cm date Op Cm source Op Cm volume
   .Ed
   .Pp
   At least the upper-case document title
   .Cm title
   and numeric manual section
   .Cm section
   arguments must be provided.  The
   .Cm date
   argument should be formatted as described in
   .Sx Dates :
   if it does not conform, the current date is used instead.  The
   .Cm source
   string specifies the organisation providing the utility.  The
   .Cm volume
   string replaces the default rendered volume, which is dictated by the
   manual section.
   .Pp
   Examples:
   .Bd -filled -offset indent
   \&.TH CVS 5 "1992-02-12" GNU
   .Ed
   .
   .
   .Ss \&TP
   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
   buffer to the indentation width.  Subsequent output lines are indented.
   The syntax is as follows:
   .Bd -filled -offset indent
   .Pf \. Sx \&TP
   .Op Cm width
   .Ed
   .Pp
   The
   .Cm width
   argument must conform to
   .Sx Scaling Widths .
   If specified, it's saved for later paragraph left-margins; if
   unspecified, the saved or default width is used.
   .Pp
   See also
   .Sx HP ,
   .Sx IP ,
   .Sx LP ,
   .Sx P ,
   and
   .Sx PP .
   .
   .
   .Ss \&PD
   Has no effect.  Included for compatibility.
   .
   .
   .Ss \&UC
   Has no effect.  Included for compatibility.
   .
   .
   .Ss \&br
   Breaks the current line.  Consecutive invocations have no further effect.
   .Pp
   See also
   .Sx \&sp .
   .
   .
   .Ss \&fi
   End literal mode begun by
   .Sx \&nf .
   .
   .
   .Ss \&i
   Italicise arguments.  If no arguments are specified, all subsequent text
   is italicised.
   .Pp
   See also
   .Sx \&B ,
   .Sx \&I ,
   .Sx \&R .
   .Sx \&b ,
   and
   .Sx \&r .
   .
   .
   .Ss \&na
   Don't align to the right margin.
   .
   .
   .Ss \&nf
   Begin literal mode: all subsequent free-form lines have their end of
   line boundaries preserved.  May be ended by
   .Sx \&fi .
   .
   .
   .Ss \&r
   Fonts and styles (bold face, italics) reset to roman (default font).
   .Pp
   See also
   .Sx \&B ,
   .Sx \&I ,
   .Sx \&R ,
   .Sx \&b ,
   and
   .Sx \&i .
   .
   .
   .Ss \&sp
   Insert vertical spaces into output with the following syntax:
   .Bd -filled -offset indent
   .Pf \. Sx \&sp
   .Op Cm height
   .Ed
   .Pp
   Insert
   .Cm height
   spaces, which must conform to
   .Sx Scaling Widths .
   If 0, this is equivalent to the
   .Sx \&br
   macro.  Defaults to 1, if unspecified.
   .Pp
   See also
   .Sx \&br .
   .
   .
   .Sh COMPATIBILITY
   This section documents compatibility with other roff implementations, at
   this time limited to
   .Xr groff 1 .
   .Bl -hyphen
   .It
   In quoted literals, groff allowed pair-wise double-quotes to produce a
   standalone double-quote in formatted output.  This idiosyncratic
   behaviour is no longer applicable.
   .It
   The
   .Sq sp
   macro does not accept negative numbers.
   .It
   Blocks of whitespace are stripped from both macro and free-form text
   lines (except when in literal mode), while groff would retain whitespace
   in free-form text lines.
   .El
   .
   .
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 .Xr mandoc_char 7  .Xr mandoc_char 7
 .\" SECTION  .
   .
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  reference was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons Aq kristaps@kth.se .
 .\" SECTION  .
   .
 .Sh CAVEATS  .Sh CAVEATS
 Do not use this language.  Use  Do not use this language.  Use
 .Xr mdoc 7 ,  .Xr mdoc 7 ,
 instead.  instead.
   .
Legend:
Removed from v.1.18  
changed lines
  Added in v.1.44
CVSweb