=================================================================== RCS file: /cvs/docbook2mdoc/docbook2mdoc.1,v retrieving revision 1.1 retrieving revision 1.8 diff -u -p -r1.1 -r1.8 --- docbook2mdoc/docbook2mdoc.1 2014/03/28 11:20:07 1.1 +++ docbook2mdoc/docbook2mdoc.1 2017/06/29 12:11:57 1.8 @@ -1,4 +1,4 @@ -.\" $Id: docbook2mdoc.1,v 1.1 2014/03/28 11:20:07 kristaps Exp $ +.\" $Id: docbook2mdoc.1,v 1.8 2017/06/29 12:11:57 schwarze Exp $ .\" .\" Copyright (c) 2014 Kristaps Dzonsons .\" @@ -14,14 +14,14 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 28 2014 $ +.Dd $Mdocdate: June 29 2017 $ .Dt DOCBOOK2MDOC 1 .Os .Sh NAME .Nm docbook2mdoc .Nd Convert DocBook refentry to mdoc .Sh SYNOPSIS -.Nm docbook2man +.Nm docbook2mdoc .Op Ar file .Sh DESCRIPTION The @@ -31,14 +31,30 @@ utility reads and generates .Xr mdoc 7 -from the -.Aq refentry -section of DocBook source. +and +.Xr eqn 7 +from the section of DocBook source, ignoring other sections. If unspecified or -.Ar \&- , +.Sq Cm \- , .Ar file is taken to be standard input. -It accepts no arguments. +.Pp +The arguments are as follows: +.Bl -tag -width Ds +.It Fl W +Output non-fatal warning messages. +.El +.Pp +.Nm +supports only well-formed XML DocBook V4.x until V5.1. +Some earlier DocBook constructs are accepted as well. +SGML DocBook documents may be parsed unless they contain SGML-specific +constructs, such as empty end tags +.Li . +The only non-DocBook constructs recognised are +.Pq which is discarded +and , which is accepted and converted to +.Xr eqn 7 . .Sh EXIT STATUS .Ex -std .Sh EXAMPLES @@ -51,16 +67,19 @@ and a pager: .Dl % docbook2mdoc foo.xml | mandoc | more .Sh SEE ALSO .Xr mandoc 1 , +.Xr eqn 7 , .Xr mdoc 7 .Sh AUTHORS .Nm was written by -.Ar Kristaps Dzonsons , -.Mt kristaps@bsd.lv . +.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . .Sh CAVEATS The .Nm utility is experimental. -As such, only a small subset of the -.Aq refentry -domain is accepted. +As such, only a modest subset of the domain is accepted. +.Pp +The output +.Xr mdoc 7 +could be much nicer: trailing spaces, superfluous space removal, +new-line new-sentence, and other niceties are not used.