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
  20 * doc
  21     XML formatted documentation files for the apps
  22
  23 * drkonqi
  24     If ever an app crashes (heaven forbid!) then Dr.Konqi will be so kind
  25     and make a stack trace. This is a great help for the developers to fix
  26     the bug.
  27
  28 * kappfinder
  29     Searches for non-KDE applications, e.g. Acrobat Reader (tm) and installs
  30     those apps under the K start button.
  31
  32 * kcheckpass
  33     Small program to enter and check passwords, to be used by other
  34     programs.
  35
  36 * kcontrol
  37     The KDE Control Center allows you to tweak the KDE settings.
  38
  39 * kdebugdialog
  40     Allows you to specify which debug messages you want to see.
  41
  42 * kdeprint
  43     The KDE printing system.
  44
  45 * kdesktop
  46     You guessed it: the desktop above the panel.
  47
  48 * kdesu
  49     A graphical front end to "su".
  50
  51 * kdialog
  52     Allows to display menu boxes from shell scripts.
  53
  54 * kdm
  55     Replacement for XDM, for those people that like graphical logins.
  56
  57 * kfind
  58     File find utility (standalone and in Konqueror's file manager).
  59
  60 * khelpcenter
  61     Used to to read all great documentation about KDE, unix man pages,
  62     info pages etc.
  63
  64 * khotkeys
  65     Intercepts keys and can call applications.
  66
  67 * kicker
  68     The panel at the botton with the K start button and the taskbar etc.
  69
  70 * kioslave
  71     Infrastructure that helps make every application internet enabled
  72     e.g. to directly save a file to ftp://place.org/dir/file.txt
  73
  74 * klipper
  75     Taskbar applet that enhances and extenses the X clipboard.
  76
  77 * kmenuedit
  78     Edit for the menu below the K start button.
  79
  80 * konqueror
  81     The file manager and web browser you get easily used to.
  82
  83 * konsole
  84     A shell program similar to xterm.
  85
  86 * kreadconfig
  87     A tool for shell scripts to get info from KDE's config files.
  88
  89 * kscreensaver
  90     The KDE screensaver environment and some basic screensavers. More
  91     of them are in the kdeartwork package.
  92
  93 * ksmserver
  94     The KDE session manager (saves program status on login, restarts
  95     those program at the next login).
  96
  97 * kdepasswd
  98     A KDE frontend for passwd. Also contains the "Password & User Information" KCM.
  99
 100 * ksplashml
 101     The screen displayed while KDE starts.
 102
 103 * kstart
 104     Launches applications with special window properties such as iconified,
 105     etc.
 106
 107 * ksysguard
 108     Task manager and system monitor, can work with remote systems.
 109
 110 * ksystraycmd
 111     Allows to run any application in the system tray.
 112
 113 * ktip
 114     Gives you tips how to use KDE.
 115
 116 * kwin
 117     The KDE window manager (moves, resizes and decorates windows).
 118
 119 * kxkb
 120     A keyboard map tool.
 121
 122 * l10n
 123     l-10letters-n: localization. Mostly country flags.
 124
 125 * libkonq
 126     Some libraries needed by Konqueror.
 127
 128 * nsplugins
 129     Together with OSF/Motif or Lesstif allows you to use Netscape (tm)
 130     plugins in Konqueror.
 131
 132 * pics
 133     Various icons and wallpapers.
 134
 135
 136 Thanks!
 137 -------
 138 Thank you Steven M. Scotten and Kuno Raffi (weave) for creating artwork
 139 specifically for the K Desktop Environment.  Your efforts are much
 140 appreciated.
 141
 142 Mr. Scotten has created: blue_angle_swirl, bluecheck, bluegreencrisscross,
 143 bluegreensilver, candystripe_chainlink, charcoal_sunset, fadedpaint,
 144 garden_lattice, ghost_lightning, glassywarpcheck, gold_crinkle, greenish,
 145 heavens_hex, latte, lime_vibration, liquid_canvas, northbeach,
 146 orange_stacks, purple_swirl, string_theory, sunday_brunch,
 147 toothofthehoundthatbitcha, vegetative_fog, wavetron, woodcheck
 148
 149
 150 Common Mistakes
 151 ---------------
 152 IMPORTANT: most applications need KDEDIRS as the directory where KDE is
 153 installed.  Please set this in your login file. KDEDIR is deprecated starting
 154 with KDE 4. Instead use KDEDIRS, which can also hold a list of directories.
 155
 156 If XPM support wasn't configured, it may be that configure has no idea where
 157 your XPM libraries are.  If so, set XPM_INCLUDE and XPM_LDFLAGS to the paths
 158 where configure should look for XPM.  But if you haven't installed XPM or it
 159 didn't come with your system, that's no problem.  You will only miss a few
 160 screensavers.  The same thing applies with OPENGL support.  Here you have to
 161 set GL_INCLUDE and GL_LDFLAGS.
 162
 163 If configure claims Qt cannot be found, have a look at
 164 ftp://ftp.trolltech.com and download the latest Qt 4.x.x release, at least Qt 4.4.0.
 165
 166 Be advised, if you're using FreeBSD, then please do not use the Qt port that
 167 comes along with it.
 168
 169 Configuring
 170 -----------
 171
 172 KDE 4 is built using CMake (http://www.cmake.org), version 2.4.5 is the minimum
 173 required version. This means there is no configure-script anymore, but you
 174 need to run cmake.
 175 Before building kdebase, you need to build and install kdepimlibs, this is
 176 new compared to KDE < 4.
 177 Most of the options which were supported by the "old" configure script
 178 are already also supported with the new buildsystem. To adjust these options,
 179 use ccmake, there you can see them all. They have been slightly renamed
 180 compared to the configure-options:
 181
 182 These are the installation directories, by default they are all
 183 located beneath /usr/local, but you can adjust each of them individually.
 184
 185  CONFIG_INSTALL_DIR       - the config file install dir
 186  DATA_INSTALL_DIR         - the parent directory where applications can install their data
 187  HTML_INSTALL_DIR         - the HTML install dir for documentation
 188  ICON_INSTALL_DIR         - the icon install dir (default prefix/share/icons/)
 189  INFO_INSTALL_DIR         - the kde info install dir (default prefix/info)
 190  KCFG_INSTALL_DIR         - the install dir for kconfig files
 191  LIB_INSTALL_DIR          - the subdirectory relative to the install prefix where libraries will b
 192  LOCALE_INSTALL_DIR       - the install dir for translations
 193  MAN_INSTALL_DIR          - the kde man page install dir (default prefix/man/)
 194  MIME_INSTALL_DIR         - the install dir for the mimetype desktop files
 195  PLUGIN_INSTALL_DIR       - the subdirectory relative to the install prefix where plugins will be
 196  SERVICES_INSTALL_DIR     - the install dir for service (desktop, protocol, ...) files
 197  SERVICETYPES_INSTALL_DIR - the install dir for servicestypes desktop files
 198  SOUND_INSTALL_DIR        - the install dir for sound files
 199  TEMPLATES_INSTALL_DIR    - the install dir for templates (Create new file...)
 200  WALLPAPER_INSTALL_DIR    - the install dir for wallpapers
 201  KCONF_UPDATE_INSTALL_DIR - the kconf_update install dir
 202  XDG_APPS_INSTALL_DIR     - the XDG apps dir
 203  XDG_DIRECTORY_INSTALL_DIR- the XDG directory
 204  SYSCONF_INSTALL_DIR      - The kde sysconfig install dir
 205  AUTOSTART_INSTALL_DIR    - The install dir for autostart files
 206
 207 CMAKE_SKIP_RPATH: set it to TRUE to disable RPATH completely
 208 KDE4_USE_ALWAYS_FULL_RPATH: set it to TRUE to use the full RPATH everywhere
 209
 210 Use ccmake to see all available settings.
 211
 212 Debugging
 213 ---------
 214 You can use --enable-debug with the configure script, if you want to have
 215 debug code in your KDE apps and libs.
 216 To get another build of KDE, you have to adjust the CMake variable CMAKE_BUILD_TYPE.
 217 The following build types are supported:
 218
 219 "RELWITHDEBINFO" - optimized and debug info
 220 "RELEASE"        - optimized
 221 "DEBUG"          - optimizied, debug info, some optimizations disabled
 222 "DEBUGFULL"      - more debug info, no optimizations
 223 "PROFILE"        - full debug, coverage and profile info
 224
 225 If you experience problems and want to
 226 report problems to the KDE Bugs database, it is recommended to recompile
 227 with this switch enabled to make the backtraces more verbose (and thus
 228 giving the developer more information about the cause of the bug).
 229
 230
 231 Removal/Uninstallation
 232 ----------------------
 233 You can use 'make uninstall' if you want to remove the kde from the dirs.
 234 This feature has not been tested completely, and is depreciated. On a system
 235 where KDEDIRS is specific to KDE (i.e. not /usr) and contains only a single
 236 directory, rm -rf $KDEDIRS does it as well.
 237
 238
 239 More Info
 240 ---------
 241 If your system does not have XPM installed, and you cannot locate a package
 242 of it, you may obtain it from ftp://avahi.inria.fr/pub/xpm, or you may find
 243 it in ftp://ftp.freebsd.org/pub/FreeBSD/distfiles
 244
 245 If you are running a FreeBSD system, you will need to make sure that LIBS is
 246 set to "-Wl,-export-dynamic".  The easiest way to do this is to prefix
 247 configure with it, i.e.: LIBS="-Wl,-export-dynamic" ./configure.  Thanks to
 248 Will Andrews <will@FreeBSD.org> and Arun Sharma <adsharma@sharmas.dhs.org>
 249 for identifying what needed to be done, and how to do it, and such.
 250
 251 If your system supports PAM (Plugable Authentication Modules), please see
 252 the README.pam file in the workspace directory for more information about
 253 using KDE with PAM.
 254
 255 Have a look at the individual subdirectories, if you would like to find out
 256 more about a specific application included in kdebase.
 257
 258 More FAQs on http://www.kde.org/info/faq.html
 259
 260 If you have problems compiling and installing this package, please check the
 261 kde-devel@kde.org mailing list archive (see http://lists.kde.org) to see if
 262 somebody had a similiar problem already. If not, try posting a message to
 263 the list with detailed information about the compile problem.
 264
 265 General KDE discussions should go to the KDE mailing list (kde@kde.org).
 266