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