source: trunk/INSTALL @ 132

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

Cleaning.

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