1DOXY2MAN(8)                                                        DOXY2MAN(8)
2
3
4

NAME

6       doxy2man - Create man pages from doxygen XML output.
7

SYNOPSIS

9       doxy2man [OPTIONS]
10

DESCRIPTION

12       Doxygen is great for generating HTML based API documentation. But the
13       man page output mode of doxygen (GENERATE_MAN = YES) is not that
14       awesome. Doxygen generates for a header file a man page with all
15       functions, enums etc. For each structure it generates a man page
16       listing all its (public) attributes. For C based projects this is not
17       very useful, because one usually expects things like one man page for
18       each function and referenced structs documented where used.
19
20       Doxy2man takes the XML generated by Doxygen as input and creates
21       several man pages from that. It creates a summary man page for a header
22       and for each function a detailed man page. The output is optimized for
23       C projects. It supports the most common doxygen features, e.g. implicit
24       and explicit see also tags, copyright, author information, brief and
25       detailed descriptions, etc.
26

USAGE

28       Create a small Doxygen configuration file. To enable XML output use
29       something like this:
30
31           GENERATE_XML           = YES
32           XML_OUTPUT             = xml
33           XML_PROGRAMLISTING     = NO
34
35       Call doxygen:
36
37           $ doxygen
38
39       The xml subdirectory should contain some XML files now.
40
41       Call doxy2man:
42
43           $ ./doxy2man xml/myheader_8h.xml
44
45       View the man pages:
46
47           $ ls out
48           ...
49           $ man -l out/my_header.h.3
50           $ man -l out/my_func_a.3
51           $ man -l out/my_func_b.3
52           ...
53

OPTIONS

55       Doxy2man implements several useful defaults but is also customizable:
56
57           $ ./doxy2man --help
58           Generates man pages from doxygen XML output
59
60           call: ./doxy2man OPTIONS DOXYGEN_XML_HEADER_FILE
61
62           where
63
64           -h,     --help           this screen
65                   --nowarn         suppress warnings
66                   --nosummary      don't generate summare man page
67                   --nocopyright    don't generate copyright section
68                   --nofollow       don't parse referenced xml files
69                   --novalidate     don't validate xml files against compound.xsd
70                   --noseealsoall   don't add all functions under see also
71                   --nosort         don't sort functions under see also
72                   --nostructs      don't print structs in function man pages
73           -o DIR, --out DIR        output directory
74           -s STR, --section STR    man page section
75                   --short-pkg STR  short man page header/footer string, e.g. 'Linux'
76                   --pkg STR        man page header/footer string, e.g. 'Linux Programmer's Manual'
77           -i STR, --include STR    include path prefix
78

AUTHOR

80       Written by Georg Sauthoff <mail@georg.so>
81
82       Don’t hesitate to mail questions, comments or other feedback.
83

LICENSE

85       GPLv3+
86
87
88
89doxy2man                          01/19/2023                       DOXY2MAN(8)
Impressum