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

Annotation of docbook2mdoc/docbook2mdoc.1, Revision 1.2

1.2     ! kristaps    1: .\"    $Id: docbook2mdoc.1,v 1.1 2014/03/28 11:20: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.2     ! kristaps   17: .Dd $Mdocdate: March 28 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.1       kristaps   48: .Sh EXIT STATUS
                     49: .Ex -std
                     50: .Sh EXAMPLES
                     51: To pipe a DocBook document
                     52: .Pa foo.xml
                     53: through
                     54: .Xr mandoc 1
                     55: and a pager:
                     56: .Pp
                     57: .Dl % docbook2mdoc foo.xml | mandoc | more
                     58: .Sh SEE ALSO
                     59: .Xr mandoc 1 ,
                     60: .Xr mdoc 7
                     61: .Sh AUTHORS
                     62: .Nm
                     63: was written by
                     64: .Ar Kristaps Dzonsons ,
                     65: .Mt kristaps@bsd.lv .
                     66: .Sh CAVEATS
                     67: The
                     68: .Nm
                     69: utility is experimental.
1.2     ! kristaps   70: As such, only a modest subset of the
1.1       kristaps   71: .Aq refentry
                     72: domain is accepted.
1.2     ! kristaps   73: .Pp
        !            74: The output
        !            75: .Xr mdoc 7
        !            76: could be much nicer: trailing spaces, superfluous space removal,
        !            77: new-line new-sentence, and other niceties are not used.

CVSweb