Name

mk_docbook_man — Generate UNIX man pages

Synopsis

mk_docbook_man SOURCE=source_file MANPAGES=manpage_list

Options

SOURCE=source_file

specifies the DocBook XML source file to process

MANPAGES=manpage_list

specifies a list of manpage files that will be output when the source_file is processed, e.g. foobar.3 for the manpage foobar in section 3.

STYLESHEET=xsl_file

specifies the XSL stylesheet for generating man pages. Defaults to $MK_DOCBOOK_XSL_DIR/manpages/profile-docbook.xsl.

INSTALLDIR=install_dir

specifies the directory where the generated documentation will be placed. Defaults to $MK_MANDIR. The generated files will be placed in subdirectories of this location according to their section.

INCLUDES=source_list

specifies a list of additional xml files that might be included by source_file, such as by XInclude.

DEPS=deps

specifies any additional dependencies needed to generate the documentation

Description

Processes the specified source file with XSLT to produce UNIX man pages.

To use this function, you must use mk_check_docbook in a configure section of your project, and it must succeed. You can test if DocBook processing is available with mk_have_doxygen. This function will fail if it is not.