=================================================================== RCS file: /cvs/mandoc/mandoc.1,v retrieving revision 1.1 retrieving revision 1.7 diff -u -p -r1.1 -r1.7 --- mandoc/mandoc.1 2009/03/19 16:17:27 1.1 +++ mandoc/mandoc.1 2009/03/23 09:42:43 1.7 @@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.1 2009/03/19 16:17:27 kristaps Exp $ +.\" $Id: mandoc.1,v 1.7 2009/03/23 09:42:43 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -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 23 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,50 @@ 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 only register as such as if they appear as +standalone tokens, either in parsed lines or streams of text. Thus, the +following fragment: +.Bd -literal -offset XXXX +this self is not that of the waking , empirically real man +.Ed +.\" PARAGRAPH +.Pp +\&...correctly adjusts the comma spacing to +.Dq this self is not that of the waking , empirically real man . +However, if the comma were part of +.Dq ,empirically , +it would not. +.\" SUB-SECTION .Ss Output Formats The .Nm @@ -143,27 +189,37 @@ 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. -.It -The \-literal and \-unfilled -.Sq \&Bd -displays only accept text contents. -.It -The -.Sq \&Xo/Xc -pair isn't supported. -.It -The -.Sq \&Sm -macro has no effect, yet. .El .Pp Other macros still aren't supported by virtue of nobody complaining about their absence. Please report any omissions: this is a work in progress. +.Pp +The following list documents differences between traditional +.Xr nroff 1 +output and +.Nm : +.Pp +.Bl -bullet -compact +.It +A list of display following +.Sq \&Ss +does not assert a prior vertical break, just as it doesn't with +.Sq \&Sh . +.It +Special characters don't follow the current font style. +.\" LIST-ITEM +.It +The \-literal and \-unfilled +.Sq \&Bd +displays types are synonyms, as are \-filled and \-ragged. +.El