Annotation of docbook2mdoc/docbook2mdoc.1, Revision 1.4
1.4 ! kristaps 1: .\" $Id: docbook2mdoc.1,v 1.3 2014/04/30 10:11:24 kristaps 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.4 ! kristaps 17: .Dd $Mdocdate: April 30 2014 $
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.1 kristaps 25: .Op Ar file
26: .Sh DESCRIPTION
27: The
28: .Nm
29: utility reads
30: .Ar file
31: and
32: generates
33: .Xr mdoc 7
34: from the
35: .Aq refentry
1.2 kristaps 36: section of DocBook source, ignoring other sections.
1.1 kristaps 37: If unspecified or
38: .Ar \&- ,
39: .Ar file
40: is taken to be standard input.
1.4 ! kristaps 41: The arguments are as follows:
! 42: .Bl -tag -width Ds
! 43: .It Fl W
! 44: Output non-fatal warning messages.
! 45: .El
1.2 kristaps 46: .Pp
47: .Nm
48: supports only well-formed XML DocBook V4.x until V5.1.
49: SGML DocBook documents may be parsed unless they contain SGML-specific
50: constructs, such as empty end tags
51: .Li </> .
1.3 kristaps 52: The only non-DocBook construct recognised (and discarded) is
53: .Aq xi:include \(sl .
1.1 kristaps 54: .Sh EXIT STATUS
55: .Ex -std
56: .Sh EXAMPLES
57: To pipe a DocBook document
58: .Pa foo.xml
59: through
60: .Xr mandoc 1
61: and a pager:
62: .Pp
63: .Dl % docbook2mdoc foo.xml | mandoc | more
64: .Sh SEE ALSO
65: .Xr mandoc 1 ,
66: .Xr mdoc 7
67: .Sh AUTHORS
68: .Nm
69: was written by
70: .Ar Kristaps Dzonsons ,
71: .Mt kristaps@bsd.lv .
72: .Sh CAVEATS
73: The
74: .Nm
75: utility is experimental.
1.2 kristaps 76: As such, only a modest subset of the
1.1 kristaps 77: .Aq refentry
78: domain is accepted.
1.2 kristaps 79: .Pp
80: The output
81: .Xr mdoc 7
82: could be much nicer: trailing spaces, superfluous space removal,
83: new-line new-sentence, and other niceties are not used.
CVSweb