makekdedoc(1) [redhat man page]

MAKEKDEDOC(1)						     KDOC Documentation System						     MAKEKDEDOC(1)

NAME

       makekdedoc -- Generates HTML documentation for KDE libraries using KDOC.

SYNOPSIS

	       makekdedoc [--rule-file=<rulefile>] [--libdir=<libdir>]
		       [--outputdir=<outputdir>] [--url=<url>]
		       [--srcdir=<kdelibs src dir>]
		       [--kdoc=<path to kdoc>] [<library>...]

	       makekdedoc --help

DESCRIPTION

       This is a perl script that uses KDOC to generate documentation for kdelibs. A "rule" file is used to figure out the libraries to document,
       the order in which to document them and the libraries with which each one will be cross-referenced (eg kdeui uses -lkdecore). See "FILES"
       for more info.

       NOTE: The script assumes that you have already generated a Qt cross-reference using qt2kdoc[1].

OPTIONS

       Defaults for each option are in square brackets.

       library...
	   Specify the libraries to document.  By default, all libraries defined by the rule file are documented.

       --outputdir <path>, -d <path>
	   The directory where the output will be written.   [`cwd`/srcdoc]

       --url <url>, -u <url>
	   The base URL by which the generated docs will be accessed. For example, if your web server is configured to use $HOME/public_html for
	   your home page, you could set the outputdir to $HOME/public_html/srcdoc and the url to http://myhost/~mylogin/srcdoc. [output dir]

       --rule-file <path>, -r <path>
	   The path to the rule file to use for generating the documentation.  [<srcdir>/kdoc.rules]

       --libdir <path>, -L <path>
	   The directory in which the KDOC cross-reference files are stored. [$KDOCLIBS if set, otherwise $HOME/.kdoc]

       --kdoc <path>, -k <path>
	   The path to the kdoc program. [kdoc]

       --kdocopt <options>, -p <options>
	   Extra options to be passed to kdoc.

       --srcdir <path>, -b <path>
	   The path to the kdelibs source, eg "$HOME/baseline/kdelibs". [`cwd`]

       --help, -h
	   Quit with a usage message.

EXAMPLES

	       makekdedoc --srcdir $HOME/baseline/kdelibs
		       --outputdir $HOME/public_html/src/kdelibs/
		       --url "http://www.ph.unimelb.edu.au/~ssk/src/kdelibs"

FILES

       Rule file
	   This file lists the directories in the source directory to document. It also lists the files to document from each directory, and the
	   libraries with which to cross-reference the generated documentation. Here is a small example that documents two libraries and links the
	   second to the first.

		   # makekdedoc rule file
		   doc_MODULES = eenie meenie

		   # rules for eenie
		   eenie_FILES = *.h
		   eenie_LIBS = -lqt

		   # rules for meenie
		   meenie_FILES = a.h b.h
		   meenie_LIBS = -leenie -lqt

	   In this example, all files in "eenie/*.h" will be documented then two files from "meenie/" will be documented, in the order declared in
	   "doc_MODULES".

SEE ALSO

       See kdoc[1] and qt2kdoc[1].

VERSION

	       makekdedoc $Revision: 1.2 $

AUTHOR

       The script and this documentation were written by Sirtaj Singh Kang <taj@kde.org> in April 1999.

2.0a54								    2000-10-10							     MAKEKDEDOC(1)

Check Out this Related Man Page

MEINPROC4(8)							 KDE User's Manual						      MEINPROC4(8)

NAME

       meinproc4 - KDE translator for XML

SYNOPSIS

       meinproc4 [--help] [Generic-options] [Qt-options] [KDE-options] [--cache file] [--check] [--htdig] [--srcdir] [--param key=value] [[[-o] |
		 [--output]] file] [--stdout] [--stylesheet xsl] docbook_file

DESCRIPTION

       meinproc4 converts DocBook files to HTML.

GENERIC OPTIONS

       --author
	   Show author information.

       --help
	   Show help about options.

       --help-all
	   Show all options.

       --help-kde
	   Show KDE specific options.

       --help-qt
	   Show Qt specific options.

       --license
	   Show license information.

       -v--version
	   Show version information

APPLICATION OPTIONS

       --cache file
	   Create a cache file for the document

       --check
	   Check the document for validity

	       The output can be a bit daunting, since one small mistake can cause a cascade of errors.
	       The trick is to look at the first error, fix that error, save the file, and run meinproc4 again.

       --htdig
	   Create a ht://dig compatible index

       -o, --output file
	   Output whole document to file.

       --stdout
	   Output whole document to stdout.

       --stylesheet xsl
	   Stylesheet to use

       --srcdir dir
	   Set the root directory to look for kdelibs

       --param key=value
	   Set parameters to pass to the stylesheet.

USAGE

       The most common way to run meinproc4 is simply as

	   meinproc4 docbook-file

       where docbook-file is usually index.docbook. This command creates HTML pages from the DocBook file. Note that these pages are only viewable
       in KDE-based browsers (like Konqueror).

       If you need to view the HTML output in another browser (for example, if you're placing it on line), use

	   meinproc4 --stylesheet stylesheet-name docbook-file

       where stylesheet-name is the full path to one of the XSL stylesheets in $KDEDIR/share/apps/ksgmltools/customization. To produce output
       suitable for the web, you can use kde-web.xsl or kde-chunk-online.xsl. See the README file in that directory for more details.

SEE ALSO

       kdeoptions(7), qtoptions(7)

BUGS

       There are probably tons of bugs. Use bugs.kde.org[1] to report them.

NOTES

	1. bugs.kde.org
	   http://bugs.kde.org

0.01.01 							    2008-10-03							      MEINPROC4(8)

Linux and UNIX Man Pages

makekdedoc(1) [redhat man page]

Check Out this Related Man Page