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

Jump to: navigation, search
(First draft)
 
Line 3: Line 3:
 
=== Applications ===
 
=== Applications ===
  
[todo]
+
'''[todo]'''
  
 
=== API documentation ===
 
=== API documentation ===
 
The API documentation is generated from the KDE source code using the {{program|doxygen}} program. We provide a simple wrapper script called {{program|kdedoxyman.sh}} that sets the necessary {{program||doxygen}} configuration.
 
The API documentation is generated from the KDE source code using the {{program|doxygen}} program. We provide a simple wrapper script called {{program|kdedoxyman.sh}} that sets the necessary {{program||doxygen}} configuration.
  
To use:
+
'''To use:'''
 
<code bash>
 
<code bash>
 
% cd trunk/KDE/kdelibs
 
% cd trunk/KDE/kdelibs

Revision as of 06:34, 27 July 2009

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...]

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