]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc.7
Spelling "preceed" -> "precede" (naddy).
[mandoc.git] / mdoc.7
diff --git a/mdoc.7 b/mdoc.7
index 90f1f68a8a960f6f00b7c1fd3462a6e2ed34741c..aec7fadf0d73e786c83371c2cee6f5f937018733 100644 (file)
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.7,v 1.17 2009/03/26 23:01:26 kristaps Exp $
+.\" $Id: mdoc.7,v 1.21 2009/04/12 19:30:45 kristaps Exp $
 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
 .\"
 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
 .\"
@@ -16,8 +16,8 @@
 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 .\" PERFORMANCE OF THIS SOFTWARE.
 .\" 
 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 .\" PERFORMANCE OF THIS SOFTWARE.
 .\" 
-.Dd $Mdocdate: March 26 2009 $
-.Dt mdoc 7
+.Dd $Mdocdate: April 12 2009 $
+.Dt MDOC 7
 .Os
 .\" SECTION
 .Sh NAME
 .Os
 .\" SECTION
 .Sh NAME
@@ -122,421 +122,6 @@ or a single one-character sequence.
 Characters may alternatively be escaped by a slash-asterisk,
 .Sq \e* ,
 with the same combinations as described above.  This form is deprecated.  
 Characters may alternatively be escaped by a slash-asterisk,
 .Sq \e* ,
 with the same combinations as described above.  This form is deprecated.  
