source: tags/release-0.3/INSTALL @ 1070

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

Added information to people downloading the source from the repository.

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