NAME¶
kayadoc2man - Automatic man pages for Kaya modules
SYNOPSIS¶
kayadoc2man XMLFILE [DONEFILE] [LICENSEFILE]
DESCRIPTION¶
kayadoc2man creates a man page for every function and data type from an
.xml file generated with the -xmldocs option of
kayac(1). Pass it the
path to the XML documentation file to parse, and optionally (to ease Makefile
writing) the name of a file to create when processing is complete. The third
option allows you to specify your own author and license information (if this
is omitted,
kayadoc2man will assume that it is generating documentation
for the Kaya standard library). If you want to specify the third option but
not the second, you can of course use
/dev/null for the
DONEFILE
on most systems.
Prior to Kaya 0.3.0 this utility was called xml2man
OBTAINING¶
The latest release of Kaya can be obtained from
<
http://kayalang.org/download>.
Development versions can be obtained using
darcs(1) from
<
http://kayalang.org/darcs/>
BUGS¶
Please report bugs found to <kaya@kayalang.org>
LICENSE¶
kayadoc2man is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License (version 2 or any later
version) as published by the Free Software Foundation.
SEE ALSO¶
man(1) kayac(1)