summaryrefslogtreecommitdiffstats
path: root/ubuntu/maverick_automake/kdesdk/debian/man/kdedoc.1
blob: fe5568a205d65092b52aefb4a3940d6d1d3ed7f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH KDEDOC 1 "January 31, 2004"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
kdedoc \- view documentation for a KDE class
.SH SYNOPSIS
.B kdedoc
.I classname
.SH DESCRIPTION
\fBkdedoc\fP opens the documentation for the KDE class \fIclassname\fP
in kfm/konqueror.  Note that the class name is case sensitive.  It is
assumed that you have the kdelibs documentation installed.
.PP
This utility is part of the KDE Software Development Kit.
.SH EXAMPLES
To bring up help on the class TDEAboutDialog:
.PP
.RS
kdedoc TDEAboutDialog
.RE
.SH DEBIAN USERS
The kdelibs documentation is in the Debian package \fIkdelibs4-doc\fP,
which will need to be installed.
.SH SEE ALSO
.BR qtdoc (1).
.SH AUTHOR
This manual page was prepared by Ben Burton <bab@debian.org>
for the Debian GNU/Linux system (but may be used by others).