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

Diff for /mandoc/man.7 between version 1.1 and 1.32

version 1.1, 2009/03/23 16:02:56 version 1.32, 2009/08/20 12:08:40
Line 1 
Line 1 
 .\" $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>  .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the  .\" purpose with or without fee is hereby granted, provided that the above
 .\" above copyright notice and this permission notice appear in all  .\" copyright notice and this permission notice appear in all copies.
 .\" copies.  
 .\"  .\"
 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL  .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 .\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED  .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE  .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 .\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL  .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR  .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER  .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR  .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\" PERFORMANCE OF THIS SOFTWARE.  .\"
 .\"  
 .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.  In this reference document, we describe the syntax and  manuals.  This reference document describes its syntax, structure, and
 structure of the  usage.
 .Nm  .
 language.  
 .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:
 .Bd -literal -offset XXX  .Bd -literal -offset indent
 \&.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
 .\" PARAGRAPH  .
 .Pp  .
 Macros are character sequences whose structural rules are described  
 later in this document.  
 .\" SECTION  
 .Sh INPUT ENCODING  .Sh INPUT ENCODING
 .Nm  .Nm
 documents may contain only graphable 7-bit ASCII characters and the  documents may contain only graphable 7-bit ASCII characters, the
 space character  space character, and the tabs character.  All manuals must have
 .Sq \  .  .Ux
 All manuals must have  line termination.
 .Sq \en  .
 line termination.  
 .Pp  .Pp
 Blank lines are acceptable; where found, the output will also assert a  Blank lines are acceptable; where found, the output will assert a
 vertical space.  vertical space.
 .\" SUB-SECTION  .
   .Pp
   The
   .Sq \ec
   escape is common in historical
   .Nm
   documents; if encountered at the end of a word, it ensures that the
   subsequent word isn't off-set by whitespace.
   .
   .
   .Ss Comments
   Text following a
   .Sq \e\*" ,
   whether in a macro or free-form text line, is ignored to the end of
   line.  A macro line with only a control character and comment escape,
   .Sq \&.\e" ,
   is also ignored.  Macro lines with only a control charater and
   optionally whitespace are stripped from input.
   .
   .
 .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.
 .Sq \\  Sequences begin with the escape character
 followed by either an open-parenthesis  .Sq \e
   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
   .Xr mandoc_char 7
   for a complete list.  Examples include
   .Sq \e(em
   .Pq em-dash
   and
   .Sq \ee
   .Pq back-slash .
   .
   .
   .Ss Text Decoration
   Terms may be text-decorated using the
   .Sq \ef
   escape followed by an indicator: B (bold), I, (italic), or P and R
   (Roman, or reset).
   .
   .
   .Ss Whitespace
   Unless specifically escaped, consecutive blocks of whitespace are pruned
   from input.  These are later re-added, if applicable, by a front-end
   utility such as
   .Xr mandoc 1 .
   .
   .
   .Sh MANUAL STRUCTURE
   Each
   .Nm
   document must contain contains at least the
   .Sq TH
   macro describing the document's section and title.  It may occur
   anywhere in the document, although conventionally, it appears as the
   first macro.
   .
 .Pp  .Pp
 Characters may alternatively be escaped by a slash-asterisk,  Beyond
 .Sq \\* ,  .Sq TH ,
 with the same combinations as described above.  This form is deprecated.  at least one macro or text node must appear in the document.  Documents
   are generally structured as follows:
   .Bd -literal -offset indent
   \&.TH FOO 1 "13 Aug 2009"
   \&.
   \&.SH NAME
   \efBfoo\efR \e(en a description goes here
   \&.
   \&.SH SYNOPSIS
   \efBfoo\efR [\efB\e-options\efR] arguments...
   \&.
   \&.SH DESCRIPTION
   The \efBfoo\efR utility does...
   \&.
   \&.\e\*q .SH RETURN VALUES
   \&.\e\*q .SH ENVIRONMENT
   \&.\e\*q .SH FILES
   \&.\e\*q .SH EXAMPLES
   \&.\e\*q .SH DIAGNOSTICS
   \&.\e\*q .SH ERRORS
   \&.\e\*q .SH SEE ALSO
   \&.\e\*q \efBbar\efR(1)
   \&.\e\*q .SH STANDARDS
   \&.\e\*q .SH HISTORY
   \&.\e\*q .SH AUTHORS
   \&.\e\*q .SH CAVEATS
   \&.\e\*q .SH BUGS
   .Ed
   .
   .
   .Sh MACRO SYNTAX
   Macros are one to three three characters in length and begin with a
   control character ,
   .Sq \&. ,
   at the beginning of the line.  An arbitrary amount of whitespace may
   sit between the control character and the macro name.  Thus,
   .Sq .PP
   and
   .Sq \&.\ \ \ PP
   are equivalent.
   .
 .Pp  .Pp
 The following is a table of all available escapes.  The
   .Nm
   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
   \&.I
   foo
   .Ed
   .
 .Pp  .Pp
 Grammatic:  is equivalent to
 .Bl -tag -width 12n -offset "XXXX" -compact  .Sq \&.I foo .
 .It \\(em  
 .Pq em-dash  
 .It \\(en  
 .Pq en-dash  
 .It \e-  
 .Pq hyphen  
 .It \\\\  
 .Pq back-slash  
 .It \e'  
 .Pq apostrophe  
 .It \e`  
 .Pq back-tick  
 .It \\  
 .Pq space  
 .It \\.  
 .Pq period  
 .It \\(r!  
 .Pq upside-down exclamation  
 .It \\(r?  
 .Pq upside-down question  
 .El  
 .\" PARAGRAPH  .\" PARAGRAPH
   Consecutive next-line scope invocations are disallowed.
   .Bd -literal -offset indent
   \&.YO \(lBbody...\(rB
   \(lBbody...\(rB
   .Ed
   .
 .Pp  .Pp
 Enclosures:  It is considered an error when next-line scope is open at the end of
 .Bl -tag -width 12n -offset "XXXX" -compact  file.
 .It \\(lh  .
 .Pq left hand  
 .It \\(rh  
 .Pq right hand  
 .It \\(Fo  
 .Pq left guillemet  
 .It \\(Fc  
 .Pq right guillemet  
 .It \\(fo  
 .Pq left guilsing  
 .It \\(fc  
 .Pq right guilsing  
 .It \\(rC  
 .Pq right brace  
 .It \\(lC  
 .Pq left brace  
 .It \\(ra  
 .Pq right angle  
 .It \\(la  
 .Pq left angle  
 .It \\(rB  
 .Pq right bracket  
 .It \\(lB  
 .Pq left bracket  
 .It \\q  
 .Pq double-quote  
 .It \\(lq  
 .Pq left double-quote  
 .It \\(Lq  
 .Pq left double-quote, deprecated  
 .It \\(rq  
 .Pq right double-quote  
 .It \\(Rq  
 .Pq right double-quote, deprecated  
 .It \\(oq  
 .Pq left single-quote  
 .It \\(aq  
 .Pq right single-quote  
 .It \\(Bq  
 .Pq right low double-quote  
 .It \\(bq  
 .Pq right low single-quote  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Indicatives:  .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"
 .Bl -tag -width 12n -offset "XXXX" -compact  .It Em Macro Ta Em Arguments Ta Em Scope
 .It \\(<-  .It    B     Ta    n         Ta    next-line
 .Pq left arrow  .It    BI    Ta    n         Ta    current
 .It \\(->  .It    BR    Ta    n         Ta    current
 .Pq right arrow  .It    DT    Ta    0         Ta    current
 .It \\(ua  .It    I     Ta    n         Ta    next-line
 .Pq up arrow  .It    IB    Ta    n         Ta    current
 .It \\(da  .It    IR    Ta    n         Ta    current
 .Pq down arrow  .It    R     Ta    n         Ta    next-line
 .It \\(<>  .It    RB    Ta    n         Ta    current
 .Pq left-right arrow  .It    RI    Ta    n         Ta    current
 .It \\(lA  .It    SB    Ta    n         Ta    next-line
 .Pq left double-arrow  .It    SM    Ta    n         Ta    next-line
 .It \\(rA  .It    TH    Ta    >1, <6    Ta    current
 .Pq right double-arrow  .It    br    Ta    0         Ta    current
 .It \\(uA  .It    fi    Ta    0         Ta    current
 .Pq up double-arrow  .It    i     Ta    n         Ta    current
 .It \\(dA  .It    na    Ta    0         Ta    current
 .Pq down double-arrow  .It    nf    Ta    0         Ta    current
 .It \\(hA  .It    r     Ta    0         Ta    current
 .Pq left-right double-arrow  .It    sp    Ta    1         Ta    current
 .El  .El
 .\" PARAGRAPH  .
 .Pp  .Pp
 Mathematical:  The
 .Bl -tag -width 12n -offset "XXXX" -compact  .Sq RS ,
 .It \\(es  .Sq RE ,
 .Pq empty set  .Sq br ,
 .It \\(ca  .Sq fi ,
 .Pq intersection  .Sq i ,
 .It \\(cu  .Sq na ,
 .Pq union  .Sq nf ,
 .It \\(gr  .Sq r ,
 .Pq gradient  and
 .It \\(pd  .Sq sp
 .Pq partial differential  macros aren't historically part of
 .It \\(ap  .Nm
 .Pq similarity  and should not be used.  They're included for compatibility.
 .It \\(=)  .
 .Pq proper superset  .
 .It \\((=  .Ss Block Macros
 .Pq proper subset  Block macros are comprised of a head and body.  Like for in-line macros,
 .It \\(eq  the head is scoped to the current line and, in one circumstance, the
 .Pq equals  next line; the body is scoped to subsequent lines and is closed out by a
 .It \\(di  subsequent block macro invocation.
 .Pq division  .Bd -literal -offset indent
 .It \\(mu  \&.YO \(lBhead...\(rB
 .Pq multiplication  \(lBhead...\(rB
 .It \\(pl  \(lBbody...\(rB
 .Pq addition  .Ed
 .It \\(nm  .
 .Pq not element  
 .It \\(mo  
 .Pq element  
 .It \\(Im  
 .Pq imaginary  
 .It \\(Re  
 .Pq real  
 .It \\(Ah  
 .Pq aleph  
 .It \\(te  
 .Pq existential quantifier  
 .It \\(fa  
 .Pq universal quantifier  
 .It \\(AN  
 .Pq logical AND  
 .It \\(OR  
 .Pq logical OR  
 .It \\(no  
 .Pq logical NOT  
 .It \\(st  
 .Pq such that  
 .It \\(tf  
 .Pq therefore  
 .It \\(~~  
 .Pq approximate  
 .It \\(~=  
 .Pq approximately equals  
 .It \\(=~  
 .Pq congruent  
 .It \\(Gt  
 .Pq greater-than, deprecated  
 .It \\(Lt  
 .Pq less-than, deprecated  
 .It \\(<=  
 .Pq less-than-equal  
 .It \\(Le  
 .Pq less-than-equal, deprecated  
 .It \\(>=  
 .Pq greater-than-equal  
 .It \\(Ge  
 .Pq greater-than-equal  
 .It \\(==  
 .Pq equal  
 .It \\(!=  
 .Pq not equal  
 .It \\(Ne  
 .Pq not equal, deprecated  
 .It \\(if  
 .Pq infinity  
 .It \\(If  
 .Pq infinity, deprecated  
 .It \\(na  
 .Pq NaN , an extension  
 .It \\(Na  
 .Pq NaN, deprecated  
 .It \\(+-  
 .Pq plus-minus  
 .It \\(Pm  
 .Pq plus-minus, deprecated  
 .It \\(**  
 .Pq asterisk  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Ligatures:  The closure of body scope may be to the section, where a macro is closed
 .Bl -tag -width 12n -offset "XXXX" -compact  by
 .It \\(ss  .Sq SH ;
 .Pq German eszett  sub-section, closed by a section or
 .It \\(AE  .Sq SS ;
 .Pq upper-case AE  part, closed by a section, sub-section, or
 .It \\(ae  .Sq RE ;
 .Pq lower-case AE  or paragraph, closed by a section, sub-section, part,
 .It \\(OE  .Sq HP ,
 .Pq upper-case OE  .Sq IP ,
 .It \\(oe  .Sq LP ,
 .Pq lower-case OE  .Sq P ,
 .It \\(ff  .Sq PP ,
 .Pq ff ligature  or
 .It \\(fi  .Sq TP .
 .Pq fi ligature  No closure refers to an explicit block closing macro.
 .It \\(fl  .
 .Pq fl ligature  
 .It \\(Fi  
 .Pq ffi ligature  
 .It \\(Fl  
 .Pq ffl ligature  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Diacritics and letters:  It is considered an error when part or next-line scope is open at the
 .Bl -tag -width 12n -offset "XXXX" -compact  end of file.
 .It \\(ga  .
 .Pq grave accent  
 .It \\(aa  
 .Pq accute accent  
 .It \\(a"  
 .Pq umlaut accent  
 .It \\(ad  
 .Pq dieresis accent  
 .It \\(a~  
 .Pq tilde accent  
 .It \\(a^  
 .Pq circumflex accent  
 .It \\(ac  
 .Pq cedilla accent  
 .It \\(ad  
 .Pq dieresis accent  
 .It \\(ah  
 .Pq caron accent  
 .It \\(ao  
 .Pq ring accent  
 .It \\(ho  
 .Pq hook accent  
 .It \\(ab  
 .Pq breve accent  
 .It \\(a-  
 .Pq macron accent  
 .It \\(-D  
 .Pq upper-case eth  
 .It \\(Sd  
 .Pq lower-case eth  
 .It \\(TP  
 .Pq upper-case thorn  
 .It \\(Tp  
 .Pq lower-case thorn  
 .It \\('A  
 .Pq upper-case acute A  
 .It \\('E  
 .Pq upper-case acute E  
 .It \\('I  
 .Pq upper-case acute I  
 .It \\('O  
 .Pq upper-case acute O  
 .It \\('U  
 .Pq upper-case acute U  
 .It \\('a  
 .Pq lower-case acute a  
 .It \\('e  
 .Pq lower-case acute e  
 .It \\('i  
 .Pq lower-case acute i  
 .It \\('o  
 .Pq lower-case acute o  
 .It \\('u  
 .Pq lower-case acute u  
 .It \\(`A  
 .Pq upper-case grave A  
 .It \\(`E  
 .Pq upper-case grave E  
 .It \\(`I  
 .Pq upper-case grave I  
 .It \\(`O  
 .Pq upper-case grave O  
 .It \\(`U  
 .Pq upper-case grave U  
 .It \\(`a  
 .Pq lower-case grave a  
 .It \\(`e  
 .Pq lower-case grave e  
 .It \\(`i  
 .Pq lower-case grave i  
 .It \\(`o  
 .Pq lower-case grave o  
 .It \\(`u  
 .Pq lower-case grave u  
 .It \\(~A  
 .Pq upper-case tilde A  
 .It \\(~N  
 .Pq upper-case tilde N  
 .It \\(~O  
 .Pq upper-case tilde O  
 .It \\(~a  
 .Pq lower-case tilde a  
 .It \\(~n  
 .Pq lower-case tilde n  
 .It \\(~o  
 .Pq lower-case tilde o  
 .It \\(:A  
 .Pq upper-case dieresis A  
 .It \\(:E  
 .Pq upper-case dieresis E  
 .It \\(:I  
 .Pq upper-case dieresis I  
 .It \\(:O  
 .Pq upper-case dieresis O  
 .It \\(:U  
 .Pq upper-case dieresis U  
 .It \\(:a  
 .Pq lower-case dieresis a  
 .It \\(:e  
 .Pq lower-case dieresis e  
 .It \\(:i  
 .Pq lower-case dieresis i  
 .It \\(:o  
 .Pq lower-case dieresis o  
 .It \\(:u  
 .Pq lower-case dieresis u  
 .It \\(:y  
 .Pq lower-case dieresis y  
 .It \\(^A  
 .Pq upper-case circumflex A  
 .It \\(^E  
 .Pq upper-case circumflex E  
 .It \\(^I  
 .Pq upper-case circumflex I  
 .It \\(^O  
 .Pq upper-case circumflex O  
 .It \\(^U  
 .Pq upper-case circumflex U  
 .It \\(^a  
 .Pq lower-case circumflex a  
 .It \\(^e  
 .Pq lower-case circumflex e  
 .It \\(^i  
 .Pq lower-case circumflex i  
 .It \\(^o  
 .Pq lower-case circumflex o  
 .It \\(^u  
 .Pq lower-case circumflex u  
 .It \\(,C  
 .Pq upper-case cedilla C  
 .It \\(,c  
 .Pq lower-case cedilla c  
 .It \\(/L  
 .Pq upper-case stroke L  
 .It \\(/l  
 .Pq lower-case stroke l  
 .It \\(/O  
 .Pq upper-case stroke O  
 .It \\(/o  
 .Pq lower-case stroke o  
 .It \\(oA  
 .Pq upper-case ring A  
 .It \\(oa  
 .Pq lower-case ring a  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Monetary:  .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent
 .Bl -tag -width 12n -offset "XXXX" -compact  .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope
 .It \\(Cs  .It   HP     Ta    <2        Ta    current    Ta    paragraph
 .Pq Scandinavian  .It   IP     Ta    <3        Ta    current    Ta    paragraph
 .It \\(Do  .It   LP     Ta    0         Ta    current    Ta    paragraph
 .Pq dollar  .It   P      Ta    0         Ta    current    Ta    paragraph
 .It \\(Po  .It   PP     Ta    0         Ta    current    Ta    paragraph
 .Pq pound  .It   RE     Ta    0         Ta    current    Ta    none
 .It \\(Ye  .It   RS     Ta    1         Ta    current    Ta    part
 .Pq yen  .It   SH     Ta    >0        Ta    current    Ta    section
 .It \\(Fn  .It   SS     Ta    >0        Ta    current    Ta    sub-section
 .Pq florin  .It   TP     Ta    n         Ta    next-line  Ta    paragraph
 .It \\(ct  
 .Pq cent  
 .El  .El
 .\" PARAGRAPH  .
 .Pp  .Pp
 Special symbols:  If a block macro is next-line scoped, it may only be followed by in-line
 .Bl -tag -width 12n -offset "XXXX" -compact  macros (excluding
 .It \\(de  .Sq DT ,
 .Pq degree  .Sq TH ,
 .It \\(ps  .Sq br ,
 .Pq paragraph  .Sq na ,
 .It \\(sc  .Sq sp ,
 .Pq section  .Sq nf ,
 .It \\(dg  and
 .Pq dagger  .Sq fi ) .
 .It \\(dd  .
 .Pq double dagger  .
 .It \\(ci  .Sh REFERENCE
 .Pq circle  This section is a canonical reference to all macros, arranged
 .It \\(ba  alphabetically.  For the scoping of individual macros, see
 .Pq bar  .Sx MACRO SYNTAX .
 .It \\(bb  .
 .Pq broken bar  .
 .It \\(Ba  .Ss Definitions
 .Pq bar, deprecated  In this reference, a numerical width may be either a standalone natural
 .It \\(co  number (such as 3, 4, 10, etc.) or a natural number followed by a width
 .Pq copyright  multiplier
 .It \\(rg  .Qq n ,
 .Pq registered  corresponding to the width of the formatted letter n, or
 .It \\(tm  .Qq m ,
 .Pq trademarked  corresponding to the width of the formatted letter m.  The latter is the
 .It \\&  default, if unspecified.  Thus,
 .Pq non-breaking space  .Bd -literal -offset indent
 .It \\e  \&.HP 12n
 .Pq escape  
 .It \\(Am  
 .Pq ampersand, deprecated  
 .El  
 .\" SECTION  
 .Sh STRUCTURE  
 Macros are case in-sensitive and one to three three characters in  
 length.  All follow the same structural rules:  
 .Bd -literal -offset XXXX  
 \&.Yo \(lBbody...\(rB  
 .Ed  .Ed
   .
 .Pp  .Pp
   indicates an offset of 12
   .Qq n
   .Ns -sized
   letters.
   .
   .
   .Ss Macro Reference
   .Bl -tag -width Ds
   .It B
   Text is rendered in bold face.
   .It 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.
   .It BR
   Text is rendered alternately in bold face and roman (the default font).
   Whitespace between arguments is omitted in output.
   .It DT
   Re-set the tab spacing to 0.5 inches.
   .It HP
   Begin a paragraph whose initial output line is left-justified, but
   subsequent output lines are indented, with the following syntax:
   .Bd -literal -offset indent
   \&.HP [width]
   .Ed
   .
   .Pp
   If
   .Va width
   is specified, it's saved for later paragraph left-margins; if
   unspecified, the saved or default width is used.
   .It I
   Text is rendered in italics.
   .It IB
   Text is rendered alternately in italics and bold face.  Whitespace
   between arguments is omitted in output.
   .It IP
   Begin a paragraph with the following syntax:
   .Bd -literal -offset indent
   \&.IP [head [width]]
   .Ed
   .
   .Pp
   This follows the behaviour of the
   .Sq TP
   except for the macro syntax (all arguments on the line, instead of
   having next-line scope).  If
   .Va width
   is specified, it's saved for later paragraph left-margins; if
   unspecified, the saved or default width is used.
   .It IR
   Text is rendered alternately in italics and roman (the default font).
   Whitespace between arguments is omitted in output.
   .It LP, P, PP
   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.
   .It R
   Text is rendered in roman (the default font).
   .It RB
   Text is rendered alternately in roman (the default font) and bold face.
   Whitespace between arguments is omitted in output.
   .It RE
   Explicitly close out the scope of a prior
   .Sq RS .
   .It RI
   Text is rendered alternately in roman (the default font) and italics.
   Whitespace between arguments is omitted in output.
   .It 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
   .Sq PP .
   The width may be specified as following:
   .Bd -literal -offset indent
   \&.RS [width]
   .Ed
   .
   .Pp
   If
   .Va width
   is not specified, the saved or default width is used.
   .It SB
   Text is rendered in small size (one point smaller than the default font)
   bold face.
   .It 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.
   .It SM
   Text is rendered in small size (one point smaller than the default
   font).
   .It 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.
   .It TH
   Sets the title of the manual page with the following syntax:
   .Bd -literal -offset indent
   \&.TH title section [date [source [volume]]]
   .Ed
   .
   .Pp
   At least the
   .Va title
   and
   .Va section
   arguments must be provided.  The
   .Va date
   argument should be formatted as
   .Qq %b [%d] %Y
   format, described in
   .Xr strptime 3 .
 The  The
 .Dq body  .Va source
 consists of zero or more arguments to the macro.  string specifies the organisation providing the utility.  The
 .\" PARAGRAPH  .Va volume
 .Sh MACROS  replaces the default rendered volume as dictated by the manual section.
 This section contains a complete list of all  .It TP
 .Nm  Begin a paragraph where the head, if exceeding the indentation width, is
 macros, arranged alphabetically, with the number of arguments.  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.
   .
 .Pp  .Pp
 .Bl -column "MacroX" "Arguments" -compact -offset XXXX  The indentation width may be set as follows:
 .It Em Macro Ta Em Arguments  .Bd -literal -offset indent
 .It \&.TH    Ta    >0  \&.TP [width]
 .It \&.SH    Ta    n  .Ed
 .It \&.SS    Ta    n  .
 .It \&.TP    Ta    n  .Pp
 .It \&.LP    Ta    n  Where
 .It \&.PP    Ta    n  .Va width
 .It \&.P     Ta    n  must be a properly-formed numeric width.  If
 .It \&.IP    Ta    n  .Va width
 .It \&.HP    Ta    n  is specified, it's saved for later paragraph left-margins; if
 .It \&.SM    Ta    n  unspecified, the saved or default width is used.
 .It \&.SB    Ta    n  .It br
 .It \&.BI    Ta    n  Breaks the current line.  Consecutive invocations have no further effect.
 .It \&.IB    Ta    n  .It fi
 .It \&.BR    Ta    n  End literal mode begun by
 .It \&.RB    Ta    n  .Sq nf .
 .It \&.R     Ta    n  .It i
 .It \&.B     Ta    n  Italicise arguments.  If no arguments are specified, all subsequent text
 .It \&.I     Ta    n  is italicised.
 .It \&.IR    Ta    n  .It na
   Don't alignment the right margin.
   .It nf
   Begin literal mode: all subsequent free-form lines have their end of
   line boundaries preserved.  May be ended by
   .Sq fi .
   .It r
   Fonts and styles (bold face, italics) reset to roman (default font).
   .It sp
   Insert n spaces, where n is the macro's positive numeric argument.  If
   0, this is equivalent to the
   .Sq br
   macro.
 .El  .El
 .\" SECTION  .
   .
   .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 ,
 .\" SECTION  .Xr mandoc_char 7
   .
   .
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  reference was written by
 .An Kristaps Dzonsons Aq kristaps@openbsd.org .  .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.1  
changed lines
  Added in v.1.32
CVSweb