kopete/INSTALL

   1 Basic Installation
   2 ==================
   3
   4    These are generic installation instructions.
   5
   6    If you know how to build GNU autotools based packages using the
   7 common 'configure/make/make install' scheme, please read on below in
   8 the 'Finding Plugins' chapter.
   9
  10    The `configure' shell script attempts to guess correct values for
  11 various system-dependent variables used during compilation.  It uses
  12 those values to create a `Makefile' in each directory of the package.
  13 It may also create one or more `.h' files containing system-dependent
  14 definitions.  Finally, it creates a shell script `config.status' that
  15 you can run in the future to recreate the current configuration, a file
  16 `config.cache' that saves the results of its tests to speed up
  17 reconfiguring, and a file `config.log' containing compiler output
  18 (useful mainly for debugging `configure').
  19
  20    If you need to do unusual things to compile the package, please try
  21 to figure out how `configure' could check whether to do them, and mail
  22 diffs or instructions to the address given in the `README' so they can
  23 be considered for the next release.  If at some point `config.cache'
  24 contains results you don't want to keep, you may remove or edit it.
  25
  26    The file `configure.in' is used to create `configure' by a program
  27 called `autoconf'.  You only need `configure.in' if you want to change
  28 it or regenerate `configure' using a newer version of `autoconf'.
  29
  30 The simplest way to compile this package is:
  31
  32   1. `cd' to the directory containing the package's source code and type
  33      `./configure' to configure the package for your system.  If you're
  34      using `csh' on an old version of System V, you might need to type
  35      `sh ./configure' instead to prevent `csh' from trying to execute
  36      `configure' itself.
  37
  38      Running `configure' takes awhile.  While running, it prints some
  39      messages telling which features it is checking for.
  40
  41   2. Type `make' to compile the package.
  42
  43   3. Optionally, type `make check' to run any self-tests that come with
  44      the package.
  45
  46   4. Type `make install' to install the programs and any data files and
  47      documentation.
  48
  49   5. You can remove the program binaries and object files from the
  50      source code directory by typing `make clean'.  To also remove the
  51      files that `configure' created (so you can compile the package for
  52      a different kind of computer), type `make distclean'.  There is
  53      also a `make maintainer-clean' target, but that is intended mainly
  54      for the package's developers.  If you use it, you may have to get
  55      all sorts of other programs in order to regenerate files that came
  56      with the distribution.
  57
  58 Compilers and Options
  59 =====================
  60
  61    Some systems require unusual options for compilation or linking that
  62 the `configure' script does not know about.  You can give `configure'
  63 initial values for variables by setting them in the environment.  Using
  64 a Bourne-compatible shell, you can do that on the command line like
  65 this:
  66      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
  67
  68 Or on systems that have the `env' program, you can do it like this:
  69      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
  70
  71 Compiling For Multiple Architectures
  72 ====================================
  73
  74    You can compile the package for more than one kind of computer at the
  75 same time, by placing the object files for each architecture in their
  76 own directory.  To do this, you must use a version of `make' that
  77 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
  78 directory where you want the object files and executables to go and run
  79 the `configure' script.  `configure' automatically checks for the
  80 source code in the directory that `configure' is in and in `..'.
  81
  82    If you have to use a `make' that does not supports the `VPATH'
  83 variable, you have to compile the package for one architecture at a time
  84 in the source code directory.  After you have installed the package for
  85 one architecture, use `make distclean' before reconfiguring for another
  86 architecture.
  87
  88 Installation Names
  89 ==================
  90
  91    By default, `make install' will install the package's files in
  92 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
  93 installation prefix other than `/usr/local' by giving `configure' the
  94 option `--prefix=PATH'.
  95
  96    You can specify separate installation prefixes for
  97 architecture-specific files and architecture-independent files.  If you
  98 give `configure' the option `--exec-prefix=PATH', the package will use
  99 PATH as the prefix for installing programs and libraries.
 100 Documentation and other data files will still use the regular prefix.
 101
 102    In addition, if you use an unusual directory layout you can give
 103 options like `--bindir=PATH' to specify different values for particular
 104 kinds of files.  Run `configure --help' for a list of the directories
 105 you can set and what kinds of files go in them.
 106
 107    If the package supports it, you can cause programs to be installed
 108 with an extra prefix or suffix on their names by giving `configure' the
 109 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 110
 111 Optional Features
 112 =================
 113
 114    Some packages pay attention to `--enable-FEATURE' options to
 115 `configure', where FEATURE indicates an optional part of the package.
 116 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 117 is something like `gnu-as' or `x' (for the X Window System).  The
 118 `README' should mention any `--enable-' and `--with-' options that the
 119 package recognizes.
 120
 121    For packages that use the X Window System, `configure' can usually
 122 find the X include and library files automatically, but if it doesn't,
 123 you can use the `configure' options `--x-includes=DIR' and
 124 `--x-libraries=DIR' to specify their locations.
 125
 126 Specifying the System Type
 127 ==========================
 128
 129    There may be some features `configure' can not figure out
 130 automatically, but needs to determine by the type of host the package
 131 will run on.  Usually `configure' can figure that out, but if it prints
 132 a message saying it can not guess the host type, give it the
 133 `--host=TYPE' option.  TYPE can either be a short name for the system
 134 type, such as `sun4', or a canonical name with three fields:
 135      CPU-COMPANY-SYSTEM
 136
 137 See the file `config.sub' for the possible values of each field.  If
 138 `config.sub' isn't included in this package, then this package doesn't
 139 need to know the host type.
 140
 141    If you are building compiler tools for cross-compiling, you can also
 142 use the `--target=TYPE' option to select the type of system they will
 143 produce code for and the `--build=TYPE' option to select the type of
 144 system on which you are compiling the package.
 145
 146 Sharing Defaults
 147 ================
 148
 149    If you want to set default values for `configure' scripts to share,
 150 you can create a site shell script called `config.site' that gives
 151 default values for variables like `CC', `cache_file', and `prefix'.
 152 `configure' looks for `PREFIX/share/config.site' if it exists, then
 153 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 154 `CONFIG_SITE' environment variable to the location of the site script.
 155 A warning: not all `configure' scripts look for a site script.
 156
 157 Operation Controls
 158 ==================
 159
 160    `configure' recognizes the following options to control how it
 161 operates.
 162
 163 `--cache-file=FILE'
 164      Use and save the results of the tests in FILE instead of
 165      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 166      debugging `configure'.
 167
 168 `--help'
 169      Print a summary of the options to `configure', and exit.
 170
 171 `--quiet'
 172 `--silent'
 173 `-q'
 174      Do not print messages saying which checks are being made.
 175
 176 `--srcdir=DIR'
 177      Look for the package's source code in directory DIR.  Usually
 178      `configure' can determine that directory automatically.
 179
 180 `--version'
 181      Print the version of Autoconf used to generate the `configure'
 182      script, and exit.
 183
 184 `configure' also accepts some other, not widely useful, options.
 185
 186 Finding Plugins
 187 ===============
 188 If you don't see any "plugins" listed in the Configure Plugins...
 189 dialog, or the list of messaging protocols in the Add Account Wizard
 190 is empty after installing, Kopete you may have installed it in a
 191 directory where KDE doesn't look for additional resources like plugins.
 192
 193 It's also possible that you've just been too impatient :)
 194
 195 Kopete installs several .desktop files that have to be processed by a
 196 KDE application called 'kbuildsycoca'. If you run Kopete directly
 197 after installing it this process might still be running and Kopete
 198 doesn't see the new plugins yet. Try running 'kbuildsycoca' from a
 199 console and restart Kopete when it finishes. If that doesn't help,
 200 please read on.
 201
 202 KDE applications by default look in all directories listed in the
 203 /etc/kderc file, the $KDEDIRS environment variable, in $KDEDIR if
 204 this variable doesn't exist, and ultimately in the directory where
 205 kdelibs is installed. Unless you take special precautions applications
 206 will _NOT_ look in other directories, even if you install additional
 207 software (like Kopete) there.
 208
 209 The best solution is to add the following to /etc/kderc (create the file
 210 if it doesn't exist yet):
 211
 212     [Directories]
 213     prefixes=/the/prefix/I/used/for/kopete
 214
 215 If you don't have write access to /etc/kderc, or if you want to use more
 216 parallel builds of KDE and/or Kopete you need to rely on the environment
 217 variables instead.
 218
 219 If $KDEDIRS currently points to /opt/kde3 and you installed Kopete
 220 to /usr/local then you need to set $KDEDIRS to '/opt/kde3:/usr/local'.
 221 You need to store this change in a file that is picked up by all shells
 222 and for all users, like /etc/profile. The name of the preferred version
 223 varies from system to system.
 224
 225 As a last resort you can simply install Kopete in the same directory as
 226 where your KDE resides by adding a flag to configure like
 227
 228     ./configure --prefix=/opt/kde3
 229
 230 if KDE is installed in /opt/kde3. The downside is that you'll probably
 231 end up installing Kopete into directories used by your distribution,
 232 instead of a separate path for your own packages like the /usr/local/
 233 tree. Whether or not your package manager has problems with that and
 234 whether or not you'll accept those problems should they occur is of
 235 course up to you to decide, but we strongly recommend to not install
 236 source-compiled packages like Kopete in directories that are managed
 237 by a package manager and only use the KDE prefix if you compiled all
 238 of KDE from source yourself.
 239