mcabber/INSTALL
author Mikael Berthe <mikael@lilotux.net>
Sun, 11 Oct 2009 20:06:47 +0200
changeset 1610 6db9f403f707
parent 1455 bec235cd28a8
child 1620 52b63087f421
permissions -rw-r--r--
Replace 'username' with 'jid' in the configuration file The previous behaviour doesn't make much sense anymore. MCabber does DNS SRV lookups so providing the server name is usually not needed.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
232
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
     1
This file contains the generic instructions; the short version is:
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
     2
$ ./configure
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
     3
$ make
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
     4
... and if you want to install the software:
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
     5
$ make install
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
     6
(If you don't want to install it, the "mcabber" binary lies in
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
     7
the src/ directory after the build procedure)
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
     8
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
     9
MCabber needs ncurses and ncurses development packages to build correctly.
934
a09bf67d1dfb Unicode support depends on having ncursesw
Mikael Berthe <mikael@lilotux.net>
parents: 232
diff changeset
    10
For UTF-8 terminal support, use ncursesw instead.
1090
fff7ee4cefab Update INSTALL file: add a note for FreeBSD users
Mikael Berthe <mikael@lilotux.net>
parents: 1061
diff changeset
    11
Note: On FreeBSD (and maybe other BSD systems as well), it is recommended
fff7ee4cefab Update INSTALL file: add a note for FreeBSD users
Mikael Berthe <mikael@lilotux.net>
parents: 1061
diff changeset
    12
that you install ncurses from ports before compiling mcabber.
fff7ee4cefab Update INSTALL file: add a note for FreeBSD users
Mikael Berthe <mikael@lilotux.net>
parents: 1061
diff changeset
    13
You should also export LDFLAGS='-L/usr/local/lib' before running
fff7ee4cefab Update INSTALL file: add a note for FreeBSD users
Mikael Berthe <mikael@lilotux.net>
parents: 1061
diff changeset
    14
mcabber's configure to ensure that mcabber uses the ncurses installed
fff7ee4cefab Update INSTALL file: add a note for FreeBSD users
Mikael Berthe <mikael@lilotux.net>
parents: 1061
diff changeset
    15
from ports.  This is necessary as the version of ncurses included in
fff7ee4cefab Update INSTALL file: add a note for FreeBSD users
Mikael Berthe <mikael@lilotux.net>
parents: 1061
diff changeset
    16
the base system does not provide unicode support.
fff7ee4cefab Update INSTALL file: add a note for FreeBSD users
Mikael Berthe <mikael@lilotux.net>
parents: 1061
diff changeset
    17
232
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
    18
If you want SSL support, you will need openssl lib & dev packages as well.
1090
fff7ee4cefab Update INSTALL file: add a note for FreeBSD users
Mikael Berthe <mikael@lilotux.net>
parents: 1061
diff changeset
    19
1061
da696ed4acf4 Update README & INSTALL
Mikael Berthe <mikael@lilotux.net>
parents: 934
diff changeset
    20
If you want PGP support, install libgpgme (with dev package),
da696ed4acf4 Update README & INSTALL
Mikael Berthe <mikael@lilotux.net>
parents: 934
diff changeset
    21
version >= 1.0.0.
232
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
    22
1455
bec235cd28a8 Misc. documentation updates
Mikael Berthe <mikael@lilotux.net>
parents: 1090
diff changeset
    23
You may want to have a look at the wiki:
bec235cd28a8 Misc. documentation updates
Mikael Berthe <mikael@lilotux.net>
parents: 1090
diff changeset
    24
 <http://wiki.mcabber.com/>
bec235cd28a8 Misc. documentation updates
Mikael Berthe <mikael@lilotux.net>
parents: 1090
diff changeset
    25
and if you're using the development version (from the repository):
bec235cd28a8 Misc. documentation updates
Mikael Berthe <mikael@lilotux.net>
parents: 1090
diff changeset
    26
 <http://wiki.mcabber.com/index.php/Building_mcabber_from_Mercurial>
bec235cd28a8 Misc. documentation updates
Mikael Berthe <mikael@lilotux.net>
parents: 1090
diff changeset
    27
232
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
    28
Please have a look at the README file before launching mcabber.
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
    29
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
    30
Please send me a message (mcabber AT lilotux DOT net) if you have
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
    31
questions, suggestions or even patches...
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
    32
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
    33
Mikael
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
    34
9a6ba4b38e63 [/trunk] Changeset 245 by mikael
mikael
parents: 57
diff changeset
    35
