[BACK]Return to docbook2mdoc.1 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / docbook2mdoc

File: [cvsweb.bsd.lv] / docbook2mdoc / docbook2mdoc.1 (download)

Revision 1.6, Sun Oct 12 15:08:45 2014 UTC (7 years, 10 months ago) by kristaps
Branch: MAIN
Changes since 1.5: +10 -3 lines

Add initial support for mml:* -> eqn(7).

.\"	$Id: docbook2mdoc.1,v 1.6 2014/10/12 15:08:45 kristaps Exp $
.\"
.\" Copyright (c) 2014 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: October 12 2014 $
.Dt DOCBOOK2MDOC 1
.Os
.Sh NAME
.Nm docbook2mdoc
.Nd Convert DocBook refentry to mdoc
.Sh SYNOPSIS
.Nm docbook2mdoc
.Op Ar file
.Sh DESCRIPTION
The
.Nm
utility reads
.Ar file
and
generates
.Xr mdoc 7
and
.Xr eqn 7
from the
.Aq refentry
section of DocBook source, ignoring other sections.
If unspecified or
.Ar \&- ,
.Ar file
is taken to be standard input.
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
To pipe a DocBook document
.Pa foo.xml
through
.Xr mandoc 1
and a pager:
.Pp
.Dl % docbook2mdoc foo.xml | mandoc | more
.Sh SEE ALSO
.Xr mandoc 1 ,
.Xr mdoc 7
.Sh AUTHORS
.Nm
was written by
.Ar Kristaps Dzonsons ,
.Mt kristaps@bsd.lv .
.Sh CAVEATS
The
.Nm
utility is experimental.
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.