docbook2mdoc/docbook2mdoc.1 - diff

Return to docbook2mdoc.1 CVS log

Up to [cvsweb.bsd.lv] / docbook2mdoc

Diff for /docbook2mdoc/docbook2mdoc.1 between version 1.1 and 1.9

version 1.1, 2014/03/28 11:20:07

version 1.9, 2019/03/17 13:53:42

Line 21

.Nm docbook2mdoc

.Nd Convert DocBook refentry to mdoc

.Sh SYNOPSIS

.Nm docbook2man

.Nm docbook2mdoc

.Op Fl W

.Op Ar file

.Sh DESCRIPTION

The

.Nm

utility reads

.Ar file

and

and generates

generates

.Xr mdoc 7

from the

and

.Aq refentry

.Xr eqn 7

section of DocBook source.

from the <refentry> section of DocBook source, ignoring other sections.

If unspecified or

.Ar \&- ,

.Sq Cm \- ,

.Ar file

is taken to be standard input.

It accepts no arguments.

.Pp

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 constructs recognised are <xi:include\ />

.Pq which is discarded

and <mml:*>, which is accepted and converted to

.Xr eqn 7 .

.Sh EXIT STATUS

.Ex -std

.Sh EXAMPLES

Line 48 through

Line 64 through

.Xr mandoc 1

and a pager:

.Pp

.Dl % docbook2mdoc foo.xml | mandoc | more

.Dl $ docbook2mdoc foo.xml | mandoc -l

.Sh SEE ALSO

.Xr mandoc 1 ,

.Xr eqn 7 ,

.Xr mdoc 7

.Sh AUTHORS

.Nm

was written by

.Ar Kristaps Dzonsons ,

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

.Mt kristaps@bsd.lv .

.Sh CAVEATS

The

.Nm

utility is experimental.

As such, only a small subset of the

As such, only a modest subset of the <refentry> domain is accepted.

.Aq refentry

.Pp

domain is accepted.

The output

.Xr mdoc 7

could be much nicer: trailing spaces, superfluous space removal,

new-line new-sentence, and other niceties are not used.

CVSweb