NAME¶
kdemangen.pl - automatically create a draft manpage for a KDE app
SYNOPSIS¶
kdemangen.pl /path/to/application
DESCRIPTION¶
kdemangen.pl will automatically create a draft manpage for a KDE
application. Manpages are always better when hand-tailored, but this should
give you a fairly good start.
To create the manpage, it will use the --author and --help-all output for the
application passed on the command line. It will also use the description in
the Debian control file if one is available. To make use of this additional
feature, you must run kdemangen.pl from within the
debian/ subdirectory
of the application sources.
The new manpage will be written to standard output.
This utility is part of the KDE Software Development Kit.
WARNING¶
This utility will only work for a full KDE application that uses KCmdLineArgs
(which most full KDE applications do).
EXAMPLE¶
cd /path/to/kde/srcs/kdeedu/debian
kdemangen /usr/bin/kstars > kstars.1
AUTHOR¶
kdemangen.pl was written by Dominique Devriese <devriese@kde.org>.
This manual page was prepared by Ben Burton <bab@debian.org> for the
Debian GNU/Linux system (but may be used by others).