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