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

Diff for /mandoc/Attic/mdocterm.1 between version 1.18 and 1.24

version 1.18, 2009/03/12 02:57:36 version 1.24, 2009/03/16 23:37:28
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 21 
Line 21 
 .Os  .Os
 .\" SECTION  .\" SECTION
 .Sh NAME  .Sh NAME
 .Nm mdocmterm  .Nm mdocterm
 .Nd mdoc macro compiler  .Nd mdoc macro compiler
 .\" SECTION  .\" SECTION
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mdocmterm  .Nm mdocterm
 .Op Fl vV  .Op Fl vV
 .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 50  Override default compiler behaviour.  See 
Line 59  Override default compiler behaviour.  See 
 .Sx Compiler Options  .Sx Compiler Options
 for details.  for details.
 .\" ITEM  .\" ITEM
   .It Fl O Ns Ar option...
   Front-end 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 74  for stdin.
Line 88  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 85  input, documented at
Line 108  input, documented at
 and  and
 .Xr mdoc.samples 7 ,  .Xr mdoc.samples 7 ,
 into an abstract syntax tree.  into an abstract syntax tree.
   .\" PARAGRAPH
 .Pp  .Pp
 By default,  By default,
 .Nm  .Nm
 reads from stdin and prints ANSI  reads from stdin and prints nroff
 .Qq raw  .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.  of 78 characters.  If
   .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 mdocmterm  .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.
   .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 115  As with the
Line 160  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 Input Encoding  .Ss Character Escapes
 The  The
 .Nm  .Nm
 utility expects its input to be 7-bit ASCII as defined in  utility correctly renders all
 .Xr ascii 7 .  .Sx Special Characters
 The only non-graphing characters accepted are spaces,  in
 .Sq \  ,  .Xr mdoc 7
 and tabs,  in 7-bit ASCII.
 .Sq \et .  
 Tabs are only accepted in literal block-displays and as column  
 delimiters.  
 .Pp  .Pp
 Only Unix-style newlines (\en) are accepted; if the newline is escaped,  In the general sense,
 the line is concatenated with the next.  .Nm
 .\" SUB-SECTION  will make a
 .Ss Character Escapes  .Pq best-effort
 This section documents the character-escapes accepted by  to render complex characters; however, if a manual is using considerable
 .Xr mdocterm 1 .  special characters, some meaning may be lost in translation.
 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  
 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 \(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 \(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:  To display this manual page:
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 .D1 % mdocmterm \-Wall,error mdocmterm.1  .D1 % mdocterm \-Wall,error mdocterm.1
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 To pipe a manual page to the pager:  To pipe a manual page to the pager:
 .Pp  .Pp
 .D1 % mdocterm mdocterm.1 2>&1 | less \-R  .D1 % mdocterm mdocterm.1 | less
 .\" SECTION  .\" SECTION
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mdoctree 1 ,  .Xr mdoctree 1 ,
 .Xr mdoclint 1 ,  .Xr mdoclint 1 ,
 .Xr mdoc.samples 7 ,  
 .Xr mdoc 7 ,  .Xr mdoc 7 ,
 .Xr mdoc 3  .Xr mdoc 3
 .\"  .\"
Line 285  To pipe a manual page to the pager:
Line 203  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.18  
changed lines
  Added in v.1.24
CVSweb