source: trunk/INSTALL @ 321

Last change on this file since 321 was 281, checked in by Peter Johansson, 14 years ago

reorganized some of the build info. refs #111

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