=================================================================== RCS file: /cvs/mandoc/Attic/mdocterm.1,v retrieving revision 1.13 retrieving revision 1.26 diff -u -p -r1.13 -r1.26 --- mandoc/Attic/mdocterm.1 2009/03/04 14:13:05 1.13 +++ mandoc/Attic/mdocterm.1 2009/03/19 11:49:00 1.26 @@ -1,6 +1,6 @@ -.\" $Id: mdocterm.1,v 1.13 2009/03/04 14:13:05 kristaps Exp $ +.\" $Id: mdocterm.1,v 1.26 2009/03/19 11:49:00 kristaps Exp $ .\" -.\" Copyright (c) 2009 Kristaps Dzonsons +.\" Copyright (c) 2009 Kristaps Dzonsons .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the @@ -16,19 +16,20 @@ .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 4 2009 $ -.Dt mdocmterm 1 +.Dd $Mdocdate: March 19 2009 $ +.Dt mdocterm 1 .Os .\" SECTION .Sh NAME -.Nm mdocmterm +.Nm mdocterm .Nd mdoc macro compiler .\" SECTION .Sh SYNOPSIS -.Nm mdocmterm -.Op Fl v +.Nm mdocterm +.Op Fl V +.Op Fl f Ns Ar option... .Op Fl W Ns Ar err... -.Op Ar infile +.Op Ar infile... .\" SECTION .Sh DESCRIPTION The @@ -36,11 +37,16 @@ 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. +.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 @@ -56,12 +62,10 @@ termination. Multiple arguments may be comma-separated, such as .Fl W Ns Ar error,all . .\" ITEM -.It Ar infile -Read input from -.Ar infile , -which may be -.Dq \- -for stdin. +.It Ar infile... +Read input from zero or more +.Ar infile . +If unspecified, reads from stdin. .El .\" PARAGRAPH .Pp @@ -75,161 +79,70 @@ input, documented at .Xr mdoc 7 and .Xr mdoc.samples 7 , -into an abstract syntax tree. +into an abstract syntax tree. .\" PARAGRAPH .Pp -By default, -.Nm -reads from stdin and prints terminal-encoded output to stdout. +By default, +.Nm +reads from stdin and prints nroff +.Qq backspace +terminal-encoded output to stdout, at this time to a fixed column with +of 78 characters. .\" PARAGRAPH .Pp -.Ex -std mdocmterm +.Ex -std mdocterm +.\" 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]. +The +.Nm +utility correctly renders all +.Sx Special Characters +in +.Xr mdoc 7 +in 7-bit ASCII. .Pp -Note that the -.Em Output -column will render differently whether executed with -.Xr mdocterm 1 -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 -\\(lB (left bracket) -.It \(lq -\\(lq (left double-quote) -.It \(rq -\\(rq (right double-quote) -.It \(oq -\\(oq, \\` (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) -.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) -.It \(<= -\\(<= (less-than-equal) -.It \(>= -\\(>= (greater-than-equal) -.It \(== -\\(== (equal) -.It \(!= -\\(!= (not equal) -.It \(if -\\(if (infinity) -.It \(na -\\(na (NaN)* -.It \(+- -\\(+- (plus-minus) -.It \(** -\\(** (asterisk) -.El -.\" PARAGRAPH -.Pp -Diacritics: -.Pp -.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact -.It Em Output -.Em Input (Name) -.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) -.It \(bu -\\(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. +In the general sense, +.Nm +will make a +.Pq best-effort +to render complex characters; however, if a manual is using considerable +special characters, some meaning may be lost in translation. .\" SECTION .Sh EXAMPLES To display this manual page: .\" PARAGRAPH .Pp -.D1 % mdocmterm \-Wall,error mdocmterm.1 +.D1 % mdocterm \-Wall,error mdocterm.1 .\" PARAGRAPH .Pp To pipe a manual page to the pager: .Pp -.D1 % mdocterm mdocterm.1 | less \-R +.D1 % mdocterm mdocterm.1 | less .\" SECTION .Sh SEE ALSO -.Xr mdoctree 1 , -.Xr mdoclint 1 , -.Xr mdoc.samples 7 , .Xr mdoc 7 , .Xr mdoc 3 .\" @@ -237,7 +150,7 @@ To pipe a manual page to the pager: The .Nm utility was written by -.An Kristaps Dzonsons Aq kristaps@kth.se . +.An Kristaps Dzonsons Aq kristaps@openbsd.org . .\" SECTION .Sh CAVEATS See @@ -251,9 +164,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