Development/Tutorials/Man Pages - Revision history

Neverendingo: Text replace - "" to ""

2011-06-29T20:53:04Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:39:23Z
Text replace - "<code bash>" to "<syntaxhighlight lang="bash">"

				
				
				
				
			
			← Older revision
			Revision as of 20:39, 29 June 2011
			
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



Deepu2sw at 05:34, 27 July 2009
2009-07-27T05:34:58Z


				
				
				
				
			
			← Older revision
			Revision as of 05:34, 27 July 2009
			
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



Winterz: First draft
2007-09-27T17:30:33Z
First draft
New page
== Writing and Generating Reference Manual Pages ==



=== Applications ===



[todo]



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



To use:

<code bash>

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