Neverendingo (Talk | contribs) m (Text replace - "<code bash>" to "<syntaxhighlight lang="bash">") |
Neverendingo (Talk | contribs) m (Text replace - "</code>" to "</syntaxhighlight>") |
||
| Line 13: | Line 13: | ||
% ../kdesdk/scripts/kdedoxyman.sh -d /path/to/kde/share | % ../kdesdk/scripts/kdedoxyman.sh -d /path/to/kde/share | ||
[...Wait...] | [...Wait...] | ||
| − | </ | + | </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. | ||
[todo]
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 TechBase 