.\" Man page Copyright 2006 Chris Morris <c.i.morris@dunelm.org.uk>
.\"
.\" This 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.
.\" 
.\" This is distributed in the hope that it will be useful, but WITHOUT
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
.\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
.\" for more details.
.\"
.TH kayadoc2man 1 "December 2006" "Kaya" "Kaya program reference"
.SH NAME
kayadoc2man \- Automatic man pages for Kaya modules
.SH SYNOPSIS
.B kayadoc2man
.I "XMLFILE [DONEFILE] [LICENSEFILE]"
.SH DESCRIPTION
.B kayadoc2man
creates a man page for every function and data type from an .xml file generated with the -xmldocs option of
.BR 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, 
.B 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
.B /dev/null
for the 
.I DONEFILE
on most systems.
.PP
Prior to Kaya 0.3.0 this utility was called xml2man

.SH OBTAINING
.PP
The latest release of Kaya can be obtained from <http://kayalang.org/download>.
.PP
Development versions can be obtained using
.B darcs(1)
from <http://kayalang.org/darcs/>

.SH BUGS
.PP
Please report bugs found to <kaya@kayalang.org>

.SH LICENSE
.B 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.

.SH SEE ALSO
.BR man(1)
.BR kayac(1)