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