docbook2manxml

Name

docbook2manxml -- convert DocBook documents to Man-XML

Synopsis

docbook2manxml [options...] [xml-document]

Description

docbook2manxml converts an XML DocBook document to Man-XML, an immediate XML document type for converting to man pages. This output can then be run through man_xml to produce actual Unix man pages.

The document in the file xml-document is converted and written to standard output. If xml-document is not given, then the document to convert is read from standard input.

docbook2manxml does event-based parsing and does not build a tree in memory; therefore it must be run at least two times on any document to properly resolve cross references and links.

Options

--refs-file=file

Write cross reference information to the specified file. The default is manpage.refs.

--header-3=string

Specifies the text of the third header of a man page, typically the date for the man page. If empty, the date content for the refentry is used.

--header-4=string

Specifies the text of the fourth header of a man page. If empty, the refmiscinfo content for the refentry is used.

--header-5=string

Specifies the text of the fifth header of a man page. If empty, the 'manual name', that is, the title of the book or reference container is used.

--default-section=section

If the source refentry has no explicit manvolnum markup, the specified man page section is used.

--default-language=language

If the source document does not indicate the language it is written in, the specified language is used. If the document does not indicate its language and this option is not specified, the default is en (English).

--uppercase-headings, --nouppercase-headings

Headings in man page content should be or should not be uppercased. The default is to uppercase.

--cite-numeral-only, --nocite-numeral-only

When citing other man pages, use only the numeric part of the section. The default is yes.

Limitations

Always validate the input document. Although some docbook2X tools try to be resiliant against unrecognized markup, the behavior when encountering such markup is undefined.

The docbook2X tools do not support all of DocBook, or may produce wrong output or even die with markup that is claimed to be supported. These are bugs and you should nag the maintainer about them.