Difference between revisions of "Development/Tutorials/Man Pages"

Jump to: navigation, search
m (Text replace - "<code bash>" to "<syntaxhighlight lang="bash">")
Line 9: Line 9:
  
 
'''To use:'''
 
'''To use:'''
<code bash>
+
<syntaxhighlight lang="bash">
 
% cd trunk/KDE/kdelibs
 
% cd trunk/KDE/kdelibs
 
% ../kdesdk/scripts/kdedoxyman.sh -d /path/to/kde/share
 
% ../kdesdk/scripts/kdedoxyman.sh -d /path/to/kde/share

Revision as of 21:39, 29 June 2011

Writing and Generating Reference Manual Pages

Applications

[todo]

API documentation

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

To use:

% cd trunk/KDE/kdelibs
% ../kdesdk/scripts/kdedoxyman.sh -d /path/to/kde/share
[...Wait...]
</code>
 
Replacing {{path|/path/to/kde}} in these instructions with the real path to your KDE4 installation.
 
Repeat for other KDE modules: {{module|kdepimlibs}}, etc.
 
Now add {{path|/path/to/kde/share/man}} to your MANPATH environment variable (or add "MANPATH /path/to/kde/share/man" to your {{path|/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