=================================================================== RCS file: /cvs/mandoc/Attic/mdocterm.1,v retrieving revision 1.2 retrieving revision 1.7 diff -u -p -r1.2 -r1.7 --- mandoc/Attic/mdocterm.1 2009/02/22 11:23:19 1.2 +++ mandoc/Attic/mdocterm.1 2009/02/27 09:14:02 1.7 @@ -1,4 +1,4 @@ -.\" $Id: mdocterm.1,v 1.2 2009/02/22 11:23:19 kristaps Exp $ +.\" $Id: mdocterm.1,v 1.7 2009/02/27 09:14:02 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: February 22 2009 $ +.Dd $Mdocdate: February 27 2009 $ .Dt mdocmterm 1 .Os .\" SECTION @@ -89,6 +89,117 @@ reads from stdin and prints terminal-encoded output to .Nm is .Ud +.\" SUB-SECTION +.Ss Character Escapes +This section documents the character-escapes accepted by +.Xr mdocterm 1 . +Note that the \\x, \\(xx and \\[n] forms are described here; the \\*(xx +and \\*x forms described in +.Xr mdoc.samples 7 +are deprecated, but still correctly rendered. For all two-character +sequences, \\(xx is equivalent to the n-character \\[xx]. +.Pp +Note that the +.Em Output +column will render differently whether executed with +.Xr mdocterm 1 +or another output filter. +.\" PARAGRAPH +.Pp +Enclosures: +.Pp +.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact +.It Em Output +.Em Input (Name) +.El +.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact +.It \(rB +\\(rB (right bracket) +.It \(lB +\\(rB (left bracket) +.It \(lq +\\(lq (left double-quote) +.It \(rq +\\(rq (right double-quote) +.It \(oq +\\(lq (left single-quote) +.It \(aq +\\(aq (right single-quote, apostrophe) +.El +.\" PARAGRAPH +.Pp +Indicatives: +.Pp +.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact +.It Em Output +.Em Input (Name) +.El +.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact +.It \(<- +\\(<- (left arrow) +.It \(-> +\\(-> (right arrow) +.It \(ua +\\(ua (up arrow) +.It \(da +\\(da (down arrow) +.El +.\" PARAGRAPH +.Pp +Mathematical: +.Pp +.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact +.It Em Output +.Em Input (Name) +.El +.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact +.It \(<= +\\(<= (less-than-equal) +.It \(>= +\\(>= (greater-than-equal) +.It \(== +\\(== (greater-than-equal) +.It \(!= +\\(!= (not equal) +.It \(if +\\(if (infinity) +.It \(na +\\(na (NaN)* +.It \(+- +\\(+- (plus-minus) +.El +.\" PARAGRAPH +.Pp +*This is a deviation from the standard, as NaN is usually rendered as +\\*(Na, which is a deprecated form. We introduce \\(na, which follows +the more general syntax. +.Pp +Diacritics: +.Pp +.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact +.It Em Output +.Em Input (Name) +.El +.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact +.It \(ga +\\(ga (accent grave) +.It \(aa +\\(aa (accent accute) +.El +.\" PARAGRAPH +.Pp +Special symbols: +.Pp +.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact +.It Em Output +.Em Input (Name) +.El +.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact +.It \(bu +\\(bu (bullet) +.It \(ba +\\(ba (bar) +.El .\" SECTION .Sh EXAMPLES To display this manual page: @@ -103,6 +214,7 @@ To pipe a manual page to the pager: .\" SECTION .Sh SEE ALSO .Xr mdoctree 1 , +.Xr mdoclint 1 , .Xr mdoc.samples 7 , .Xr mdoc 7 , .Xr mdoc 3 @@ -116,4 +228,5 @@ utility was written by .Sh CAVEATS See .Xr mdoc 3 -for a list of bugs, caveats, and incomplete macros. +for a list of bugs, caveats, and incomplete macros regarding the +document parse.