source: trunk/INSTALL @ 219

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

Addresses #85. Problem resolved for dist packages but developers cannot run all tests.

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