Welcome to Linux Knowledge Base and Tutorial
"The place where you learn linux"
International Rescue Committe

 Create an AccountHome | Submit News | Your Account  

Tutorial Menu
Linux Tutorial Home
Table of Contents

· Introduction to Operating Systems
· Linux Basics
· Working with the System
· Shells and Utilities
· Editing Files
· Basic Administration
· The Operating System
· The X Windowing System
· The Computer Itself
· Networking
· System Monitoring
· Solving Problems
· Security
· Installing and Upgrading
· Linux and Windows

Glossary
MoreInfo
Man Pages
Linux Topics
Test Your Knowledge

Site Menu
Site Map
FAQ
Copyright Info
Terms of Use
Privacy Info
Disclaimer
WorkBoard
Thanks
Donations
Advertising
Masthead / Impressum
Your Account

Communication
Feedback
Forums
Private Messages
Surveys

Features
HOWTOs
News Archive
Submit News
Topics
User Articles
Web Links

Google
Google


The Web
linux-tutorial.info

Who's Online
There are currently, 55 guest(s) and 0 member(s) that are online.

You are an Anonymous user. You can register for free by clicking here

  

makekdedoc




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 documen­
       tation 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 writ­
           ten.   [`cwd`/srcdoc]

       --url <url>, -u <url>
           The base URL by which the generated docs will be
           accessed. For example, if your web server is config­
           ured 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.

       Rule file
           This file lists the directories in the source direc­
           tory 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 doc­
           umented then two files from "meenie/" will be docu­
           mented, 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)

An undefined database error occurred. SELECT distinct pages.pagepath,pages.pageid FROM pages, page2command WHERE pages.pageid = page2command.pageid AND commandid =


  

More information about the site can be found in the FAQ


Login
Nickname

Password

Security Code
Security Code
Type Security Code


Don't have an account yet? You can create one. As a registered user you have some advantages like theme manager, comments configuration and post comments with your name.

Help if you can!


Amazon Wish List

Did You Know?
The Linux Tutorial can use your help.


Friends



Tell a Friend About Us

Bookmark and Share



Web site powered by PHP-Nuke

Is this information useful? At the very least you can help by spreading the word to your favorite newsgroups, mailing lists and forums.
All logos and trademarks in this site are property of their respective owner. The comments are property of their posters. Articles are the property of their respective owners. Unless otherwise stated in the body of the article, article content (C) 1994-2013 by James Mohr. All rights reserved. The stylized page/paper, as well as the terms "The Linux Tutorial", "The Linux Server Tutorial", "The Linux Knowledge Base and Tutorial" and "The place where you learn Linux" are service marks of James Mohr. All rights reserved.
The Linux Knowledge Base and Tutorial may contain links to sites on the Internet, which are owned and operated by third parties. The Linux Tutorial is not responsible for the content of any such third-party site. By viewing/utilizing this web site, you have agreed to our disclaimer, terms of use and privacy policy. Use of automated download software ("harvesters") such as wget, httrack, etc. causes the site to quickly exceed its bandwidth limitation and are therefore expressly prohibited. For more details on this, take a look here

PHP-Nuke Copyright © 2004 by Francisco Burzi. This is free software, and you may redistribute it under the GPL. PHP-Nuke comes with absolutely no warranty, for details, see the license.
Page Generation: 0.04 Seconds