-.Pp
-The following is a table of all available escapes.
-.Pp
-Grammatic:
-.Bl -tag -width 12n -offset "XXXX" -compact
-.It \e(em
-.Pq em-dash
-.It \e(en
-.Pq en-dash
-.It \e-
-.Pq hyphen
-.It \e\e
-.Pq back-slash
-.It \e'
-.Pq apostrophe
-.It \e`
-.Pq back-tick
-.It \e
-.Pq space
-.It \e.
-.Pq period
-.It \e(r!
-.Pq upside-down exclamation
-.It \e(r?
-.Pq upside-down question
-.El
-.\" PARAGRAPH
-.Pp
-Enclosures:
-.Bl -tag -width 12n -offset "XXXX" -compact
-.It \e(lh
-.Pq left hand
-.It \e(rh
-.Pq right hand
-.It \e(Fo
-.Pq left guillemet
-.It \e(Fc
-.Pq right guillemet
-.It \e(fo
-.Pq left guilsing
-.It \e(fc
-.Pq right guilsing
-.It \e(rC
-.Pq right brace
-.It \e(lC
-.Pq left brace
-.It \e(ra
-.Pq right angle
-.It \e(la
-.Pq left angle
-.It \e(rB
-.Pq right bracket
-.It \e(lB
-.Pq left bracket
-.It \eq
-.Pq double-quote
-.It \e(lq
-.Pq left double-quote
-.It \e(Lq
-.Pq left double-quote, deprecated
-.It \e(rq
-.Pq right double-quote
-.It \e(Rq
-.Pq right double-quote, deprecated
-.It \e(oq
-.Pq left single-quote
-.It \e(aq
-.Pq right single-quote
-.It \e(Bq
-.Pq right low double-quote
-.It \e(bq
-.Pq right low single-quote
-.El
-.\" PARAGRAPH
-.Pp
-Indicatives:
-.Bl -tag -width 12n -offset "XXXX" -compact
-.It \e(<-
-.Pq left arrow
-.It \e(->
-.Pq right arrow
-.It \e(ua
-.Pq up arrow
-.It \e(da
-.Pq down arrow
-.It \e(<>
-.Pq left-right arrow
-.It \e(lA
-.Pq left double-arrow
-.It \e(rA
-.Pq right double-arrow
-.It \e(uA
-.Pq up double-arrow
-.It \e(dA
-.Pq down double-arrow
-.It \e(hA
-.Pq left-right double-arrow
-.El
-.\" PARAGRAPH
-.Pp
-Mathematical:
-.Bl -tag -width 12n -offset "XXXX" -compact
-.It \e(es
-.Pq empty set
-.It \e(ca
-.Pq intersection
-.It \e(cu
-.Pq union
-.It \e(gr
-.Pq gradient
-.It \e(pd
-.Pq partial differential
-.It \e(ap
-.Pq similarity
-.It \e(=)
-.Pq proper superset
-.It \e((=
-.Pq proper subset
-.It \e(eq
-.Pq equals
-.It \e(di
-.Pq division
-.It \e(mu
-.Pq multiplication
-.It \e(pl
-.Pq addition
-.It \e(nm
-.Pq not element
-.It \e(mo
-.Pq element
-.It \e(Im
-.Pq imaginary
-.It \e(Re
-.Pq real
-.It \e(Ah
-.Pq aleph
-.It \e(te
-.Pq existential quantifier
-.It \e(fa
-.Pq universal quantifier
-.It \e(AN
-.Pq logical AND
-.It \e(OR
-.Pq logical OR
-.It \e(no
-.Pq logical NOT
-.It \e(st
-.Pq such that
-.It \e(tf
-.Pq therefore
-.It \e(~~
-.Pq approximate
-.It \e(~=
-.Pq approximately equals
-.It \e(=~
-.Pq congruent
-.It \e(Gt
-.Pq greater-than, deprecated
-.It \e(Lt
-.Pq less-than, deprecated
-.It \e(<=
-.Pq less-than-equal
-.It \e(Le
-.Pq less-than-equal, deprecated
-.It \e(>=
-.Pq greater-than-equal
-.It \e(Ge
-.Pq greater-than-equal
-.It \e(==
-.Pq equal
-.It \e(!=
-.Pq not equal
-.It \e(Ne
-.Pq not equal, deprecated
-.It \e(if
-.Pq infinity
-.It \e(If
-.Pq infinity, deprecated
-.It \e(na
-.Pq NaN , an extension
-.It \e(Na
-.Pq NaN, deprecated
-.It \e(+-
-.Pq plus-minus
-.It \e(Pm
-.Pq plus-minus, deprecated
-.It \e(**
-.Pq asterisk
-.El
-.\" PARAGRAPH
-.Pp
-Ligatures:
-.Bl -tag -width 12n -offset "XXXX" -compact
-.It \e(ss
-.Pq German eszett
-.It \e(AE
-.Pq upper-case AE
-.It \e(ae
-.Pq lower-case AE
-.It \e(OE
-.Pq upper-case OE
-.It \e(oe
-.Pq lower-case OE
-.It \e(ff
-.Pq ff ligature
-.It \e(fi
-.Pq fi ligature
-.It \e(fl
-.Pq fl ligature
-.It \e(Fi
-.Pq ffi ligature
-.It \e(Fl
-.Pq ffl ligature
-.El
-.\" PARAGRAPH
-.Pp
-Diacritics and letters:
-.Bl -tag -width 12n -offset "XXXX" -compact
-.It \e(ga
-.Pq grave accent
-.It \e(aa
-.Pq accute accent
-.It \e(a"
-.Pq umlaut accent
-.It \e(ad
-.Pq dieresis accent
-.It \e(a~
-.Pq tilde accent
-.It \e(a^
-.Pq circumflex accent
-.It \e(ac
-.Pq cedilla accent
-.It \e(ad
-.Pq dieresis accent
-.It \e(ah
-.Pq caron accent
-.It \e(ao
-.Pq ring accent
-.It \e(ho
-.Pq hook accent
-.It \e(ab
-.Pq breve accent
-.It \e(a-
-.Pq macron accent
-.It \e(-D
-.Pq upper-case eth
-.It \e(Sd
-.Pq lower-case eth
-.It \e(TP
-.Pq upper-case thorn
-.It \e(Tp
-.Pq lower-case thorn
-.It \e('A
-.Pq upper-case acute A
-.It \e('E
-.Pq upper-case acute E
-.It \e('I
-.Pq upper-case acute I
-.It \e('O
-.Pq upper-case acute O
-.It \e('U
-.Pq upper-case acute U
-.It \e('a
-.Pq lower-case acute a
-.It \e('e
-.Pq lower-case acute e
-.It \e('i
-.Pq lower-case acute i
-.It \e('o
-.Pq lower-case acute o
-.It \e('u
-.Pq lower-case acute u
-.It \e(`A
-.Pq upper-case grave A
-.It \e(`E
-.Pq upper-case grave E
-.It \e(`I
-.Pq upper-case grave I
-.It \e(`O
-.Pq upper-case grave O
-.It \e(`U
-.Pq upper-case grave U
-.It \e(`a
-.Pq lower-case grave a
-.It \e(`e
-.Pq lower-case grave e
-.It \e(`i
-.Pq lower-case grave i
-.It \e(`o
-.Pq lower-case grave o
-.It \e(`u
-.Pq lower-case grave u
-.It \e(~A
-.Pq upper-case tilde A
-.It \e(~N
-.Pq upper-case tilde N
-.It \e(~O
-.Pq upper-case tilde O
-.It \e(~a
-.Pq lower-case tilde a
-.It \e(~n
-.Pq lower-case tilde n
-.It \e(~o
-.Pq lower-case tilde o
-.It \e(:A
-.Pq upper-case dieresis A
-.It \e(:E
-.Pq upper-case dieresis E
-.It \e(:I
-.Pq upper-case dieresis I
-.It \e(:O
-.Pq upper-case dieresis O
-.It \e(:U
-.Pq upper-case dieresis U
-.It \e(:a
-.Pq lower-case dieresis a
-.It \e(:e
-.Pq lower-case dieresis e
-.It \e(:i
-.Pq lower-case dieresis i
-.It \e(:o
-.Pq lower-case dieresis o
-.It \e(:u
-.Pq lower-case dieresis u
-.It \e(:y
-.Pq lower-case dieresis y
-.It \e(^A
-.Pq upper-case circumflex A
-.It \e(^E
-.Pq upper-case circumflex E
-.It \e(^I
-.Pq upper-case circumflex I
-.It \e(^O
-.Pq upper-case circumflex O
-.It \e(^U
-.Pq upper-case circumflex U
-.It \e(^a
-.Pq lower-case circumflex a
-.It \e(^e
-.Pq lower-case circumflex e
-.It \e(^i
-.Pq lower-case circumflex i
-.It \e(^o
-.Pq lower-case circumflex o
-.It \e(^u
-.Pq lower-case circumflex u
-.It \e(,C
-.Pq upper-case cedilla C
-.It \e(,c
-.Pq lower-case cedilla c
-.It \e(/L
-.Pq upper-case stroke L
-.It \e(/l
-.Pq lower-case stroke l
-.It \e(/O
-.Pq upper-case stroke O
-.It \e(/o
-.Pq lower-case stroke o
-.It \e(oA
-.Pq upper-case ring A
-.It \e(oa
-.Pq lower-case ring a
-.El
-.\" PARAGRAPH
-.Pp
-Monetary:
-.Bl -tag -width 12n -offset "XXXX" -compact
-.It \e(Cs
-.Pq Scandinavian
-.It \e(Do
-.Pq dollar
-.It \e(Po
-.Pq pound
-.It \e(Ye
-.Pq yen
-.It \e(Fn
-.Pq florin
-.It \e(ct
-.Pq cent
-.El
-.\" PARAGRAPH
-.Pp
-Special symbols:
-.Bl -tag -width 12n -offset "XXXX" -compact
-.It \e(de
-.Pq degree
-.It \e(ps
-.Pq paragraph
-.It \e(sc
-.Pq section
-.It \e(dg
-.Pq dagger
-.It \e(dd
-.Pq double dagger
-.It \e(ci
-.Pq circle
-.It \e(ba
-.Pq bar
-.It \e(bb
-.Pq broken bar
-.It \e(Ba
-.Pq bar, deprecated
-.It \e(co
-.Pq copyright
-.It \e(rg
-.Pq registered
-.It \e(tm
-.Pq trademarked
-.It \e&
-.Pq non-breaking space
-.It \ee
-.Pq escape
-.It \e(Am
-.Pq ampersand, deprecated
-.El 
 .\" SECTION
 .Sh STRUCTURE
 Macros are classified in an ontology described by their scope rules.
 .\" SECTION
 .Sh STRUCTURE
 Macros are classified in an ontology described by their scope rules.
@@ -851,7 +436,7 @@ then the macro accepts an arbitrary number of arguments.
 .It \&.Bsx   Ta    Yes   Ta    Yes     Ta    n
 .It \&.Bx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Db    Ta    \&No  Ta    \&No    Ta    1
 .It \&.Bsx   Ta    Yes   Ta    Yes     Ta    n
 .It \&.Bx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Db    Ta    \&No  Ta    \&No    Ta    1
-.It \&.Em    Ta    Yes   Ta    Yes     Ta    n
+.It \&.Em    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Fx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ms    Ta    \&No  Ta    Yes     Ta    >0
 .It \&.No    Ta    Yes   Ta    Yes     Ta    0
 .It \&.Fx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ms    Ta    \&No  Ta    Yes     Ta    >0
 .It \&.No    Ta    Yes   Ta    Yes     Ta    0
@@ -909,7 +494,7 @@ lists will restart the sequence only for the sub-list.
 .\" LIST-ITEM
 .It
 .Sq \&.It \-column
 .\" LIST-ITEM
 .It
 .Sq \&.It \-column
-syntax where column widths may be preceeded by other arguments (instead
+syntax where column widths may be preceded by other arguments (instead
 of proceeded) is not supported.
 .\" LIST-ITEM
 .It
 of proceeded) is not supported.
 .\" LIST-ITEM
 .It
@@ -941,7 +526,8 @@ is callable.
 .El
 .\" SECTION
 .Sh SEE ALSO
 .El
 .\" SECTION
 .Sh SEE ALSO
-.Xr mandoc 1
+.Xr mandoc 1 ,
+.Xr mandoc_char 7
 .\" SECTION
 .Sh AUTHORS
 The
 .\" SECTION
 .Sh AUTHORS
 The
@@ -974,7 +560,7 @@ which ostensibly follows it, should follow the same convention as
 .It
 .Sq \&.Va
 should formalise that only one or two arguments are acceptable: a
 .It
 .Sq \&.Va
 should formalise that only one or two arguments are acceptable: a
-variable name and optional, preceeding type.
+variable name and optional, preceding type.
 .\" LIST-ITEM
 .It
 .Sq \&.Fd
 .\" LIST-ITEM
 .It
 .Sq \&.Fd