source: trunk/INSTALL @ 166

Last change on this file since 166 was 160, checked in by Jari Häkkinen, 15 years ago

Fixes #55. Added --enable-debug option to configure. This will turn on
debug stuff (off by default, developers note this).

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 10.8 KB
Line 
1$Id: INSTALL 160 2006-08-19 21:19:06Z jari $
2
3======================================================================
4Copyright (C) 2006 Jari Häkkinen
5
6Files are copyright by their respective authors. The contributions to
7files where copyright is not explicitly stated can be traced with the
8source code revision system.
9
10This file is part of svndigest, http://lev.thep.lu.se/trac/svndigest
11
12svndigest is free software; you can redistribute it and/or modify it
13under the terms of the GNU General Public License as published by the
14Free Software Foundation; either version 2 of the License, or (at your
15option) any later version.
16
17svndigest is distributed in the hope that it will be useful, but
18WITHOUT ANY WARRANTY; without even the implied warranty of
19MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20General Public License for more details.
21
22You should have received a copy of the GNU General Public License
23along with this program; if not, write to the Free Software
24Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
25USA.
26======================================================================
27
28
29
30Below you'll find the generic FSF install instructions. To compile
31and install svndigest you can follow the usual autoconf path:
32
33# ./configure
34# make
35# make install
36
37With an optional
38
39# make check
40
41The './configure' script accepts a few options of interest for
42svndigest. You can provide './configure' with APR and subversion API
43location information with --with-apr=DIR and --with-svn=DIR,
44respectively. --enable-debug turns on debug options and code, which
45may be useful for developers.
46
47If you grabbed the source from the subversion repository you need to
48run './bootstrap' to setup autoconf files.
49
50
51FSF generic install documentation:
52
53Installation Instructions
54*************************
55
56Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004 Free
57Software Foundation, Inc.
58
59This file is free documentation; the Free Software Foundation gives
60unlimited permission to copy, distribute and modify it.
61
62Basic Installation
63==================
64
65These are generic installation instructions.
66
67   The `configure' shell script attempts to guess correct values for
68various system-dependent variables used during compilation.  It uses
69those values to create a `Makefile' in each directory of the package.
70It may also create one or more `.h' files containing system-dependent
71definitions.  Finally, it creates a shell script `config.status' that
72you can run in the future to recreate the current configuration, and a
73file `config.log' containing compiler output (useful mainly for
74debugging `configure').
75
76   It can also use an optional file (typically called `config.cache'
77and enabled with `--cache-file=config.cache' or simply `-C') that saves
78the results of its tests to speed up reconfiguring.  (Caching is
79disabled by default to prevent problems with accidental use of stale
80cache files.)
81
82   If you need to do unusual things to compile the package, please try
83to figure out how `configure' could check whether to do them, and mail
84diffs or instructions to the address given in the `README' so they can
85be considered for the next release.  If you are using the cache, and at
86some point `config.cache' contains results you don't want to keep, you
87may remove or edit it.
88
89   The file `configure.ac' (or `configure.in') is used to create
90`configure' by a program called `autoconf'.  You only need
91`configure.ac' if you want to change it or regenerate `configure' using
92a newer version of `autoconf'.
93
94The simplest way to compile this package is:
95
96  1. `cd' to the directory containing the package's source code and type
97     `./configure' to configure the package for your system.  If you're
98     using `csh' on an old version of System V, you might need to type
99     `sh ./configure' instead to prevent `csh' from trying to execute
100     `configure' itself.
101
102     Running `configure' takes awhile.  While running, it prints some
103     messages telling which features it is checking for.
104
105  2. Type `make' to compile the package.
106
107  3. Optionally, type `make check' to run any self-tests that come with
108     the package.
109
110  4. Type `make install' to install the programs and any data files and
111     documentation.
112
113  5. You can remove the program binaries and object files from the
114     source code directory by typing `make clean'.  To also remove the
115     files that `configure' created (so you can compile the package for
116     a different kind of computer), type `make distclean'.  There is
117     also a `make maintainer-clean' target, but that is intended mainly
118     for the package's developers.  If you use it, you may have to get
119     all sorts of other programs in order to regenerate files that came
120     with the distribution.
121
122Compilers and Options
123=====================
124
125Some systems require unusual options for compilation or linking that the
126`configure' script does not know about.  Run `./configure --help' for
127details on some of the pertinent environment variables.
128
129   You can give `configure' initial values for configuration parameters
130by setting variables in the command line or in the environment.  Here
131is an example:
132
133     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
134
135   *Note Defining Variables::, for more details.
136
137Compiling For Multiple Architectures
138====================================
139
140You can compile the package for more than one kind of computer at the
141same time, by placing the object files for each architecture in their
142own directory.  To do this, you must use a version of `make' that
143supports the `VPATH' variable, such as GNU `make'.  `cd' to the
144directory where you want the object files and executables to go and run
145the `configure' script.  `configure' automatically checks for the
146source code in the directory that `configure' is in and in `..'.
147
148   If you have to use a `make' that does not support the `VPATH'
149variable, you have to compile the package for one architecture at a
150time in the source code directory.  After you have installed the
151package for one architecture, use `make distclean' before reconfiguring
152for another architecture.
153
154Installation Names
155==================
156
157By default, `make install' will install the package's files in
158`/usr/local/bin', `/usr/local/man', etc.  You can specify an
159installation prefix other than `/usr/local' by giving `configure' the
160option `--prefix=PREFIX'.
161
162   You can specify separate installation prefixes for
163architecture-specific files and architecture-independent files.  If you
164give `configure' the option `--exec-prefix=PREFIX', the package will
165use PREFIX as the prefix for installing programs and libraries.
166Documentation and other data files will still use the regular prefix.
167
168   In addition, if you use an unusual directory layout you can give
169options like `--bindir=DIR' to specify different values for particular
170kinds of files.  Run `configure --help' for a list of the directories
171you can set and what kinds of files go in them.
172
173   If the package supports it, you can cause programs to be installed
174with an extra prefix or suffix on their names by giving `configure' the
175option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
176
177Optional Features
178=================
179
180Some packages pay attention to `--enable-FEATURE' options to
181`configure', where FEATURE indicates an optional part of the package.
182They may also pay attention to `--with-PACKAGE' options, where PACKAGE
183is something like `gnu-as' or `x' (for the X Window System).  The
184`README' should mention any `--enable-' and `--with-' options that the
185package recognizes.
186
187   For packages that use the X Window System, `configure' can usually
188find the X include and library files automatically, but if it doesn't,
189you can use the `configure' options `--x-includes=DIR' and
190`--x-libraries=DIR' to specify their locations.
191
192Specifying the System Type
193==========================
194
195There may be some features `configure' cannot figure out automatically,
196but needs to determine by the type of machine the package will run on.
197Usually, assuming the package is built to be run on the _same_
198architectures, `configure' can figure that out, but if it prints a
199message saying it cannot guess the machine type, give it the
200`--build=TYPE' option.  TYPE can either be a short name for the system
201type, such as `sun4', or a canonical name which has the form:
202
203     CPU-COMPANY-SYSTEM
204
205where SYSTEM can have one of these forms:
206
207     OS KERNEL-OS
208
209   See the file `config.sub' for the possible values of each field.  If
210`config.sub' isn't included in this package, then this package doesn't
211need to know the machine type.
212
213   If you are _building_ compiler tools for cross-compiling, you should
214use the `--target=TYPE' option to select the type of system they will
215produce code for.
216
217   If you want to _use_ a cross compiler, that generates code for a
218platform different from the build platform, you should specify the
219"host" platform (i.e., that on which the generated programs will
220eventually be run) with `--host=TYPE'.
221
222Sharing Defaults
223================
224
225If you want to set default values for `configure' scripts to share, you
226can create a site shell script called `config.site' that gives default
227values for variables like `CC', `cache_file', and `prefix'.
228`configure' looks for `PREFIX/share/config.site' if it exists, then
229`PREFIX/etc/config.site' if it exists.  Or, you can set the
230`CONFIG_SITE' environment variable to the location of the site script.
231A warning: not all `configure' scripts look for a site script.
232
233Defining Variables
234==================
235
236Variables not defined in a site shell script can be set in the
237environment passed to `configure'.  However, some packages may run
238configure again during the build, and the customized values of these
239variables may be lost.  In order to avoid this problem, you should set
240them in the `configure' command line, using `VAR=value'.  For example:
241
242     ./configure CC=/usr/local2/bin/gcc
243
244will cause the specified gcc to be used as the C compiler (unless it is
245overridden in the site shell script).
246
247`configure' Invocation
248======================
249
250`configure' recognizes the following options to control how it operates.
251
252`--help'
253`-h'
254     Print a summary of the options to `configure', and exit.
255
256`--version'
257`-V'
258     Print the version of Autoconf used to generate the `configure'
259     script, and exit.
260
261`--cache-file=FILE'
262     Enable the cache: use and save the results of the tests in FILE,
263     traditionally `config.cache'.  FILE defaults to `/dev/null' to
264     disable caching.
265
266`--config-cache'
267`-C'
268     Alias for `--cache-file=config.cache'.
269
270`--quiet'
271`--silent'
272`-q'
273     Do not print messages saying which checks are being made.  To
274     suppress all normal output, redirect it to `/dev/null' (any error
275     messages will still be shown).
276
277`--srcdir=DIR'
278     Look for the package's source code in directory DIR.  Usually
279     `configure' can determine that directory automatically.
280
281`configure' also accepts some other, not widely useful, options.  Run
282`configure --help' for more details.
283
Note: See TracBrowser for help on using the repository browser.