57
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    36
Installation Instructions
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    37
*************************
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    38
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    39
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    40
Software Foundation, Inc.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    41
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    42
This file is free documentation; the Free Software Foundation gives
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    43
unlimited permission to copy, distribute and modify it.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    44
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    45
Basic Installation
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    46
==================
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    47
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    48
These are generic installation instructions.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    49
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    50
   The `configure' shell script attempts to guess correct values for
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    51
various system-dependent variables used during compilation.  It uses
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    52
those values to create a `Makefile' in each directory of the package.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    53
It may also create one or more `.h' files containing system-dependent
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    54
definitions.  Finally, it creates a shell script `config.status' that
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    55
you can run in the future to recreate the current configuration, and a
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    56
file `config.log' containing compiler output (useful mainly for
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    57
debugging `configure').
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    58
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    59
   It can also use an optional file (typically called `config.cache'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    60
and enabled with `--cache-file=config.cache' or simply `-C') that saves
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    61
the results of its tests to speed up reconfiguring.  (Caching is
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    62
disabled by default to prevent problems with accidental use of stale
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    63
cache files.)
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    64
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    65
   If you need to do unusual things to compile the package, please try
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    66
to figure out how `configure' could check whether to do them, and mail
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    67
diffs or instructions to the address given in the `README' so they can
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    68
be considered for the next release.  If you are using the cache, and at
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    69
some point `config.cache' contains results you don't want to keep, you
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    70
may remove or edit it.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    71
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    72
   The file `configure.ac' (or `configure.in') is used to create
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    73
`configure' by a program called `autoconf'.  You only need
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    74
`configure.ac' if you want to change it or regenerate `configure' using
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    75
a newer version of `autoconf'.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    76
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    77
The simplest way to compile this package is:
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    78
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    79
  1. `cd' to the directory containing the package's source code and type
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    80
     `./configure' to configure the package for your system.  If you're
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    81
     using `csh' on an old version of System V, you might need to type
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    82
     `sh ./configure' instead to prevent `csh' from trying to execute
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    83
     `configure' itself.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    84
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    85
     Running `configure' takes awhile.  While running, it prints some
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    86
     messages telling which features it is checking for.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    87
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    88
  2. Type `make' to compile the package.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    89
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    90
  3. Optionally, type `make check' to run any self-tests that come with
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    91
     the package.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    92
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    93
  4. Type `make install' to install the programs and any data files and
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    94
     documentation.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    95
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    96
  5. You can remove the program binaries and object files from the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    97
     source code directory by typing `make clean'.  To also remove the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    98
     files that `configure' created (so you can compile the package for
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
    99
     a different kind of computer), type `make distclean'.  There is
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   100
     also a `make maintainer-clean' target, but that is intended mainly
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   101
     for the package's developers.  If you use it, you may have to get
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   102
     all sorts of other programs in order to regenerate files that came
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   103
     with the distribution.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   104
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   105
Compilers and Options
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   106
=====================
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   107
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   108
Some systems require unusual options for compilation or linking that the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   109
`configure' script does not know about.  Run `./configure --help' for
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   110
details on some of the pertinent environment variables.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   111
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   112
   You can give `configure' initial values for configuration parameters
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   113
by setting variables in the command line or in the environment.  Here
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   114
is an example:
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   115
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   116
     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   117
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   118
   *Note Defining Variables::, for more details.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   119
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   120
Compiling For Multiple Architectures
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   121
====================================
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   122
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   123
You can compile the package for more than one kind of computer at the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   124
same time, by placing the object files for each architecture in their
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   125
own directory.  To do this, you must use a version of `make' that
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   126
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   127
directory where you want the object files and executables to go and run
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   128
the `configure' script.  `configure' automatically checks for the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   129
source code in the directory that `configure' is in and in `..'.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   130
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   131
   If you have to use a `make' that does not support the `VPATH'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   132
