Stripping of Xo/Xc macros in main.c (ifdef STRIP_XO).

[mandoc.git] / mandoc.1

diff --git a/mandoc.1 b/mandoc.1
index 7e32f7ffcc4fb3c207d0b4d816220a2a8c8ffbd0..88b47c56651559264ac1fa3de72fac33629446eb 100644 (file)
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,4 +1,4 @@
-.\" $Id: mandoc.1,v 1.1 2009/03/19 16:17:27 kristaps Exp $
+.\" $Id: mandoc.1,v 1.5 2009/03/21 21:09:00 kristaps Exp $
 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
 .\"
@@ -16,7 +16,7 @@
 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 .\" PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: March 19 2009 $
+.Dd $Mdocdate: March 21 2009 $
 .Dt mandoc 1
 .Os
 .\" SECTION
@@ -72,7 +72,9 @@ arguments may be comma-separated, such as
 .It Ar infile...
 Read input from zero or more
 .Ar infile .
-If unspecified, reads from stdin.
+If unspecified, reads from stdin.  If multiple files are specified,
+.Nm
+will halt with the first failed parse.
 .El
 .\" PARAGRAPH
 .Pp
@@ -86,6 +88,45 @@ were provided.
 .Pp
 .Ex -std mandoc
 .\" SUB-SECTION
+.Ss Reserved Words
+The reserved words described in
+.Xr mdoc 7
+are handled according to the following rules:
+.Bl -enum -offset XXX
+.It
+Opening delimiters 
+.Po
+.Sq \&( , 
+.Sq \&[ , 
+and
+.Sq \&{
+.Pc are not followed by whitespace.
+.It
+Closing delimiters
+.Po
+.Sq \&. , 
+.Sq \&, , 
+.Sq \&; , 
+.Sq \&: , 
+.Sq \&? , 
+.Sq \&! , 
+.Sq \&) , 
+.Sq \&] 
+and
+.Sq \&}
+.Pc are not preceeded by whitespace.
+.El
+.\" PARAGRAPH
+.Pp
+Note that reserved words may occur in streams of text, so the following:
+.Bd -literal -offset XXXX
+this self is not that of the waking , empirically real man
+.Ed
+.\" PARAGRAPH
+.Pp
+\&...correctly adjusts the comma spacing to
+.Qq this self is not that of the waking , empirically real man .
+.\" SUB-SECTION
 .Ss Output Formats
 The
 .Nm
@@ -143,25 +184,30 @@ utility was written by
 .Sh CAVEATS
 The 
 .Nm
-utility doesn't yet know how to display the following:
+utility in
+.Fl T Ns Ar ascii
+mode doesn't yet know how to display the following:
 .Pp
 .Bl -bullet -compact
 .It
 The \-hang 
 .Sq \&Bl
 list is not yet supported.
+.\" LIST-ITEM
 .It
 The \-literal and \-unfilled 
 .Sq \&Bd
-displays only accept text contents.
+displays types are synonyms, as are \-filled and \-ragged.
+.\" LIST-ITEM
 .It
 The
 .Sq \&Xo/Xc
 pair isn't supported.
+.\" LIST-ITEM
 .It
 The
-.Sq \&Sm
-macro has no effect, yet.
+.Sq \&Bd
+macro doesn't process \-compact .
 .El
 .Pp
 Other macros still aren't supported by virtue of nobody complaining