[BACK]Return to mdocterm.1 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/mdocterm.1 between version 1.21 and 1.26

version 1.21, 2009/03/15 07:08:52 version 1.26, 2009/03/19 11:49:00
Line 1 
Line 1 
 .\" $Id$  .\" $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>  .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the  .\" purpose with or without fee is hereby granted, provided that the
Line 26 
Line 26 
 .\" SECTION  .\" SECTION
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mdocterm  .Nm mdocterm
 .Op Fl vV  .Op Fl V
 .Op Fl f Ns Ar option...  .Op Fl f Ns Ar option...
 .Op Fl O Ns Ar option...  
 .Op Fl W Ns Ar err...  .Op Fl W Ns Ar err...
 .Op Ar infile  .Op Ar infile...
 .Nm mdocterm  
 .Op Fl hi  
 .Op Fl m Ns Ar name  
 .Op Fl n Ns Ar num  
 .Op Fl o Ns Ar list  
 .Op Fl r Ns Ar cn  
 .Op Fl T Ns Ar name  
 .Op Ar infile  
 .\" SECTION  .\" SECTION
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
Line 48  utility formats a BSD 
Line 39  utility formats a BSD 
 manual page for display on the terminal.  The arguments are as follows:  manual page for display on the terminal.  The arguments are as follows:
 .Bl -tag -width XXXXXXXXXXXX  .Bl -tag -width XXXXXXXXXXXX
 .\" ITEM  .\" ITEM
 .It Fl v  .It Fl V
 Print verbose parsing output.  
 .\" ITEM  
 .It Fl v  
 Print version and exit.  Print version and exit.
 .\" ITEM  .\" ITEM
 .It Fl f Ns Ar option...  .It Fl f Ns Ar option...
Line 59  Override default compiler behaviour.  See 
Line 47  Override default compiler behaviour.  See 
 .Sx Compiler Options  .Sx Compiler Options
 for details.  for details.
 .\" ITEM  .\" ITEM
 .It Fl O Ns Ar option...  
 Terminal-encoding options.  See  
 .Sx Front-end Options  
 for details.  
 .\" ITEM  
 .It Fl W Ns Ar err...  .It Fl W Ns Ar err...
 Print warning messages.  May be set to  Print warning messages.  May be set to
 .Fl W Ns Ar all  .Fl W Ns Ar all
Line 79  termination.  Multiple 
Line 62  termination.  Multiple 
 arguments may be comma-separated, such as  arguments may be comma-separated, such as
 .Fl W Ns Ar error,all .  .Fl W Ns Ar error,all .
 .\" ITEM  .\" ITEM
 .It Ar infile  .It Ar infile...
 Read input from  Read input from zero or more
 .Ar infile ,  .Ar infile .
 which may be  If unspecified, reads from stdin.
 .Dq \-  
 for stdin.  
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 If  
 .Xr nroff 1  
 arguments are supplied on the command line  
 .Pq Fl himnorT ,  
 these are ignored unless  
 .Xr nroff 1  
 is invoked on parse failure.  
 .\" PARAGRAPH  
 .Pp  
 The  The
 .Nm  .Nm
 utility is a formatting front-end for  utility is a formatting front-end for
Line 115  By default, 
Line 87  By default, 
 reads from stdin and prints nroff  reads from stdin and prints nroff
 .Qq backspace  .Qq backspace
 terminal-encoded output to stdout, at this time to a fixed column with  terminal-encoded output to stdout, at this time to a fixed column with
 of 78 characters.  If  of 78 characters.
 .Ar infile  
 can't be parsed (isn't valid mdoc, doesn't contain valid syntax, etc.),  
 .Xr nroff 1  
 is invoked.  If no  
 .Xr nroff 1  
 command-line argumnets aren't provided,  
 .Fl m Ar Ns andoc  
 is implied.  
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 .Ex -std mdocterm  .Ex -std mdocterm
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss Front-end Options  
 The default behaviour may be overriden with the  
 .Fl O  
 flag.  The available options are as follows:  
 .Bl -tag -width XXXXXXXXXXXX -offset XXXX  
 .It Fl O Ns Ar nopunt  
 Don't punt to  
 .Xr nroff 1  
 if  
 .Ar infile  
 may not be parsed.  
 .It Fl O Ns Ar ansi  
 Use ANSI/VT100 output encoding instead of backspaces.  
 .El  
 .\" SUB-SECTION  
 .Ss Compiler Options  .Ss Compiler Options
 Default compiler behaviour may be overriden with the  Default compiler behaviour may be overriden with the
 .Fl f  .Fl f
Line 162  As with the
Line 111  As with the
 .Fl W  .Fl W
 flag, multiple  flag, multiple
 .Fl f  .Fl f
 and  
 .Fl O  
 options may be grouped and delimited with a comma.  Using  options may be grouped and delimited with a comma.  Using
 .Fl f Ns Ar ign-scope,ign-escape ,  .Fl f Ns Ar ign-scope,ign-escape ,
 for example, will try to ignore scope and character-escape errors.  for example, will try to ignore scope and character-escape errors.
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss Character Escapes  .Ss Character Escapes
 The following table shows all  The
   .Nm
   utility correctly renders all
   .Sx Special Characters
   in
 .Xr mdoc 7  .Xr mdoc 7
 character escapes rendered by  in 7-bit ASCII.
 .Nm .  
 Note that the  
 .Em Output  
 column will render differently whether executed with  
 .Xr mdocterm 1  
 or another output filter.  
 .\" PARAGRAPH  
 .Pp  .Pp
 Grammatic:  In the general sense,
 .Pp  .Nm
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact  will make a
 .It Em Output  .Pq best-effort
 .Em Input (Name)  to render complex characters; however, if a manual is using considerable
 .It \(em  special characters, some meaning may be lost in translation.
 \\(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 \(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  
 \\(lB (left bracket)  
 .It \q  
 \\q (double-quote)  
 .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.  
 .\" SECTION  .\" SECTION
 .Sh EXAMPLES  .Sh EXAMPLES
 To display this manual page on ANSI-capable terminal:  To display this manual page:
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 .D1 % mdocterm \-Wall,error mdocterm.1  .D1 % mdocterm \-Wall,error mdocterm.1
Line 307  To pipe a manual page to the pager:
Line 143  To pipe a manual page to the pager:
 .D1 % mdocterm mdocterm.1 | less  .D1 % mdocterm mdocterm.1 | less
 .\" SECTION  .\" SECTION
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mdoctree 1 ,  
 .Xr mdoclint 1 ,  
 .Xr mdoc 7 ,  .Xr mdoc 7 ,
 .Xr mdoc 3  .Xr mdoc 3
 .\"  .\"
Line 316  To pipe a manual page to the pager:
Line 150  To pipe a manual page to the pager:
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons Aq kristaps@openbsd.org .
 .\" SECTION  .\" SECTION
 .Sh CAVEATS  .Sh CAVEATS
 See  See
Legend:
Removed from v.1.21  
changed lines
  Added in v.1.26
CVSweb