1
2
3	Installation instructions for the prng library.
4
5			Version 3.0
6
7
8While the code is plain ANSI C and thus quite portable, the following
9adaptions might be neccessary for compile this library.
10
11All configurations are done in the file prng.h. Each option is
12extensively commented there. Here is a quick rundown on what to
13expect there:
14
15 o  Definition of the basic numeric data-type "prng_num". It is not
16    recommended to change this. For 32 and 64 bit computers all
17    neccessary auxiliary definitions will be made automatically.
18    For othe architectures, please edit prng.h according to the comments.
19
20 o  Various constants. See comments on the exact meanings.
21
22 o  Definition of prng_inverse. In previous versions, there was no
23    algorithm which was fastest on all architectures, thus is was
24    necessary configure the library for the each platform.
25    Now prng_inverse_own(), which combines the speedups of all
26    old algorithms is the fastest one on all tested architectures
27    and thus *no* configuration is necessary any more.
28
29The code is optimized for GNU CC (gcc). If your compiler supports the type
30(long long int), too, you can use this feature by defining HAVE_LONGLONG
31in prng.h.
32
33Then do:
34
35	./configure --prefix=<prefix_path>
36	make
37
38This should compile the library (libprng.h) and example programs.
39
40To install the library (see GNU generic installation instructions below)
41type:
42
43	make install
44
45which installs <prefix_path>/lib/libprng.a,
46<prefix_path>/include/prng.h, and <prefix_path>/info/prng.info.
47It is possible to remove these files by
48
49	make uninstall
50
51I could not test this code in many environments, thus it might be
52necessary to tweak the code to compile it. Please mail me any changes
53you made, so that I can include them in the next official release.
54
55
56PROFILING AND VERIFICATION
57
58Do
59	make check
60
61to make and run the following executables:
62
63	* iter
64		This program counts the number of iterations in the
65		euclid_table algorithm. It's NOT kept up to date.
66		Use at own risk.
67
68	* validate
69		Using the supplied file tests.dat, this program tests
70		the generator library for correct operation. On 32-bit
71		computers it will fail on generators requiring 64-bit
72		arithmetic.
73
74
75
76(last update: 2000/11/13)
77
78*********************************************************************
79*                                                                   *
80*               GNU generic installation instructions.              *
81*                                                                   *
82*********************************************************************
83
84
85Basic Installation
86==================
87
88   The `configure' shell script attempts to guess correct values for
89various system-dependent variables used during compilation.  It uses
90those values to create a `Makefile' in each directory of the package.
91It may also create one or more `.h' files containing system-dependent
92definitions.  Finally, it creates a shell script `config.status' that
93you can run in the future to recreate the current configuration, a file
94`config.cache' that saves the results of its tests to speed up
95reconfiguring, and a file `config.log' containing compiler output
96(useful mainly for debugging `configure').
97
98   If you need to do unusual things to compile the package, please try
99to figure out how `configure' could check whether to do them, and mail
100diffs or instructions to the address given in the `README' so they can
101be considered for the next release.  If at some point `config.cache'
102contains results you don't want to keep, you may remove or edit it.
103
104   The file `configure.in' is used to create `configure' by a program
105called `autoconf'.  You only need `configure.in' if you want to change
106it or regenerate `configure' using a newer version of `autoconf'.
107
108The simplest way to compile this package is:
109
110  1. `cd' to the directory containing the package's source code and type
111     `./configure' to configure the package for your system.  If you're
112     using `csh' on an old version of System V, you might need to type
113     `sh ./configure' instead to prevent `csh' from trying to execute
114     `configure' itself.
115
116     Running `configure' takes awhile.  While running, it prints some
117     messages telling which features it is checking for.
118
119  2. Type `make' to compile the package.
120
121  3. Optionally, type `make check' to run any self-tests that come with
122     the package.
123
124  4. Type `make install' to install the programs and any data files and
125     documentation.
126
127  5. You can remove the program binaries and object files from the
128     source code directory by typing `make clean'.  To also remove the
129     files that `configure' created (so you can compile the package for
130     a different kind of computer), type `make distclean'.  There is
131     also a `make maintainer-clean' target, but that is intended mainly
132     for the package's developers.  If you use it, you may have to get
133     all sorts of other programs in order to regenerate files that came
134     with the distribution.
135
136Compilers and Options
137=====================
138
139   Some systems require unusual options for compilation or linking that
140the `configure' script does not know about.  You can give `configure'
141initial values for variables by setting them in the environment.  Using
142a Bourne-compatible shell, you can do that on the command line like
143this:
144     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
145
146Or on systems that have the `env' program, you can do it like this:
147     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
148
149Compiling For Multiple Architectures
150====================================
151
152   You can compile the package for more than one kind of computer at the
153same time, by placing the object files for each architecture in their
154own directory.  To do this, you must use a version of `make' that
155supports the `VPATH' variable, such as GNU `make'.  `cd' to the
156directory where you want the object files and executables to go and run
157the `configure' script.  `configure' automatically checks for the
158source code in the directory that `configure' is in and in `..'.
159
160   If you have to use a `make' that does not supports the `VPATH'
161variable, you have to compile the package for one architecture at a time
162in the source code directory.  After you have installed the package for
163one architecture, use `make distclean' before reconfiguring for another
164architecture.
165
166Installation Names
167==================
168
169   By default, `make install' will install the package's files in
170`/usr/local/bin', `/usr/local/man', etc.  You can specify an
171installation prefix other than `/usr/local' by giving `configure' the
172option `--prefix=PATH'.
173
174   You can specify separate installation prefixes for
175architecture-specific files and architecture-independent files.  If you
176give `configure' the option `--exec-prefix=PATH', the package will use
177PATH as the prefix for installing programs and libraries.
178Documentation and other data files will still use the regular prefix.
179
180   In addition, if you use an unusual directory layout you can give
181options like `--bindir=PATH' to specify different values for particular
182kinds of files.  Run `configure --help' for a list of the directories
183you can set and what kinds of files go in them.
184
185   If the package supports it, you can cause programs to be installed
186with an extra prefix or suffix on their names by giving `configure' the
187option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
188
189Optional Features
190=================
191
192   Some packages pay attention to `--enable-FEATURE' options to
193`configure', where FEATURE indicates an optional part of the package.
194They may also pay attention to `--with-PACKAGE' options, where PACKAGE
195is something like `gnu-as' or `x' (for the X Window System).  The
196`README' should mention any `--enable-' and `--with-' options that the
197package recognizes.
198
199   For packages that use the X Window System, `configure' can usually
200find the X include and library files automatically, but if it doesn't,
201you can use the `configure' options `--x-includes=DIR' and
202`--x-libraries=DIR' to specify their locations.
203
204Specifying the System Type
205==========================
206
207   There may be some features `configure' can not figure out
208automatically, but needs to determine by the type of host the package
209will run on.  Usually `configure' can figure that out, but if it prints
210a message saying it can not guess the host type, give it the
211`--host=TYPE' option.  TYPE can either be a short name for the system
212type, such as `sun4', or a canonical name with three fields:
213     CPU-COMPANY-SYSTEM
214
215See the file `config.sub' for the possible values of each field.  If
216`config.sub' isn't included in this package, then this package doesn't
217need to know the host type.
218
219   If you are building compiler tools for cross-compiling, you can also
220use the `--target=TYPE' option to select the type of system they will
221produce code for and the `--build=TYPE' option to select the type of
222system on which you are compiling the package.
223
224Sharing Defaults
225================
226
227   If you want to set default values for `configure' scripts to share,
228you can create a site shell script called `config.site' that gives
229default values for variables like `CC', `cache_file', and `prefix'.
230`configure' looks for `PREFIX/share/config.site' if it exists, then
231`PREFIX/etc/config.site' if it exists.  Or, you can set the
232`CONFIG_SITE' environment variable to the location of the site script.
233A warning: not all `configure' scripts look for a site script.
234
235Operation Controls
236==================
237
238   `configure' recognizes the following options to control how it
239operates.
240
241`--cache-file=FILE'
242     Use and save the results of the tests in FILE instead of
243     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
244     debugging `configure'.
245
246`--help'
247     Print a summary of the options to `configure', and exit.
248
249`--quiet'
250`--silent'
251`-q'
252     Do not print messages saying which checks are being made.  To
253     suppress all normal output, redirect it to `/dev/null' (any error
254     messages will still be shown).
255
256`--srcdir=DIR'
257     Look for the package's source code in directory DIR.  Usually
258     `configure' can determine that directory automatically.
259
260`--version'
261     Print the version of Autoconf used to generate the `configure'
262     script, and exit.
263
264`configure' also accepts some other, not widely useful, options.
265
266