=================================================================== RCS file: /cvs/mandoc/Attic/mdocterm.1,v retrieving revision 1.9 retrieving revision 1.15 diff -u -p -r1.9 -r1.15 --- mandoc/Attic/mdocterm.1 2009/03/02 17:29:16 1.9 +++ mandoc/Attic/mdocterm.1 2009/03/08 18:02:36 1.15 @@ -1,4 +1,4 @@ -.\" $Id: mdocterm.1,v 1.9 2009/03/02 17:29:16 kristaps Exp $ +.\" $Id: mdocterm.1,v 1.15 2009/03/08 18:02:36 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -16,8 +16,8 @@ .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 2 2009 $ -.Dt mdocmterm 1 +.Dd $Mdocdate: March 8 2009 $ +.Dt mdocterm 1 .Os .\" SECTION .Sh NAME @@ -26,7 +26,8 @@ .\" SECTION .Sh SYNOPSIS .Nm mdocmterm -.Op Fl v +.Op Fl vV +.Op Fl f Ns Ar option... .Op Fl W Ns Ar err... .Op Ar infile .\" SECTION @@ -36,11 +37,19 @@ The utility formats a BSD .Dq mdoc manual page for display on the terminal. The arguments are as follows: -.Bl -tag -width "\-Werr... " +.Bl -tag -width XXXXXXXXXXXX .\" ITEM .It Fl v Print verbose parsing output. .\" ITEM +.It Fl v +Print version and exit. +.\" ITEM +.It Fl f Ns Ar option... +Override default compiler behaviour. See +.Sx Compiler Options +for details. +.\" ITEM .It Fl W Ns Ar err... Print warning messages. May be set to .Fl W Ns Ar all @@ -75,29 +84,47 @@ input, documented at .Xr mdoc 7 and .Xr mdoc.samples 7 , -into an abstract syntax tree. -.\" PARAGRAPH +into an abstract syntax tree. .Pp -By default, -.Nm -reads from stdin and prints terminal-encoded output to stdout. +By default, +.Nm +reads from stdin and prints ANSI +.Qq raw +terminal-encoded output to stdout, at this time to a fixed column with +of 78 characters. .\" PARAGRAPH .Pp .Ex -std mdocmterm +.\" SUB-SECTION +.Ss Compiler Options +Default compiler behaviour may be overriden with the +.Fl f +flag. The available options are as follows: +.Bl -tag -width XXXXXXXXXXXX -offset XXXX +.It Fl f Ns Ar ign-scope +When rewinding the scope of a block macro, forces the compiler to ignore +scope violations. This can seriously mangle the resulting tree. +.It Fl f Ns Ar ign-escape +Ignore invalid escape sequences. +.El .\" PARAGRAPH .Pp -.Nm -is -.Ud +As with the +.Fl W +flag, multiple +.Fl f +options may be grouped and delimited with a comma. Using +.Fl f Ns Ar ign-scope,ign-escape , +for example, will try to ignore scope and character-escape errors. .\" 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 +Note that the \\x, \\(xx and \\[n] forms are described here; the \\*(xx, +\\*[n] 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]. +are deprecated, but still rendered. All one- and two-character +sequences may be used in the n-character sequence \\[n]. .Pp Note that the .Em Output @@ -106,23 +133,43 @@ column will render differently whether executed with or another output filter. .\" PARAGRAPH .Pp +Grammatic: +.Pp +.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact +.It Em Output +.Em Input (Name) +.It \(em +\\(em (em-dash) +.It \(en +\\(en (en-dash) +.It \- +\\- (hyphen) +.It \\ +\\\\ (back-slash) +.El +.\" PARAGRAPH +.Pp Enclosures: .Pp .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact .It Em Output .Em Input (Name) +.It \(ra +\\(ra (right angle) +.It \(la +\\(la (left angle) .It \(rB \\(rB (right bracket) .It \(lB -\\(rB (left bracket) +\\(lB (left bracket) .It \(lq \\(lq (left double-quote) .It \(rq \\(rq (right double-quote) .It \(oq -\\(lq (left single-quote) +\\(oq, \\` (left single-quote) .It \(aq -\\(aq (right single-quote, apostrophe) +\\(aq, \\' (right single-quote, apostrophe) .El .\" PARAGRAPH .Pp @@ -152,7 +199,7 @@ Mathematical: .It \(>= \\(>= (greater-than-equal) .It \(== -\\(== (greater-than-equal) +\\(== (equal) .It \(!= \\(!= (not equal) .It \(if @@ -161,13 +208,11 @@ Mathematical: \\(na (NaN)* .It \(+- \\(+- (plus-minus) +.It \(** +\\(** (asterisk) .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 @@ -189,7 +234,13 @@ Special symbols: \\(bu (bullet) .It \(ba \\(ba (bar) +.It \(co +\\(co (copyright) .El +.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. .\" SECTION .Sh EXAMPLES To display this manual page: @@ -200,7 +251,7 @@ To display this manual page: .Pp To pipe a manual page to the pager: .Pp -.D1 % mdocterm mdocterm.1 | less -R +.D1 % mdocterm mdocterm.1 2>&1 | less \-R .\" SECTION .Sh SEE ALSO .Xr mdoctree 1 , @@ -227,9 +278,9 @@ utility doesn't yet know how to display the following: .Pp .Bl -bullet -compact .It -Only \-bullet , \-dash , \-enum , \-hyphen , \-tag and \-ohang +The \-hang and \-column .Sq \&Bl -lists are supported. +lists are not yet supported. .It The \-literal and \-unfilled .Sq \&Bd @@ -238,4 +289,8 @@ displays only accept text contents. The .Sq \&Xo/Xc pair isn't supported (and never will be). +.It +The +.Sq \&Sm +macro has no effect, yet. .El