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

Diff for /mandoc/Attic/mdocml.1 between version 1.10 and 1.21

version 1.10, 2008/11/30 21:41:35 version 1.21, 2008/12/06 19:41:41
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 alpha
 .Os  .Os
 .\"  .\"
 .Sh NAME  .Sh NAME
Line 13 
Line 9 
 .\"  .\"
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mdocml  .Nm mdocml
 .Op Fl W  .Op Fl vW
 .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 17 
 .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 .  
 The only current output filter is  
 .Ar xml ,  .Ar xml ,
 the default.  The arguments are as follows:  the default.  Arguments common to all filters follow:
 .Bl -tag -width "\-o outfile"  .Bl -tag -width "\-o outfile"
 .It Fl f Ar filter  .It Fl f Ar filter
 The output filter name, which defaults to  The output filter name.
 .Ar xml .  
 .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 stdout.  The default is stdout.  for stdout.
 .It Fl W  .It Fl W
 Print compiler warnings to stderr.  Print warnings to stderr.
 .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 stdin.  The default is stdin.  for stdin.
 .El  .El
   .Pp
   By default,
   .Nm
   reads from stdin and writes to stdout using the xml filter.
   .Pp
   .Ex -std mdocml
   .\"
 .Ss XML Filter  .Ss XML Filter
 The XML filter, specified by  The XML filter, specified by
 .Fl f Ar xml ,  .Fl f Ar xml ,
 is the default filter.  It creates an XML document where element names are  is the default filter.  This filter has no additional arguments.
 their respective roff macro names.  Each element name has an associated  .Pp
   The XML filter creates an XML document where element names are their respective
   roff macro names.  Each element name has an associated
 namespace, which is one of  namespace, which is one of
 .Qq block ,  .Dq block ,
 .Qq inline ,  .Dq head ,
   .Dq body ,
 or  or
 .Qq special ,  .Dq inline ,
 corresponding to the display mode of a node.  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  .Pp
 Sample output follows:  .D1 % mdocml -fhtml -e -o mdocml.html mdocml.1
 .Bd -literal  .Pp
 <?xml version="1.0" encoding="UTF-8"?>  To create an XML document on standard output from
 <block:mdoc>  .Pa mdocml.1
   <block:Sh>  with the default namespace identifiers
     <inline:Sh>NAME</inline:Sh> <inline:Nm>example</inline:Nm>  .Li head ,
     <inline:Nd>example text</inline:Nd>  .Li body ,
   </block:Sh>  .Li block
 </block:mdoc>  and
 .Ed  .Li inline :
 .\" The following requests should be uncommented and used where appropriate.  .Pp
 .\" This next request is for sections 2, 3, and 9 function return values only.  .D1 % mdocml mdocml.1
 .\" .Sh RETURN VALUES  .\"
 .\" This next request is for sections 1, 6, 7 & 8 only.  
 .\" .Sh ENVIRONMENT  
 .\" .Sh FILES  
 .\" .Sh EXAMPLES  
 .\" This next request is for sections 1, 4, 6, and 8 only.  
 .\" .Sh DIAGNOSTICS  
 .\" The next request is for sections 2, 3, and 9 error and signal handling only.  
 .\" .Sh ERRORS  
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr groff 1 ,  .Xr groff 1 ,
 .Xr mdoc.samples 7 ,  .Xr mdoc.samples 7 ,
Line 102  or the necessary limitations of converting an ad hoc l
Line 129  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
 If terminating punctuation is found, then  If terminating punctuation is found, then
 .Em all  .Em all
 remaining tokens are flushed after line scope is closed, not just the  remaining tokens are flushed after line scope is closed, not just the
 last one.  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.10  
changed lines
  Added in v.1.21
CVSweb