[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.4

version 1.1, 2009/03/23 16:02:56 version 1.4, 2009/03/26 16:23:22
Line 34  structure of the 
Line 34  structure of the 
 .Nm  .Nm
 language.  language.
 .Pp  .Pp
 .Em \&Do not  .Em \&Do not ever
 use  use
 .Nm  .Nm
 to write your manuals.  Use the  to write your manuals.  Use the
Line 46  An
Line 46  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
Line 69  line termination.  
Line 69  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 also assert a
 vertical space.  vertical space.
   .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.
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss Special Characters  .Ss Special Characters
 Special character sequences begin with the escape character  Special character sequences begin with the escape character
 .Sq \\  .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
Line 82  for n-character sequences (terminated at a close-brack
Line 89  for n-character sequences (terminated at a close-brack
 or a single one-character sequence.  or a single one-character sequence.
 .Pp  .Pp
 Characters may alternatively be escaped by a slash-asterisk,  Characters may alternatively be escaped by a slash-asterisk,
 .Sq \\* ,  .Sq \e* ,
 with the same combinations as described above.  This form is deprecated.  with the same combinations as described above.  This form is deprecated.
 .Pp  .Pp
 The following is a table of all available escapes.  The
   .Xr mdoc 7
   contains a table of all available escapes.
   .\" SECTION
   .Sh STRUCTURE
   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
 Grammatic:  All
 .Bl -tag -width 12n -offset "XXXX" -compact  .Nm
 .It \\(em  macros follow the same structural rules:
 .Pq em-dash  .Bd -literal -offset indent
 .It \\(en  \&.YO \(lBbody...\(rB
 .Pq en-dash  .Ed
 .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  
 .Pp  .Pp
 Enclosures:  The
 .Bl -tag -width 12n -offset "XXXX" -compact  .Dq body
 .It \\(lh  consists of zero or more arguments to the macro.
 .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:  .Nm
 .Bl -tag -width 12n -offset "XXXX" -compact  has a primitive notion of multi-line scope for the following macros:
 .It \\(<-  .Sq \&.TM ,
 .Pq left arrow  .Sq \&.SM ,
 .It \\(->  .Sq \&.SB ,
 .Pq right arrow  .Sq \&.BI ,
 .It \\(ua  .Sq \&.IB ,
 .Pq up arrow  .Sq \&.BR ,
 .It \\(da  .Sq \&.RB ,
 .Pq down arrow  .Sq \&.R ,
 .It \\(<>  .Sq \&.B ,
 .Pq left-right arrow  .Sq \&.I ,
 .It \\(lA  .Sq \&.IR
 .Pq left double-arrow  and
 .It \\(rA  .Sq \&.RI .
 .Pq right double-arrow  When these macros are invoked without arguments, the subsequent line is
 .It \\(uA  considered a continuation of the macro.  Thus:
 .Pq up double-arrow  .Bd -literal -offset indent
 .It \\(dA  \&.RI foo
 .Pq down double-arrow  .Ed
 .It \\(hA  
 .Pq left-right double-arrow  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Mathematical:  and
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bd -literal -offset indent
 .It \\(es  \&.RI
 .Pq empty set  foo
 .It \\(ca  .Ed
 .Pq intersection  
 .It \\(cu  
 .Pq union  
 .It \\(gr  
 .Pq gradient  
 .It \\(pd  
 .Pq partial differential  
 .It \\(ap  
 .Pq similarity  
 .It \\(=)  
 .Pq proper superset  
 .It \\((=  
 .Pq proper subset  
 .It \\(eq  
 .Pq equals  
 .It \\(di  
 .Pq division  
 .It \\(mu  
 .Pq multiplication  
 .It \\(pl  
 .Pq addition  
 .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:  are equivalent.  If two consecutive lines exhibit the latter behaviour,
 .Bl -tag -width 12n -offset "XXXX" -compact  an error is raised.  Thus, the following is acceptable:
 .It \\(ss  .Bd -literal -offset indent
 .Pq German eszett  \&.RI
 .It \\(AE  \&.I Hello, world.
 .Pq upper-case AE  foo
 .It \\(ae  .Ed
 .Pq lower-case AE  
 .It \\(OE  
 .Pq upper-case OE  
 .It \\(oe  
 .Pq lower-case OE  
 .It \\(ff  
 .Pq ff ligature  
 .It \\(fi  
 .Pq fi ligature  
 .It \\(fl  
 .Pq fl ligature  
 .It \\(Fi  
 .Pq ffi ligature  
 .It \\(Fl  
 .Pq ffl ligature  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Diacritics and letters:  The following, however, is not:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bd -literal -offset indent
 .It \\(ga  \&.RI
 .Pq grave accent  \&.I
 .It \\(aa  Hello, world.
 .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  
 Monetary:  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(Cs  
 .Pq Scandinavian  
 .It \\(Do  
 .Pq dollar  
 .It \\(Po  
 .Pq pound  
 .It \\(Ye  
 .Pq yen  
 .It \\(Fn  
 .Pq florin  
 .It \\(ct  
 .Pq cent  
 .El  
 .\" PARAGRAPH  
 .Pp  
 Special symbols:  
 .Bl -tag -width 12n -offset "XXXX" -compact  
 .It \\(de  
 .Pq degree  
 .It \\(ps  
 .Pq paragraph  
 .It \\(sc  
 .Pq section  
 .It \\(dg  
 .Pq dagger  
 .It \\(dd  
 .Pq double dagger  
 .It \\(ci  
 .Pq circle  
 .It \\(ba  
 .Pq bar  
 .It \\(bb  
 .Pq broken bar  
 .It \\(Ba  
 .Pq bar, deprecated  
 .It \\(co  
 .Pq copyright  
 .It \\(rg  
 .Pq registered  
 .It \\(tm  
 .Pq trademarked  
 .It \\&  
 .Pq non-breaking space  
 .It \\e  
 .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
 The  The
 .Dq body  .Sq \&.TP
 consists of zero or more arguments to the macro.  macro has similar behaviour, but does not need an empty argument line in
   order to trigger scope.
 .\" PARAGRAPH  .\" PARAGRAPH
 .Sh MACROS  .Sh MACROS
 This section contains a complete list of all  This section contains a complete list of all
 .Nm  .Nm
 macros, arranged alphabetically, with the number of arguments.  macros, arranged alphabetically, with the number of arguments.
 .Pp  .Pp
 .Bl -column "MacroX" "Arguments" -compact -offset XXXX  .Bl -column "MacroX" "Arguments" -compact -offset indent
 .It Em Macro Ta Em Arguments  .It Em Macro Ta Em Arguments
 .It \&.TH    Ta    >0  .It \&.TH    Ta    >1, <6
 .It \&.SH    Ta    n  .It \&.SH    Ta    >0
 .It \&.SS    Ta    n  .It \&.SS    Ta    >0
 .It \&.TP    Ta    n  .It \&.TP    Ta    n
 .It \&.LP    Ta    n  .It \&.LP    Ta    0
 .It \&.PP    Ta    n  .It \&.PP    Ta    0
 .It \&.P     Ta    n  .It \&.P     Ta    0
 .It \&.IP    Ta    n  .It \&.IP    Ta    <3
 .It \&.HP    Ta    n  .It \&.HP    Ta    <2
 .It \&.SM    Ta    n  .It \&.SM    Ta    n
 .It \&.SB    Ta    n  .It \&.SB    Ta    n
 .It \&.BI    Ta    n  .It \&.BI    Ta    n
Line 537  macros, arranged alphabetically, with the number of ar
Line 191  macros, arranged alphabetically, with the number of ar
 .It \&.B     Ta    n  .It \&.B     Ta    n
 .It \&.I     Ta    n  .It \&.I     Ta    n
 .It \&.IR    Ta    n  .It \&.IR    Ta    n
   .It \&.RI    Ta    n
 .El  .El
 .\" SECTION  .\" SECTION
 .Sh SEE ALSO  .Sh SEE ALSO
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.4
CVSweb