mirror of
https://salsa.debian.org/ha-team/libqb
synced 2025-08-26 23:44:41 +00:00
6853eeaea6
* Fix documentation typo in qbrb.h * Fix section number in doxygen2man manual * Point Doxygen to our examples * No HTML documentation anymore
91 lines
2.5 KiB
Groff
91 lines
2.5 KiB
Groff
.\"
|
|
.\" * Copyright (C) 2010-2020 Red Hat, Inc.
|
|
.\" *
|
|
.\" * All rights reserved.
|
|
.\" *
|
|
.\" * Author: Christine Caulfield <ccaulfie@redhat.com>
|
|
.\" *
|
|
|
|
.TH "DOXYGEN2MAN" "1" "2020-09-09" "" ""
|
|
.SH "NAME"
|
|
doxygen2man \- A tool to generate man pages from Doxygen XML files
|
|
.SH "SYNOPSIS"
|
|
.B doxygen2man [OPTIONS] <XML file>
|
|
.SH "DESCRIPTION"
|
|
.P
|
|
This is a tool to generate API manpages from a doxygen-annotated header file
|
|
First run doxygen on the file and then run this program against the main XML file
|
|
it created and the directory containing the ancilliary files. It will then
|
|
output a lot of *.3 man page files which you can then ship with your library.
|
|
.P
|
|
You will need to invoke this program once for each .h file in your library,
|
|
using the name of the generated .xml file. This file will usually be called
|
|
something like <include-file>_8h.xml, eg qbipcs_8h.xml
|
|
.P
|
|
If you want HTML output then simpy use nroff on the generated files as you
|
|
would do with any other man page.
|
|
|
|
.SH "OPTIONS"
|
|
.TP
|
|
.B -a
|
|
Print ASCII dump of man pages to stdout
|
|
.TP
|
|
.B -m
|
|
Write man page files to <output dir>
|
|
.TP
|
|
.B -P
|
|
Print PARAMS section
|
|
.TP
|
|
.B -s <n>
|
|
Write man pages into section <n> (default 3)
|
|
.TP
|
|
.B -p <package>
|
|
Use <package> name. default <Package>
|
|
.TP
|
|
.B -H <header>
|
|
Set header (default \"Programmer's Manual\")
|
|
.TP
|
|
.B -I <include>
|
|
Set the include filename (defaults to the one in the XML file or unknown.h)
|
|
.TP
|
|
.B -i <prefix>
|
|
Set the prefix for header files (eg qb/) if the are installed a subdir of /usr/include
|
|
.TP
|
|
.B -C <company>
|
|
Set the company name in the copyright (default Red Hat)
|
|
.TP
|
|
.B -D <date>
|
|
Date to print at top of man pages (format not checked, default: today)
|
|
.TP
|
|
.B -Y <year>
|
|
Year to print at end of copyright line (default: today's year)
|
|
.TP
|
|
.B -S <year>
|
|
Year to print at start of copyright line (default: 2010)
|
|
.TP
|
|
.B -o <dir>
|
|
Write all man pages to <dir> (default .)
|
|
.TP
|
|
.B -d <dir>
|
|
Directory for XML files (./xml/)
|
|
.TP
|
|
.B -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 that given by the -Y option will be used.
|
|
.TP
|
|
.B -O
|
|
Specifies the directory containing the original header files. This is (currently) only
|
|
used by the -c option above.
|
|
.TP
|
|
.B -h
|
|
Print usage text
|
|
|
|
.SH "SEE ALSO"
|
|
.BR doxygen (1)
|
|
.SH "AUTHOR"
|
|
Christine Caulfield
|
|
.PP
|