source: trunk/INSTALL @ 251

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

Fixes #84. Read developer information in README about how to do 'make distcheck'.

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