=================================================================== RCS file: /cvs/mandoc/Attic/mdocterm.1,v retrieving revision 1.14 retrieving revision 1.20 diff -u -p -r1.14 -r1.20 --- mandoc/Attic/mdocterm.1 2009/03/06 14:13:47 1.14 +++ mandoc/Attic/mdocterm.1 2009/03/14 12:35:02 1.20 @@ -1,4 +1,4 @@ -.\" $Id: mdocterm.1,v 1.14 2009/03/06 14:13:47 kristaps Exp $ +.\" $Id: mdocterm.1,v 1.20 2009/03/14 12:35: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: March 6 2009 $ +.Dd $Mdocdate: March 14 2009 $ .Dt mdocterm 1 .Os .\" SECTION @@ -26,7 +26,9 @@ .\" SECTION .Sh SYNOPSIS .Nm mdocmterm -.Op Fl v +.Op Fl vV +.Op Fl f Ns Ar option... +.Op Fl O Ns Ar option... .Op Fl W Ns Ar err... .Op Ar infile .\" SECTION @@ -36,11 +38,28 @@ 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 O Ns Ar option... +Terminal-encoding options. May be set to +.Fl O Ns Ar ansi +for ANSI/VT100-encoded output (the default) or +.Fl O Ns Ar nroff +for nroff-encoded +.Qq backspace +output. +.\" ITEM .It Fl W Ns Ar err... Print warning messages. May be set to .Fl W Ns Ar all @@ -75,30 +94,46 @@ 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. +.It Fl f Ns Ar ign-macro +Ignore unknown macros at the start of input lines. +.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, -\\*[n] and \\*x forms described in -.Xr mdoc.samples 7 -are deprecated, but still rendered. All one- and two-character -sequences may be used in the n-character sequence \\[n]. -.Pp +The following table shows all +.Xr mdoc 7 +character escapes rendered by +.Nm . Note that the .Em Output column will render differently whether executed with @@ -127,6 +162,10 @@ Enclosures: .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact .It Em Output .Em Input (Name) +.It \(rC +\\(rC (right brace) +.It \(lC +\\(lC (left brace) .It \(ra \\(ra (right angle) .It \(la @@ -135,6 +174,8 @@ Enclosures: \\(rB (right bracket) .It \(lB \\(lB (left bracket) +.It \q +\\q (double-quote) .It \(lq \\(lq (left double-quote) .It \(rq @@ -216,7 +257,7 @@ Special symbols: the more general syntax. .\" SECTION .Sh EXAMPLES -To display this manual page: +To display this manual page on ANSI-capable terminal: .\" PARAGRAPH .Pp .D1 % mdocmterm \-Wall,error mdocmterm.1 @@ -224,7 +265,7 @@ To display this manual page: .Pp To pipe a manual page to the pager: .Pp -.D1 % mdocterm mdocterm.1 | less \-R +.D1 % mdocterm -Onroff mdocterm.1 | less .\" SECTION .Sh SEE ALSO .Xr mdoctree 1 , @@ -251,9 +292,9 @@ utility doesn't yet know how to display the following: .Pp .Bl -bullet -compact .It -The \-hang and \-column +The \-hang .Sq \&Bl -lists are not yet supported. +list is not yet supported. .It The \-literal and \-unfilled .Sq \&Bd