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

Jump to: navigation, search
(First draft)
 
m (Text replace - "</code>" to "</syntaxhighlight>")
 
(2 intermediate revisions by 2 users not shown)
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>
+
<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
 
[...Wait...]
 
[...Wait...]
</code>
+
</syntaxhighlight>
 
   
 
   
 
Replacing {{path|/path/to/kde}} in these instructions with the real path to your KDE4 installation.
 
Replacing {{path|/path/to/kde}} in these instructions with the real path to your KDE4 installation.

Latest revision as of 21:53, 29 June 2011

[edit] Writing and Generating Reference Manual Pages

[edit] Applications

[todo]

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


This page was last modified on 29 June 2011, at 21:53. This page has been accessed 8,005 times. Content is available under Creative Commons License SA 3.0 as well as the GNU Free Documentation License 1.2.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal