=================================================================== RCS file: /cvs/docbook2mdoc/docbook2mdoc.1,v retrieving revision 1.1 retrieving revision 1.6 diff -u -p -r1.1 -r1.6 --- docbook2mdoc/docbook2mdoc.1 2014/03/28 11:20:07 1.1 +++ docbook2mdoc/docbook2mdoc.1 2014/10/12 15:08:45 1.6 @@ -1,4 +1,4 @@ -.\" $Id: docbook2mdoc.1,v 1.1 2014/03/28 11:20:07 kristaps Exp $ +.\" $Id: docbook2mdoc.1,v 1.6 2014/10/12 15:08:45 kristaps 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: October 12 2014 $ .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,34 @@ utility reads and generates .Xr mdoc 7 +and +.Xr eqn 7 from the .Aq refentry -section of DocBook source. +section of DocBook source, ignoring other sections. If unspecified or .Ar \&- , .Ar file is taken to be standard input. -It accepts no arguments. +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 construct recognised are +.Aq xi:include \(sl +.Pq which is discarded +and +.Aq mml:* , +which is accepted and converted to +.Xr eqn 7 . .Sh EXIT STATUS .Ex -std .Sh EXAMPLES @@ -61,6 +81,11 @@ was written by The .Nm utility is experimental. -As such, only a small subset of the +As such, only a modest subset of the .Aq refentry 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.