variable, you have to compile the package for one architecture at a
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   133
time in the source code directory.  After you have installed the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   134
package for one architecture, use `make distclean' before reconfiguring
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   135
for another architecture.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   136
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   137
Installation Names
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   138
==================
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   139
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   140
By default, `make install' will install the package's files in
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   141
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   142
installation prefix other than `/usr/local' by giving `configure' the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   143
option `--prefix=PREFIX'.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   144
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   145
   You can specify separate installation prefixes for
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   146
architecture-specific files and architecture-independent files.  If you
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   147
give `configure' the option `--exec-prefix=PREFIX', the package will
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   148
use PREFIX as the prefix for installing programs and libraries.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   149
Documentation and other data files will still use the regular prefix.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   150
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   151
   In addition, if you use an unusual directory layout you can give
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   152
options like `--bindir=DIR' to specify different values for particular
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   153
kinds of files.  Run `configure --help' for a list of the directories
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   154
you can set and what kinds of files go in them.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   155
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   156
   If the package supports it, you can cause programs to be installed
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   157
with an extra prefix or suffix on their names by giving `configure' the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   158
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   159
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   160
Optional Features
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   161
=================
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   162
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   163
Some packages pay attention to `--enable-FEATURE' options to
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   164
`configure', where FEATURE indicates an optional part of the package.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   165
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   166
is something like `gnu-as' or `x' (for the X Window System).  The
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   167
`README' should mention any `--enable-' and `--with-' options that the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   168
package recognizes.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   169
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   170
   For packages that use the X Window System, `configure' can usually
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   171
find the X include and library files automatically, but if it doesn't,
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   172
you can use the `configure' options `--x-includes=DIR' and
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   173
`--x-libraries=DIR' to specify their locations.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   174
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   175
Specifying the System Type
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   176
==========================
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   177
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   178
There may be some features `configure' cannot figure out automatically,
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   179
but needs to determine by the type of machine the package will run on.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   180
Usually, assuming the package is built to be run on the _same_
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   181
architectures, `configure' can figure that out, but if it prints a
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   182
message saying it cannot guess the machine type, give it the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   183
`--build=TYPE' option.  TYPE can either be a short name for the system
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   184
type, such as `sun4', or a canonical name which has the form:
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   185
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   186
     CPU-COMPANY-SYSTEM
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   187
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   188
where SYSTEM can have one of these forms:
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   189
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   190
     OS KERNEL-OS
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   191
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   192
   See the file `config.sub' for the possible values of each field.  If
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   193
`config.sub' isn't included in this package, then this package doesn't
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   194
need to know the machine type.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   195
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   196
   If you are _building_ compiler tools for cross-compiling, you should
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   197
use the `--target=TYPE' option to select the type of system they will
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   198
produce code for.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   199
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   200
   If you want to _use_ a cross compiler, that generates code for a
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   201
platform different from the build platform, you should specify the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   202
"host" platform (i.e., that on which the generated programs will
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   203
eventually be run) with `--host=TYPE'.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   204
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   205
Sharing Defaults
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   206
================
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   207
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   208
If you want to set default values for `configure' scripts to share, you
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   209
can create a site shell script called `config.site' that gives default
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   210
values for variables like `CC', `cache_file', and `prefix'.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   211
`configure' looks for `PREFIX/share/config.site' if it exists, then
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   212
`PREFIX/etc/config.site' if it exists.  Or, you can set the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   213
`CONFIG_SITE' environment variable to the location of the site script.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   214
A warning: not all `configure' scripts look for a site script.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   215
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   216
Defining Variables
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   217
==================
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   218
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   219
Variables not defined in a site shell script can be set in the
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   220
environment passed to `configure'.  However, some packages may run
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   221
configure again during the build, and the customized values of these
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   222
variables may be lost.  In order to avoid this problem, you should set
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   223
them in the `configure' command line, using `VAR=value'.  For example:
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   224
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   225
     ./configure CC=/usr/local2/bin/gcc
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   226
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   227
causes the specified `gcc' to be used as the C compiler (unless it is
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   228
overridden in the site shell script).  Here is a another example:
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   229
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   230
     /bin/bash ./configure CONFIG_SHELL=/bin/bash
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   231
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   232
Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   233
configuration-related scripts to be executed by `/bin/bash'.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   234
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   235
`configure' Invocation
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   236
======================
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   237
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   238
`configure' recognizes the following options to control how it operates.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   239
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   240
`--help'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   241
`-h'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   242
     Print a summary of the options to `configure', and exit.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   243
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   244
`--version'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   245
`-V'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   246
     Print the version of Autoconf used to generate the `configure'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   247
     script, and exit.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   248
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   249
`--cache-file=FILE'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   250
     Enable the cache: use and save the results of the tests in FILE,
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   251
     traditionally `config.cache'.  FILE defaults to `/dev/null' to
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   252
     disable caching.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   253
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   254
`--config-cache'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   255
`-C'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   256
     Alias for `--cache-file=config.cache'.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   257
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   258
`--quiet'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   259
`--silent'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   260
`-q'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   261
     Do not print messages saying which checks are being made.  To
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   262
     suppress all normal output, redirect it to `/dev/null' (any error
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   263
     messages will still be shown).
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   264
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   265
`--srcdir=DIR'
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   266
     Look for the package's source code in directory DIR.  Usually
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   267
     `configure' can determine that directory automatically.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   268
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   269
`configure' also accepts some other, not widely useful, options.  Run
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   270
`configure --help' for more details.
f381236239a4 [/trunk] Changeset 72 by mikael
mikael
parents:
diff changeset
   271