kcontrol/kdm:
[pardus-kurumsal-2-kde3:kdebase.git] / README
1 In this file:
2
3 * About kdebase
4 * Thank you
5 * Common Mistakes
6 * Configuring
7 * Debugging
8 * Upgrading
9 * Removal/Uninstallation
10 * More Info
11
12
13 About kdebase
14 -------------
15 kdebase is the second mandatory package (besides kdelibs) for the K Desktop
16 Environment. Here we have various applications and infrastructure files and
17 libraries. Here is an overview of the directories:
18
19 * applnk
20     Files to create the icons for the K menu button
21
22 * debian
23     Needed to create a Debian package.
24
25 * doc
26     XML formatted documentation files for the apps
27
28 * drkonqi
29     If ever an app crashes (heaven forbid!) then Dr.Konqi will be so kind
30     and make a stack trace. This is a great help for the developers to fix
31     the bug.
32
33 * kappfinder
34     Searches for non-KDE applications, e.g. Acrobat Reader (tm) and installs
35     those apps under the K start button.
36
37 * kate
38     A fast and advanced text editor, extensible with nice plugins.
39
40 * kcheckpass
41     Small program to enter and check passwords, to be used by other
42     programs.
43
44 * kcontrol
45     The KDE Control Center allows you to tweak the KDE settings.
46
47 * kdcop
48     GUI app to browse for DCOP interfaces, can also execute them.
49
50 * kdebugdialog
51     Allows you to specify which debug messages you want to see.
52
53 * kdeprint
54     The KDE printing system.
55
56 * kdesktop
57     You guessed it: the desktop above the panel.
58
59 * kdesu
60     A graphical front end to "su".
61
62 * kdialog
63     Allows to display menu boxes from shell scripts.
64
65 * kdm
66     Replacement for XDM, for those people that like graphical logins.
67
68 * kfind
69     File find utility (standalone and in Konqueror's file manager).
70
71 * khelpcenter
72     Used to to read all great documentation about KDE, unix man pages,
73     info pages etc.
74
75 * khotkeys
76     Intercepts keys and can call applications.
77
78 * kicker
79     The panel at the botton with the K start button and the taskbar etc.
80
81 * kioslave
82     Infrastructure that helps make every application internet enabled
83     e.g. to directly save a file to ftp://place.org/dir/file.txt
84
85 * klipper
86     Taskbar applet that enhances and extenses the X clipboard.
87
88 * kmenuedit
89     Edit for the menu below the K start button.
90
91 * konqueror
92     The file manager and web browser you get easily used to.
93
94 * konsole
95     A shell program similar to xterm.
96
97 * kpager
98     Applet to show the contents of the virtual desktops.
99
100 * kreadconfig
101     A tool for shell scripts to get info from KDE's config files.
102
103 * krichtexteditor
104     A embeddable rich text editor and a wrapper application for it.
105
106 * kscreensaver
107     The KDE screensaver environment and some basic screensavers. More
108     of them are in the kdeartwork package.
109
110 * ksmserver
111     The KDE session manager (saves program status on login, restarts
112     those program at the next login).
113
114 * kdepasswd
115     A KDE frontend for passwd. Also contains the "Password & User Information" KCM.
116
117 * ksplashml
118     The screen displayed while KDE starts.
119
120 * kstart
121     Launches applications with special window properties such as iconified,
122     etc.
123
124 * ksysguard
125     Task manager and system monitor, can work with remote systems.
126
127 * ksystraycmd
128     Allows to run any application in the system tray.
129
130 * ktip
131     Gives you tips how to use KDE.
132
133 * kwin
134     The KDE window manager (moves, resizes and decorates windows).
135
136 * kxkb
137     A keyboard map tool.
138
139 * l10n
140     l-10letters-n: localization. Mostly country flags.
141
142 * libkonq
143     Some libraries needed by Konqueror.
144
145 * nsplugins
146     Together with OSF/Motif or Lesstif allows you to use Netscape (tm)
147     plugins in Konqueror.
148
149 * pics
150     Various icons and wallpapers.
151
152
153 Thanks!
154 -------
155 Thank you Steven M. Scotten and Kuno Raffi (weave) for creating artwork
156 specifically for the K Desktop Environment.  Your efforts are much
157 appreciated.
158
159 Mr. Scotten has created: blue_angle_swirl, bluecheck, bluegreencrisscross,
160 bluegreensilver, candystripe_chainlink, charcoal_sunset, fadedpaint,
161 garden_lattice, ghost_lightning, glassywarpcheck, gold_crinkle, greenish,
162 heavens_hex, latte, lime_vibration, liquid_canvas, northbeach,
163 orange_stacks, purple_swirl, string_theory, sunday_brunch,
164 toothofthehoundthatbitcha, vegetative_fog, wavetron, woodcheck
165
166
167 Common Mistakes
168 ---------------
169 IMPORTANT: most applications need KDEDIR as the directory where KDE is
170 installed.  Please set this in your login file.
171
172 If XPM support wasn't configured, it may be that configure has no idea where
173 your XPM libraries are.  If so, set XPM_INCLUDE and XPM_LDFLAGS to the paths
174 where configure should look for XPM.  But if you haven't installed XPM or it
175 didn't come with your system, that's no problem.  You will only miss a few
176 screensavers.  The same thing applies with OPENGL support.  Here you have to
177 set GL_INCLUDE and GL_LDFLAGS.
178
179 If configure claims Qt cannot be found, have a look at
180 ftp://ftp.trolltech.com and download the latest Qt 3.3.x release.
181
182 Be advised, if you're using FreeBSD, then please do not use the Qt port that
183 comes along with it.
184
185 Configuring
186 -----------
187 kdebase's configure script supports all the standard GNU autoconf options
188 (you can have the various options listed for you by specifying the --help
189 switch), plus the following options are also supported.  Note: the *non*
190 default variation is listed, so if you see --enable-debug, the default is
191 --disable debug.
192
193 `--x-includes=DIR'
194      use X include files in DIR
195
196 `--x-libraries=DIR'
197      use X library files in DIR
198
199 `--enable-debug'
200      creates debugging code [default=no]
201
202 `--enable-strict'
203      Add strict[er] compiler options (may not work!) to the CFLAGS and
204      CXXFLAGS.  This is GNU CC specific for the time being.
205
206 `--with-gnu-ld'
207      assume the C compiler uses GNU ld [default=no]
208
209 `--disable-libtool-lock'
210      force libtool not to do file locking
211
212 `--disable-nls'
213      do not use Native Language Support (i18n)
214
215 `--with-qt-dir'
216      where the root of qt is installed 
217
218 `--with-qt-includes=DIR'
219      look for the Qt header files in DIR
220
221 `--with-qt-libraries=DIR'
222      look for the Qt library in DIR
223
224 `--with-extra-includes=DIR'
225      look for include files in DIR in addition to any other
226      `standard' paths
227
228 `--with-extra-libs=DIR'
229      look for [extra] libraries in DIR too
230
231 `--disable-path-check'
232      don't try to make sure that kdebase is installed into the same
233      base KDE directory as the rest of KDE
234  
235 `--with-install-root=DIR'
236      the root to install to [default=/] (i.e. make / == DIR, so /usr
237      becomes DIR/usr)
238
239 `--disable-rpath'
240      do not use the rpath feature of ld
241
242 `--with-xdmdir=DIR'
243      use xdm (and config files) from DIR if the xdm config dir can't be
244      found automaticly
245
246 `--with-pam[=ARG]'
247      enable support for PAM: ARG=[yes|no|service name]
248
249 `--with-shadow'
250      if you want to check for and use shadow password support if it's present
251
252 `--without-gl'
253      disable any software which depends on OpenGL
254
255 `--without-xpm'
256      disable color pixmap XPM tests
257
258 `--with-xinerama'
259      enable Xinerama support
260
261 Please check ./configure --help for a more current list of options and what
262 they do. 
263
264
265 Debugging
266 ---------
267 You can use --enable-debug with the configure script, if you want to have
268 debug code in your KDE apps and libs. If you experience problems and want to
269 report problems to the KDE Bugs database, it is recommended to recompile
270 with this switch enabled to make the backtraces more verbose (and thus
271 giving the developer more information about the cause of the bug).
272
273
274 Removal/Uninstallation
275 ----------------------
276 You can use 'make uninstall' if you want to remove the kde from the dirs.
277 This feature has not been tested completely, and is depreciated. On a system
278 where KDEDIR is specific to KDE (i.e. not /usr), rm -rf $KDEDIR does it as
279 well.
280
281
282 More Info
283 ---------
284 If your system does not have XPM installed, and you cannot locate a package
285 of it, you may obtain it from ftp://avahi.inria.fr/pub/xpm, or you may find
286 it in ftp://ftp.freebsd.org/pub/FreeBSD/distfiles
287
288 If you are running a FreeBSD system, you will need to make sure that LIBS is
289 set to "-Wl,-export-dynamic".  The easiest way to do this is to prefix
290 configure with it, i.e.: LIBS="-Wl,-export-dynamic" ./configure.  Thanks to
291 Will Andrews <will@FreeBSD.org> and Arun Sharma <adsharma@sharmas.dhs.org>
292 for identifying what needed to be done, and how to do it, and such.
293
294 If your system supports PAM (Plugable Authentication Modules), please see
295 the README.pam file in this directory for more information about using KDE
296 with PAM.
297
298 Have a look at the individual subdirectories, if you would like to find out
299 more about a specific application included in kdebase.
300
301 More FAQs on http://www.kde.org/info/faq.html
302
303 If you have problems compiling and installing this package, please check the
304 kde-devel@kde.org mailing list archive (see http://lists.kde.org) to see if
305 somebody had a similiar problem already. If not, try posting a message to
306 the list with detailed information about the compile problem.
307
308 General KDE discussions should go to the KDE mailing list (kde@kde.org).
309