DOXYGEN2MAN(1)

💖 DOXYGEN2MAN(1) 💖

okay bestie, gather round, because this is the manual page for doxygen2man — section 1 of the manual, in case you were wondering where to find her 💅

✨ NAME ✨

doxygen2man — a tool that generates man pages out of Doxygen XML files 🎀

🌸 SYNOPSIS 🌸

doxygen2man [OPTIONS] <XML file>

🦋 DESCRIPTION 🦋

So here's the tea, bestie: this is a tool that generates API manpages from a doxygen-annotated header file. First you run doxygen on the file, and then you run this program against the main XML file it created and the directory containing the ancilliary files. After that it will output a lot of *.3 man page files which you can then ship with your library. iconic behaviour, honestly 👑

You will need to invoke this program once for each .h file in your library, using the name of the generated .xml file. That file will usually be called something like <include-file>_8h.xml, eg qbipcs_8h.xml. iykyk 🫶

If you want HTML output then simpy use nroff on the generated files as you would do with any other man page. (yes, "simpy", that's what she wrote, and we love her for it 💀)

💅 OPTIONS 💅

• -a — print an ASCII dump of the man pages to stdout
• -m — write the man page files to <output dir>
• -P — print the PARAMS section
• -s <n> — write the man pages into section <n> (default 3)
• -p <package> — use the <package> name. default <Package>
• -H <header> — set the header (default — and yeah the original page literally just says (default and stops, no cap, so that's all we got 💀)
• -I <include> — set the include filename (defaults to the one in the XML file, or unknown.h)
• -i <prefix> — set the prefix for header files (eg qb/) if they are installed a subdir of /usr/include
• -C <company> — set the company name in the copyright (default Red Hat)
• -D <date> — the date to print at the top of the man pages (format not checked, default: today)
• -Y <year> — the year to print at the end of the copyright line (default: today's year)
• -S <year> — the year to print at the start of the copyright line (default: 2010)
• -o <dir> — write all man pages to <dir> (default .)
• -d <dir> — directory for XML files (./xml/)
• -c — use the Copyright line from the header file as the copyright line in the manpage. This requires that doxygen2man has access to the original .h file (see option -O below) and that the Copyright line has a defined format. It whould be within the first 10 lines of the file and start with the text * Copyright. If this line is not found then the current year, or the one given by the -Y option, will be used. (again, "whould" — she's doing her best, we stan 🥰)
• -O — specifies the directory containing the original header files. This is (currently) only used by the -c option above.
• -h — print usage text

👀 SEE ALSO 👀

doxygen(1) — go say hi to her too 🫶

💜 AUTHOR 💜

Christine Caulfield — thank you queen, we are obsessed 🌈

and that's the whole page, bestie!! no notes, she ate and left absolutely no crumbs 👑

doxygen2man(1) — dated 2020-09-09 — slay, periodt 💖✨🎀