1kayadoc2man(1)              Kaya program reference              kayadoc2man(1)
2
3
4

NAME

6       kayadoc2man - Automatic man pages for Kaya modules
7

SYNOPSIS

9       kayadoc2man XMLFILE [DONEFILE] [LICENSEFILE]
10

DESCRIPTION

12       kayadoc2man creates a man page for every function and data type from an
13       .xml file generated with the -xmldocs option of kayac(1).  Pass it  the
14       path  to  the  XML documentation file to parse, and optionally (to ease
15       Makefile writing) the name of a file to create when processing is  com‐
16       plete.  The  third  option  allows  you  to specify your own author and
17       license information (if this is omitted, kayadoc2man will  assume  that
18       it  is  generating documentation for the Kaya standard library). If you
19       want to specify the third option but not the second, you can of  course
20       use /dev/null for the DONEFILE on most systems.
21
22       Prior to Kaya 0.3.0 this utility was called xml2man
23
24

OBTAINING

26       The   latest   release  of  Kaya  can  be  obtained  from  <http://kay‐
27       alang.org/download>.
28
29       Development versions can be obtained using darcs(1)  from  <http://kay‐
30       alang.org/darcs/>
31
32

BUGS

34       Please report bugs found to <kaya@kayalang.org>
35
36

LICENSE

38       kayadoc2man  is free software; you can redistribute it and/or modify it
39       under the terms of the GNU General Public License  (version  2  or  any
40       later version) as published by the Free Software Foundation.
41
42

SEE ALSO

44       man(1) kayac(1)
45
46
47
48Kaya                             December 2006                  kayadoc2man(1)