=================================================================== RCS file: /cvs/mandoc/Attic/mdocterm.1,v retrieving revision 1.10 retrieving revision 1.17 diff -u -p -r1.10 -r1.17 --- mandoc/Attic/mdocterm.1 2009/03/03 21:07:01 1.10 +++ mandoc/Attic/mdocterm.1 2009/03/11 00:39:58 1.17 @@ -1,4 +1,4 @@ -.\" $Id: mdocterm.1,v 1.10 2009/03/03 21:07:01 kristaps Exp $ +.\" $Id: mdocterm.1,v 1.17 2009/03/11 00:39:58 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 3 2009 $ -.Dt mdocmterm 1 +.Dd $Mdocdate: March 11 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,20 +84,55 @@ 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 +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 Input Encoding +The .Nm -is -.Ud +utility expects its input to be 7-bit ASCII as defined in +.Xr ascii 7 . +The only non-graphing characters accepted are spaces, +.Sq \ , +and tabs, +.Sq \et . +Tabs are only accepted in literal block-displays and as column +delimiters. +.Pp +Only Unix-style newlines (\en) are accepted; if the newline is escaped, +the line is concatenated with the next. .\" SUB-SECTION .Ss Character Escapes This section documents the character-escapes accepted by @@ -118,7 +162,7 @@ Grammatic: .It \- \\- (hyphen) .It \\ -\\ (back-slash) +\\\\ (back-slash) .El .\" PARAGRAPH .Pp @@ -127,18 +171,26 @@ 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 +\\(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) +\\(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 @@ -168,7 +220,7 @@ Mathematical: .It \(>= \\(>= (greater-than-equal) .It \(== -\\(== (greater-than-equal) +\\(== (equal) .It \(!= \\(!= (not equal) .It \(if @@ -220,7 +272,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 , @@ -247,9 +299,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 @@ -258,4 +310,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