Return to docbook2mdoc.1 CVS log

Up to [cvsweb.bsd.lv] / docbook2mdoc

Annotation of docbook2mdoc/docbook2mdoc.1, Revision 1.9

1.9     ! schwarze    1: .\"    $Id: docbook2mdoc.1,v 1.8 2017/06/29 12:11:57 schwarze Exp $
1.1       kristaps    2: .\"
                      3: .\" Copyright (c) 2014 Kristaps Dzonsons <kristaps@bsd.lv>
                      4: .\"
                      5: .\" Permission to use, copy, modify, and distribute this software for any
                      6: .\" purpose with or without fee is hereby granted, provided that the above
                      7: .\" copyright notice and this permission notice appear in all copies.
                      8: .\"
                      9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     16: .\"
1.9     ! schwarze   17: .Dd $Mdocdate: June 29 2017 $
1.1       kristaps   18: .Dt DOCBOOK2MDOC 1
                     19: .Os
                     20: .Sh NAME
                     21: .Nm docbook2mdoc
                     22: .Nd Convert DocBook refentry to mdoc
                     23: .Sh SYNOPSIS
1.2       kristaps   24: .Nm docbook2mdoc
1.9     ! schwarze   25: .Op Fl W
1.1       kristaps   26: .Op Ar file
                     27: .Sh DESCRIPTION
                     28: The
                     29: .Nm
                     30: utility reads
                     31: .Ar file
1.9     ! schwarze   32: and generates
1.1       kristaps   33: .Xr mdoc 7
1.6       kristaps   34: and
                     35: .Xr eqn 7
1.8       schwarze   36: from the <refentry> section of DocBook source, ignoring other sections.
1.1       kristaps   37: If unspecified or
1.8       schwarze   38: .Sq Cm \- ,
1.1       kristaps   39: .Ar file
                     40: is taken to be standard input.
1.8       schwarze   41: .Pp
1.4       kristaps   42: The arguments are as follows:
                     43: .Bl -tag -width Ds
                     44: .It Fl W
                     45: Output non-fatal warning messages.
                     46: .El
1.2       kristaps   47: .Pp
                     48: .Nm
                     49: supports only well-formed XML DocBook V4.x until V5.1.
1.5       kristaps   50: Some earlier DocBook constructs are accepted as well.
1.2       kristaps   51: SGML DocBook documents may be parsed unless they contain SGML-specific
                     52: constructs, such as empty end tags
                     53: .Li </> .
1.8       schwarze   54: The only non-DocBook constructs recognised are <xi:include\ />
1.6       kristaps   55: .Pq which is discarded
1.8       schwarze   56: and <mml:*>, which is accepted and converted to
1.6       kristaps   57: .Xr eqn 7 .
1.1       kristaps   58: .Sh EXIT STATUS
                     59: .Ex -std
                     60: .Sh EXAMPLES
                     61: To pipe a DocBook document
                     62: .Pa foo.xml
                     63: through
                     64: .Xr mandoc 1
                     65: and a pager:
                     66: .Pp
1.9     ! schwarze   67: .Dl $ docbook2mdoc foo.xml | mandoc -l
1.1       kristaps   68: .Sh SEE ALSO
                     69: .Xr mandoc 1 ,
1.7       kristaps   70: .Xr eqn 7 ,
1.1       kristaps   71: .Xr mdoc 7
                     72: .Sh AUTHORS
                     73: .Nm
                     74: was written by
1.8       schwarze   75: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1.1       kristaps   76: .Sh CAVEATS
                     77: The
                     78: .Nm
                     79: utility is experimental.
1.8       schwarze   80: As such, only a modest subset of the <refentry> domain is accepted.
1.2       kristaps   81: .Pp
                     82: The output
                     83: .Xr mdoc 7
                     84: could be much nicer: trailing spaces, superfluous space removal,
                     85: new-line new-sentence, and other niceties are not used.