Annotation of docbook2mdoc/docbook2mdoc.1, Revision 1.5
1.5 ! kristaps 1: .\" $Id: docbook2mdoc.1,v 1.4 2014/04/30 12:54:26 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.
1.5 ! kristaps 49: Some earlier DocBook constructs are accepted as well.
1.2 kristaps 50: SGML DocBook documents may be parsed unless they contain SGML-specific
51: constructs, such as empty end tags
52: .Li </> .
1.3 kristaps 53: The only non-DocBook construct recognised (and discarded) is
54: .Aq xi:include \(sl .
1.1 kristaps 55: .Sh EXIT STATUS
56: .Ex -std
57: .Sh EXAMPLES
58: To pipe a DocBook document
59: .Pa foo.xml
60: through
61: .Xr mandoc 1
62: and a pager:
63: .Pp
64: .Dl % docbook2mdoc foo.xml | mandoc | more
65: .Sh SEE ALSO
66: .Xr mandoc 1 ,
67: .Xr mdoc 7
68: .Sh AUTHORS
69: .Nm
70: was written by
71: .Ar Kristaps Dzonsons ,
72: .Mt kristaps@bsd.lv .
73: .Sh CAVEATS
74: The
75: .Nm
76: utility is experimental.
1.2 kristaps 77: As such, only a modest subset of the
1.1 kristaps 78: .Aq refentry
79: domain is accepted.
1.2 kristaps 80: .Pp
81: The output
82: .Xr mdoc 7
83: could be much nicer: trailing spaces, superfluous space removal,
84: new-line new-sentence, and other niceties are not used.
CVSweb