Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
DOCBOOK2MDOC(1)		  BSD General Commands Manual	       DOCBOOK2MDOC(1)

NAME
     docbook2mdoc -- Convert DocBook refentry to mdoc

SYNOPSIS
     docbook2mdoc [file]

DESCRIPTION
     The docbook2mdoc utility reads file and generates mdoc(7) from the
     <refentry>	section	of DocBook source, ignoring other sections.  If	un-
     specified or -, file is taken to be standard input.  The arguments	are as
     follows:

     -W	     Output non-fatal warning messages.

     docbook2mdoc 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 </>.  The	only non-DocBook construct recognised (and discarded)
     is	<xi:include />.

EXIT STATUS
     The docbook2mdoc utility exits 0 on success, and >0 if an error occurs.

EXAMPLES
     To	pipe a DocBook document	foo.xml	through	mandoc(1) and a	pager:

	   % docbook2mdoc foo.xml | mandoc | more

SEE ALSO
     mandoc(1),	mdoc(7)

AUTHORS
     docbook2mdoc was written by Kristaps Dzonsons, kristaps@bsd.lv.

CAVEATS
     The docbook2mdoc utility is experimental.	As such, only a	modest subset
     of	the <refentry> domain is accepted.

     The output	mdoc(7)	could be much nicer: trailing spaces, superfluous
     space removal, new-line new-sentence, and other niceties are not used.

BSD				April 30, 2014				   BSD

NAME | SYNOPSIS | DESCRIPTION | EXIT STATUS | EXAMPLES | SEE ALSO | AUTHORS | CAVEATS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=docbook2mdoc&sektion=1&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help