viewcvs/cln/INSTALL.generic

Basic Installation
==================

   These are generic installation instructions.

   The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation.  It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions.  Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output
(useful mainly for debugging `configure').

   If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the documentation so they
can be considered for the next release.  If at some point `config.cache'
contains results you don't want to keep, you may remove or edit it.

   The file `configure.in' is used to create `configure' by a program
called `autoconf'.  You only need `configure.in' if you want to change
it or regenerate `configure' using a newer version of `autoconf'.

The simplest way to compile this package is:

  1. `cd' to the directory containing the package's source code and type
     `./configure' to configure the package for your system.  If you're
     using `csh' on an old version of System V, you might need to type
     `sh ./configure' instead to prevent `csh' from trying to execute
     `configure' itself.

     Running `configure' takes a while.  While running, it prints some
     messages telling which features it is checking for.

  2. Type `make' to compile the package.

  3. Optionally, type `make check' to run any self-tests that come with
     the package.

  4. Type `make install' to install the programs and any data files and
     documentation.

  5. You can remove the program binaries and object files from the
     source code directory by typing `make clean'.  To also remove the
     files that `configure' created (so you can compile the package for
     a different kind of computer), type `make distclean'.  There is
     also a `make maintainer-clean' target, but that is intended mainly
     for the package's developers.  If you use it, you may have to get
     all sorts of other programs in order to regenerate files that came
     with the distribution.

Compilers and Options
=====================

   Some systems require unusual options for compilation or linking that
the `configure' script does not know about.  You can give `configure'
initial values for variables by setting them in the environment.  Using
a Bourne-compatible shell, you can do that on the command line like
this:
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure

Or on systems that have the `env' program, you can do it like this:
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure

Compiling For Multiple Architectures
====================================

   You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory.  To do this, `cd' to the directory where you want the
object files and executables to go and run the `configure' script. 
`configure' automatically checks for the source code in the directory
that `configure' is in and in `..'.

Installation Names
==================

   By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.

   You can specify separate installation prefixes for
architecture-specific files and architecture-independent files.  If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.

   If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.

Specifying the System Type
==========================

   There may be some features `configure' can not figure out
automatically, but needs to determine by the type of host the package
will run on.  Usually `configure' can figure that out, but if it prints
a message saying it can not guess the host type, give it the
`--host=TYPE' option.  TYPE can either be a short name for the system
type, such as `sun4', or a canonical name with three fields:
     CPU-COMPANY-SYSTEM

See the file `config.sub' for the possible values of each field.  If
`config.sub' isn't included in this package, then this package doesn't
need to know the host type.

   If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE' option to select the type of system they will
produce code for and the `--build=TYPE' option to select the type of
system on which you are compiling the package.

Sharing Defaults
================

   If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists.  Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.

Operation Controls
==================

   `configure' recognizes the following options to control how it
operates.

`--cache-file=FILE'
     Use and save the results of the tests in FILE instead of
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
     debugging `configure'.

`--help'
     Print a summary of the options to `configure', and exit.

`--quiet'
`--silent'
`-q'
     Do not print messages saying which checks are being made.  To
     suppress all normal output, redirect it to `/dev/null' (any error
     messages will still be shown).

`--srcdir=DIR'
     Look for the package's source code in directory DIR.  Usually
     `configure' can determine that directory automatically.

`--version'
     Print the version of Autoconf used to generate the `configure'
     script, and exit.

`--with-gmp'
`--without-gmp'
     CLN may be build upon GNU gmp (version 3 or above), recommended for 
     maximum performance.  CLN will not work together with GNU gmp 2.
     The default is to use gmp.  If you encounter problems relating to gmp, 
     try configuring without gmp.

