kmag/INSTALL

   1 //$Id$
   2
   3 Simple Install
   4 ==============
   5
   6 Login as root and type ./install-root in the directory to install.
   7 -or-
   8 If you do not have root access on the machine, run ./install-user in
   9 the directory.
  10
  11 If you want to compile the program for KDE3, run ./configure with
  12 options similar to these:
  13
  14 --prefix=/opt/kde3 --enable-mt --with-qt-dir=/usr/lib/qt3
  15
  16 Then run make and make install (as root).
  17
  18 Basic Installation
  19 ==================
  20
  21    These are generic installation instructions.
  22
  23    The `configure' shell script attempts to guess correct values for
  24 various system-dependent variables used during compilation.  It uses
  25 those values to create a `Makefile' in each directory of the package.
  26 It may also create one or more `.h' files containing system-dependent
  27 definitions.  Finally, it creates a shell script `config.status' that
  28 you can run in the future to recreate the current configuration, a file
  29 `config.cache' that saves the results of its tests to speed up
  30 reconfiguring, and a file `config.log' containing compiler output
  31 (useful mainly for debugging `configure').
  32
  33    If you need to do unusual things to compile the package, please try
  34 to figure out how `configure' could check whether to do them, and mail
  35 diffs or instructions to the address given in the `README' so they can
  36 be considered for the next release.  If at some point `config.cache'
  37 contains results you don't want to keep, you may remove or edit it.
  38
  39    The file `configure.in' is used to create `configure' by a program
  40 called `autoconf'.  You only need `configure.in' if you want to change
  41 it or regenerate `configure' using a newer version of `autoconf'.
  42
  43 The simplest way to compile this package is:
  44
  45   1. `cd' to the directory containing the package's source code and type
  46      `./configure' to configure the package for your system.  If you're
  47      using `csh' on an old version of System V, you might need to type
  48      `sh ./configure' instead to prevent `csh' from trying to execute
  49      `configure' itself.
  50
  51      Running `configure' takes a while.  While running, it prints some
  52      messages telling which features it is checking for.
  53
  54   2. Type `make' to compile the package.
  55
  56   3. Type `make install' to install the programs and any data files and
  57      documentation.
  58
  59   4. You can remove the program binaries and object files from the
  60      source code directory by typing `make clean'.
  61
  62 Compilers and Options
  63 =====================
  64
  65    Some systems require unusual options for compilation or linking that
  66 the `configure' script does not know about.  You can give `configure'
  67 initial values for variables by setting them in the environment.  Using
  68 a Bourne-compatible shell, you can do that on the command line like
  69 this:
  70      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
  71
  72 Or on systems that have the `env' program, you can do it like this:
  73      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
  74
  75 Compiling For Multiple Architectures
  76 ====================================
  77
  78    You can compile the package for more than one kind of computer at the
  79 same time, by placing the object files for each architecture in their
  80 own directory.  To do this, you must use a version of `make' that
  81 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
  82 directory where you want the object files and executables to go and run
  83 the `configure' script.  `configure' automatically checks for the
  84 source code in the directory that `configure' is in and in `..'.
  85
  86    If you have to use a `make' that does not supports the `VPATH'
  87 variable, you have to compile the package for one architecture at a time
  88 in the source code directory.  After you have installed the package for
  89 one architecture, use `make distclean' before reconfiguring for another
  90 architecture.
  91
  92 Installation Names
  93 ==================
  94
  95    By default, `make install' will install the package's files in
  96 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
  97 installation prefix other than `/usr/local' by giving `configure' the
  98 option `--prefix=PATH'.
  99
 100    You can specify separate installation prefixes for
 101 architecture-specific files and architecture-independent files.  If you
 102 give `configure' the option `--exec-prefix=PATH', the package will use
 103 PATH as the prefix for installing programs and libraries.
 104 Documentation and other data files will still use the regular prefix.
 105
 106    If the package supports it, you can cause programs to be installed
 107 with an extra prefix or suffix on their names by giving `configure' the
 108 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 109
 110 Optional Features
 111 =================
 112
 113    Some packages pay attention to `--enable-FEATURE' options to
 114 `configure', where FEATURE indicates an optional part of the package.
 115 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 116 is something like `gnu-as' or `x' (for the X Window System).  The
 117 `README' should mention any `--enable-' and `--with-' options that the
 118 package recognizes.
 119
 120    For packages that use the X Window System, `configure' can usually
 121 find the X include and library files automatically, but if it doesn't,
 122 you can use the `configure' options `--x-includes=DIR' and
 123 `--x-libraries=DIR' to specify their locations.
 124
 125 Specifying the System Type
 126 ==========================
 127
 128    There may be some features `configure' can not figure out
 129 automatically, but needs to determine by the type of host the package
 130 will run on.  Usually `configure' can figure that out, but if it prints
 131 a message saying it can not guess the host type, give it the
 132 `--host=TYPE' option.  TYPE can either be a short name for the system
 133 type, such as `sun4', or a canonical name with three fields:
 134      CPU-COMPANY-SYSTEM
 135
 136 See the file `config.sub' for the possible values of each field.  If
 137 `config.sub' isn't included in this package, then this package doesn't
 138 need to know the host type.
 139
 140    If you are building compiler tools for cross-compiling, you can also
 141 use the `--target=TYPE' option to select the type of system they will
 142 produce code for and the `--build=TYPE' option to select the type of
 143 system on which you are compiling the package.
 144
 145 Sharing Defaults
 146 ================
 147
 148    If you want to set default values for `configure' scripts to share,
 149 you can create a site shell script called `config.site' that gives
 150 default values for variables like `CC', `cache_file', and `prefix'.
 151 `configure' looks for `PREFIX/share/config.site' if it exists, then
 152 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 153 `CONFIG_SITE' environment variable to the location of the site script.
 154 A warning: not all `configure' scripts look for a site script.
 155
 156 Operation Controls
 157 ==================
 158
 159    `configure' recognizes the following options to control how it
 160 operates.
 161
 162 `--cache-file=FILE'
 163      Use and save the results of the tests in FILE instead of
 164      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 165      debugging `configure'.
 166
 167 `--help'
 168      Print a summary of the options to `configure', and exit.
 169
 170 `--quiet'
 171 `--silent'
 172 `-q'
 173      Do not print messages saying which checks are being made.
 174
 175 `--srcdir=DIR'
 176      Look for the package's source code in directory DIR.  Usually
 177      `configure' can determine that directory automatically.
 178
 179 `--version'
 180      Print the version of Autoconf used to generate the `configure'
 181      script, and exit.
 182
 183 `configure' also accepts some other, not widely useful, options.
 184