1
2DOXYGEN2MAN(1)                                                  DOXYGEN2MAN(1)
3
4
5

NAME

7       doxygen2man - A tool to generate man pages from Doxygen XML files
8

SYNOPSIS

10       doxygen2man [OPTIONS] <XML file>
11

DESCRIPTION

13       This is a tool to generate API manpages from a doxygen-annotated header
14       file First run doxygen on the file and then run  this  program  against
15       the  main  XML  file it created and the directory containing the ancil‐
16       liary files. It will then output a lot of *.3 man page files which  you
17       can then ship with your library.
18
19       You  will need to invoke this program once for each .h file in your li‐
20       brary, using the name of the generated .xml file. This file  will  usu‐
21       ally be called something like <include-file>_8h.xml, eg qbipcs_8h.xml
22
23       If  you want HTML output then simpy use nroff on the generated files as
24       you would do with any other man page.
25
26

OPTIONS

28       -a     Print ASCII dump of man pages to stdout
29
30       -m     Write man page files to <output dir>
31
32       -P     Print PARAMS section
33
34       -s <n> Write man pages into section <n> (default 3)
35
36       -p <package>
37              Use <package> name. default <Package>
38
39       -H <header>
40              Set header (default
41
42       -I <include>
43              Set the include filename (defaults to the one in the XML file or
44              unknown.h)
45
46       -i <prefix>
47              Set  the prefix for header files (eg qb/) if the are installed a
48              subdir of /usr/include
49
50       -C <company>
51              Set the company name in the copyright (default Red Hat)
52
53       -D <date>
54              Date to print at top of man pages (format not checked,  default:
55              today)
56
57       -Y <year>
58              Year to print at end of copyright line (default: today's year)
59
60       -S <year>
61              Year to print at start of copyright line (default: 2010)
62
63       -o <dir>
64              Write all man pages to <dir> (default .)
65
66       -d <dir>
67              Directory for XML files (./xml/)
68
69       -c     Use  the  Copyright  line  from the header file as the copyright
70              line in the manpage.  This requires that doxygen2man has  access
71              to the original .h file (see option -O below) and that the Copy‐
72              right line has a defined format. It whould be within  the  first
73              10  lines of the file and start with the text " * Copyright". If
74              this line is not found then the current year or  that  given  by
75              the -Y option will be used.
76
77       -O     Specifies  the  directory  containing the original header files.
78              This is (currently) only used by the -c option above.
79
80       -h     Print usage text
81
82

SEE ALSO

84       doxygen(1)
85

AUTHOR

87       Christine Caulfield
88
89                                  2020-09-09                    DOXYGEN2MAN(1)