`configure' also accepts some other, not widely useful, options.

1	kreckel	1.1	Basic Installation
2			==================
3
4			These are generic installation instructions.
5
6			The `configure' shell script attempts to guess correct values for
7			various system-dependent variables used during compilation. It uses
8			those values to create a `Makefile' in each directory of the package.
9			It may also create one or more `.h' files containing system-dependent
10			definitions. Finally, it creates a shell script `config.status' that
11			you can run in the future to recreate the current configuration, a file
12			`config.cache' that saves the results of its tests to speed up
13			reconfiguring, and a file `config.log' containing compiler output
14			(useful mainly for debugging `configure').
15
16			If you need to do unusual things to compile the package, please try
17			to figure out how `configure' could check whether to do them, and mail
18			diffs or instructions to the address given in the documentation so they
19			can be considered for the next release. If at some point `config.cache'
20			contains results you don't want to keep, you may remove or edit it.
21
22			The file `configure.in' is used to create `configure' by a program
23			called `autoconf'. You only need `configure.in' if you want to change
24			it or regenerate `configure' using a newer version of `autoconf'.
25
26			The simplest way to compile this package is:
27
28			1. `cd' to the directory containing the package's source code and type
29			`./configure' to configure the package for your system. If you're
30			using `csh' on an old version of System V, you might need to type
31			`sh ./configure' instead to prevent `csh' from trying to execute
32			`configure' itself.
33
34			Running `configure' takes a while. While running, it prints some
35			messages telling which features it is checking for.
36
37			2. Type `make' to compile the package.
38
39			3. Optionally, type `make check' to run any self-tests that come with
40			the package.
41
42			4. Type `make install' to install the programs and any data files and
43			documentation.
44
45			5. You can remove the program binaries and object files from the
46			source code directory by typing `make clean'. To also remove the
47			files that `configure' created (so you can compile the package for
48			a different kind of computer), type `make distclean'. There is
49			also a `make maintainer-clean' target, but that is intended mainly
50			for the package's developers. If you use it, you may have to get
51			all sorts of other programs in order to regenerate files that came
52			with the distribution.
53
54			Compilers and Options
55			=====================
56
57			Some systems require unusual options for compilation or linking that
58			the `configure' script does not know about. You can give `configure'
59			initial values for variables by setting them in the environment. Using
60			a Bourne-compatible shell, you can do that on the command line like
61			this:
62			CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
63
64			Or on systems that have the `env' program, you can do it like this:
65			env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
66
67			Compiling For Multiple Architectures
68			====================================
69
70			You can compile the package for more than one kind of computer at the
71			same time, by placing the object files for each architecture in their
72			own directory. To do this, `cd' to the directory where you want the
73			object files and executables to go and run the `configure' script.
74			`configure' automatically checks for the source code in the directory
75			that `configure' is in and in `..'.
76
77			Installation Names
78			==================
79
80			By default, `make install' will install the package's files in
81			`/usr/local/bin', `/usr/local/man', etc. You can specify an
82			installation prefix other than `/usr/local' by giving `configure' the
83			option `--prefix=PATH'.
84
85			You can specify separate installation prefixes for
86			architecture-specific files and architecture-independent files. If you
87			give `configure' the option `--exec-prefix=PATH', the package will use
88			PATH as the prefix for installing programs and libraries.
89			Documentation and other data files will still use the regular prefix.
90
91			If the package supports it, you can cause programs to be installed
92			with an extra prefix or suffix on their names by giving `configure' the
93			option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
94
95			Specifying the System Type
96			==========================
97
98			There may be some features `configure' can not figure out
99			automatically, but needs to determine by the type of host the package
100			will run on. Usually `configure' can figure that out, but if it prints
101			a message saying it can not guess the host type, give it the
102			`--host=TYPE' option. TYPE can either be a short name for the system
103			type, such as `sun4', or a canonical name with three fields:
104			CPU-COMPANY-SYSTEM
105
106			See the file `config.sub' for the possible values of each field. If
107			`config.sub' isn't included in this package, then this package doesn't
108			need to know the host type.
109
110			If you are building compiler tools for cross-compiling, you can also
111			use the `--target=TYPE' option to select the type of system they will
112			produce code for and the `--build=TYPE' option to select the type of
113			system on which you are compiling the package.
114
115			Sharing Defaults
116			================
117
118			If you want to set default values for `configure' scripts to share,
119			you can create a site shell script called `config.site' that gives
120			default values for variables like `CC', `cache_file', and `prefix'.
121			`configure' looks for `PREFIX/share/config.site' if it exists, then
122			`PREFIX/etc/config.site' if it exists. Or, you can set the
123			`CONFIG_SITE' environment variable to the location of the site script.
124			A warning: not all `configure' scripts look for a site script.
125
126			Operation Controls
127			==================
128
129			`configure' recognizes the following options to control how it
130			operates.
131
132			`--cache-file=FILE'
133			Use and save the results of the tests in FILE instead of
134			`./config.cache'. Set FILE to `/dev/null' to disable caching, for
135			debugging `configure'.
136
137			`--help'
138			Print a summary of the options to `configure', and exit.
139
140			`--quiet'
141			`--silent'
142			`-q'
143			Do not print messages saying which checks are being made. To
144			suppress all normal output, redirect it to `/dev/null' (any error
145			messages will still be shown).
146
147			`--srcdir=DIR'
148			Look for the package's source code in directory DIR. Usually
149			`configure' can determine that directory automatically.
150
151			`--version'
152			Print the version of Autoconf used to generate the `configure'
153			script, and exit.
154
155			`--with-gmp'
156			`--without-gmp'
157	kreckel	1.2	CLN may be build upon GNU gmp (version 3 or above), recommended for
158			maximum performance. CLN will not work together with GNU gmp 2.
159			The default is to use gmp. If you encounter problems relating to gmp,
160			try configuring without gmp.
161	kreckel	1.1
162			`configure' also accepts some other, not widely useful, options.
163
Christian Bauer">Christian Bauer	ViewVC Help
Powered by ViewVC 1.1.15