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

Diff for /mandoc/Attic/mdocml.1 between version 1.7 and 1.25

version 1.7, 2008/11/28 11:21:12 version 1.25, 2008/12/10 12:05:33
Line 1 
Line 1 
 .\"     $OpenBSD$  
 .\"  .\"
 .\" The following requests are required for all man pages.  
 .\"  
 .\" Remove `\&' from the line below.  
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt mdocml 1  .Dt mdocml 1
 .Os  .Os
Line 13 
Line 9 
 .\"  .\"
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mdocml  .Nm mdocml
 .Op Fl vW  .Op Fl v
   .Op Fl W Ns Ar err...
 .Op Fl f Ar filter  .Op Fl f Ar filter
 .Op Fl o Ar outfile  .Op Fl o Ar outfile
 .Op Ar infile  .Op Ar infile
Line 21 
Line 18 
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility parses  utility parses mdoc formatted manual source and passes results into an
 .Xr mdoc  output filter.  The current output filters are
 formatted manual source and passes results into the output filter  .Ar html
 dictated by  and
 .Fl f Ar filter .  .Ar xml ,
 The only current output filter is  the default.  Arguments common to all filters follow:
 .Ar validate ,  
 the default.  The arguments are as follows:  
 .Bl -tag -width "\-o outfile"  .Bl -tag -width "\-o outfile"
   .It Fl f Ar filter
   The output filter name.  This
   .Em must
   be declared before any other options.
 .It Fl o Ar outfile  .It Fl o Ar outfile
 Place output in  Write output to
 .Ar outfile ,  .Ar outfile ,
 which may be  which may be
 .Qq \-  .Dq \-
 for standard output.  The default is standard output.  for stdout.
   .It Fl W Ns Ar err...
   Print warning messages.  If set to
   .Fl W Ns Ar all ,
   all warnings are printed; if
   .Fl W Ns Ar error ,
   warnings are considered errors and cause utility termination.  Multiple
   .Fl W
   arguments may be comma-separated, such as
   .Fl W Ns Ar error,all .
   .It Fl v
   Make warning and error messages verbose.
 .It Ar infile  .It Ar infile
 Read input from  Read input from
 .Ar infile ,  .Ar infile ,
 which may be  which may be
 .Qq \-  .Dq \-
 for standard input.  The default is standard input.  for stdin.
 .It Fl v  
 Print messages (output depends on filter).  
 .It Fl W  
 Print warnings (output depends on filter).  
 .El  .El
 .Ss Validate Filter  .Pp
 The validate filter, specified by  By default,
 .Fl f Ar validate ,  .Nm
 is the default filter.  It produces no output, so specifying  reads from stdin and writes to stdout using the xml filter.
 .Fl o Ar outfile  .Pp
 results in an empty file.  .Ex -std mdocml
 .\" The following requests should be uncommented and used where appropriate.  .\"
 .\" This next request is for sections 2, 3, and 9 function return values only.  .Ss XML Filter
 .\" .Sh RETURN VALUES  The XML filter, specified by
 .\" This next request is for sections 1, 6, 7 & 8 only.  .Fl f Ar xml ,
 .\" .Sh ENVIRONMENT  is the default filter.  This filter has no additional arguments.
 .\" .Sh FILES  .Pp
 .\" .Sh EXAMPLES  The XML filter creates an XML document where element names are their respective
 .\" This next request is for sections 1, 4, 6, and 8 only.  roff macro names.  Each element name has an associated
 .\" .Sh DIAGNOSTICS  namespace, which is one of
 .\" The next request is for sections 2, 3, and 9 error and signal handling only.  .Dq block ,
 .\" .Sh ERRORS  .Dq head ,
   .Dq body ,
   or
   .Dq inline ,
   corresponding to the display mode of a node.  The document root is
   always the
   .Dq mdoc
   element, in the default namespace; the
   .Dq head
   namespace is for block headers (such as
   .Sq .Ss
   and
   .Sq .Sh ) ;
   the
   .Dq body
   namespace is for block bodies; and the
   .Dq inline
   namespace is for in-line elements (such as
   .Sq .Em ) .
   .Ss HTML Filter
   The HTML filter, specified by
   .Fl f Ar html ,
   accepts the following filter-specific arguments:
   .Bl -tag -width "\-c css"
   .It Fl c Ar css
   The CSS file location, which defaults to
   .Ar mdocml.css .
   .It Fl e
   Whether to embed the CSS file into the HTML prologue.
   .El
   .\"
   .Sh EXAMPLES
   To produce an HTML4-strict document
   .Pa mdocml.html
   for
   .Pa mdocml.1
   with the default, embedded style-sheet:
   .Pp
   .D1 % mdocml -fhtml -e -o mdocml.html mdocml.1
   .Pp
   To create an XML document on standard output from
   .Pa mdocml.1
   with the default namespace identifiers
   .Li head ,
   .Li body ,
   .Li block
   and
   .Li inline :
   .Pp
   .D1 % mdocml mdocml.1
   .\"
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr groff 1 ,  .Xr groff 1 ,
 .Xr mdoc.samples 7 ,  .Xr mdoc.samples 7 ,
Line 85  or the necessary limitations of converting an ad hoc l
Line 141  or the necessary limitations of converting an ad hoc l
 structured ones:  structured ones:
 .Bl -enum -compact -offset indent  .Bl -enum -compact -offset indent
 .It  .It
 The engine doesn't understand  The engine doesn't understand the
 .Sq \&Xo  .Sq \&No ,
   .Sq \&Db ,
   .Sq \&Xc ,
 and  and
 .Sq \&Xc  .Sq \&Xo
 troff macros.  mdoc macros.
 .It  .It
 All macro arguments may be quoted, instead of only some.  All macro arguments may be quoted, instead of only some.
 .It  .It
 Blank lines raise warnings.  Blank lines raise errors.
 .It  .It
 Non-ascii characters may cause issues.  If terminating punctuation is found, then
   .Em all
   remaining tokens are flushed after line scope is closed, not just the
   last one.
 .El  .El
   .Pp
   The roff engine in
   .Nm
   produces text in-line; thus, output may already be partially written by
   the time an error is encountered.
 .\" .Sh BUGS  .\" .Sh BUGS
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.25
CVSweb