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

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

version 1.7, 2009/02/27 09:14:02 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 17 
Line 17 
 .\" PERFORMANCE OF THIS SOFTWARE.  .\" PERFORMANCE OF THIS SOFTWARE.
 .\"  .\"
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt mdocmterm 1  .Dt mdocterm 1
 .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 v  .Op Fl vV
   .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 36  The
Line 46  The
 utility formats a BSD  utility formats a BSD
 .Dq mdoc  .Dq mdoc
 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 "\-Werr... "  .Bl -tag -width XXXXXXXXXXXX
 .\" ITEM  .\" ITEM
 .It Fl v  .It Fl v
 Print verbose parsing output.  Print verbose parsing output.
 .\" ITEM  .\" 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...
   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 65  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 75  input, documented at
Line 107  input, documented at
 .Xr mdoc 7  .Xr mdoc 7
 and  and
 .Xr mdoc.samples 7 ,  .Xr mdoc.samples 7 ,
 into an abstract syntax tree.  into an abstract syntax tree.
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 By default,  By default,
 .Nm  .Nm
 reads from stdin and prints terminal-encoded output to stdout.  reads from stdin and prints nroff
   .Qq backspace
   terminal-encoded output to stdout, at this time to a fixed column with
   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
 .\" PARAGRAPH  
 .Pp  
 .Nm  
 is  
 .Ud  
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss Character Escapes  .Ss Front-end Options
 This section documents the character-escapes accepted by  The default behaviour may be overriden with the
 .Xr mdocterm 1 .  .Fl O
 Note that the \\x, \\(xx and \\[n] forms are described here; the \\*(xx  flag.  The available options are as follows:
 and \\*x forms described in  .Bl -tag -width XXXXXXXXXXXX -offset XXXX
 .Xr mdoc.samples 7  .It Fl O Ns Ar nopunt
 are deprecated, but still correctly rendered.  For all two-character  Don't punt to
 sequences, \\(xx is equivalent to the n-character \\[xx].  .Xr nroff 1
 .Pp  if
 Note that the  .Ar infile
 .Em Output  may not be parsed.
 column will render differently whether executed with  
 .Xr mdocterm 1  
 or another output filter.  
 .\" PARAGRAPH  
 .Pp  
 Enclosures:  
 .Pp  
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact  
 .It Em Output  
 .Em Input (Name)  
 .El  
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact  
 .It \(rB  
 \\(rB (right bracket)  
 .It \(lB  
 \\(rB (left bracket)  
 .It \(lq  
 \\(lq (left double-quote)  
 .It \(rq  
 \\(rq (right double-quote)  
 .It \(oq  
 \\(lq (left single-quote)  
 .It \(aq  
 \\(aq (right single-quote, apostrophe)  
 .El  .El
 .\" PARAGRAPH  .\" SUB-SECTION
 .Pp  .Ss Compiler Options
 Indicatives:  Default compiler behaviour may be overriden with the
 .Pp  .Fl f
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact  flag.  The available options are as follows:
 .It Em Output  .Bl -tag -width XXXXXXXXXXXX -offset XXXX
 .Em Input (Name)  .It Fl f Ns Ar ign-scope
 .El  When rewinding the scope of a block macro, forces the compiler to ignore
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact  scope violations.  This can seriously mangle the resulting tree.
 .It \(<-  .It Fl f Ns Ar ign-escape
 \\(<- (left arrow)  Ignore invalid escape sequences.
 .It \(->  .It Fl f Ns Ar ign-macro
 \\(-> (right arrow)  Ignore unknown macros at the start of input lines.
 .It \(ua  
 \\(ua (up arrow)  
 .It \(da  
 \\(da (down arrow)  
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Mathematical:  As with the
   .Fl W
   flag, multiple
   .Fl f
   and
   .Fl O
   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
   The
   .Nm
   utility correctly renders all
   .Sx Special Characters
   in
   .Xr mdoc 7
   in 7-bit ASCII.
 .Pp  .Pp
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact  In the general sense,
 .It Em Output  .Nm
 .Em Input (Name)  will make a
 .El  .Pq best-effort
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact  to render complex characters; however, if a manual is using considerable
 .It \(<=  special characters, some meaning may be lost in translation.
 \\(<= (less-than-equal)  
 .It \(>=  
 \\(>= (greater-than-equal)  
 .It \(==  
 \\(== (greater-than-equal)  
 .It \(!=  
 \\(!= (not equal)  
 .It \(if  
 \\(if (infinity)  
 .It \(na  
 \\(na (NaN)*  
 .It \(+-  
 \\(+- (plus-minus)  
 .El  
 .\" PARAGRAPH  
 .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.  
 .Pp  
 Diacritics:  
 .Pp  
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact  
 .It Em Output  
 .Em Input (Name)  
 .El  
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact  
 .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)  
 .El  
 .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact  
 .It \(bu  
 \\(bu (bullet)  
 .It \(ba  
 \\(ba (bar)  
 .El  
 .\" 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 | 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 223  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
 .Xr mdoc 3  .Xr mdoc 3
 for a list of bugs, caveats, and incomplete macros regarding the  for a list of bugs, caveats, and incomplete macros regarding the
 document parse.  document parse.
   .Pp
   The
   .Nm
   utility doesn't yet know how to display the following:
   .Pp
   .Bl -bullet -compact
   .It
   The \-hang
   .Sq \&Bl
   list is not yet supported.
   .It
   The \-literal and \-unfilled
   .Sq \&Bd
   displays only accept text contents.
   .It
   The
   .Sq \&Xo/Xc
   pair isn't supported (and never will be).
   .It
   The
   .Sq \&Sm
   macro has no effect, yet.
   .El
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.24
CVSweb