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