Development/Tutorials/Man Pages

< Development‎ | Tutorials
Revision as of 17:30, 27 September 2007 by Winterz (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Writing and Generating Reference Manual Pages



API documentation

The API documentation is generated from the KDE source code using the doxygen program. We provide a simple wrapper script called that sets the necessary configuration.

To use: % cd trunk/KDE/kdelibs % ../kdesdk/scripts/ -d /path/to/kde/share [...Wait...]

Replacing /path/to/kde in these instructions with the real path to your KDE4 installation.

Repeat for other KDE modules: kdepimlibs, etc.

Now add /path/to/kde/share/man to your MANPATH environment variable (or add "MANPATH /path/to/kde/share/man" to your /etc/man.config file). At this point you should be about to run 'man KAboutData', for example, from the comfort of your konsole command line.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal