missed one!
[debian/atlc] / INSTALL
1 Specific Installation Instructions for atlc. 
2 ==================
3
4 *********************************************************************
5 IMPORTANT - if altc won't compile on your system, configure with the 
6 option --without-hardware-info. It should then compile. 
7
8 The versions of 'make' from Sun and SGI probably won't work - use
9 GNU make instead. 
10
11 *********************************************************************
12
13 See also the file docs/html-docs/building.html
14
15    These are *NOT* generic installation instructions, but have been
16    edited CONSIDERABLY to be specific for atlc. There are a couple of 
17    optional arguments that you can give to the configure script that 
18    will improve functionality, so check read this **carefully**
19
20    The `configure' shell script attempts to guess correct values for
21 various system-dependent variables used during compilation.  It uses
22 those values to create a `Makefile' in each directory of the package.
23 Finally, it creates a shell script `config.status' that
24 you can run in the future to recreate the current configuration, a file
25 `config.cache' that saves the results of its tests to speed up
26 reconfiguring, and a file `config.log' containing compiler output
27 (useful mainly for debugging `configure').
28
29    If you need to do unusual things to compile the package, please try
30 to figure out how `configure' could check whether to do them, and mail
31 diffs or instructions to drkirkby@ntlworld.com so they can
32 be considered for the next release.  If at some point `config.cache'
33 contains results you don't want to keep, you may remove or edit it.
34
35    The file `configure.in' is used to create `configure' by a program
36 called `autoconf'.  You only need `configure.in' if you want to change
37 it or regenerate `configure' using a newer version of `autoconf'.
38
39 The simplest way to compile this package is:
40
41   1) Unzip the compressed tar file
42      gzip -d atlc-x.y.tar.gz
43
44   2) Extract the tar archieve
45      tar xvf atlc-x..y.z.tar
46
47   3) Set the varialble CFLAGS to whatever flags are appropiate with
48      your compiler and system. This is particularly important
49      on Alpha platforms, when increases in speed of 3.5x were noticed
50      when running with appropiate flags. 
51
52      A benchmark is provide (see section 8) which can be used
53      as a guide to optimising the compiler flags. 
54
55   4) `cd' to atlc-X.Y.z (whatever X, Y and Z are for the specific
56       vesion) and type
57      `./configure' to configure the package for your system.  If you're
58      using `csh' on an old version of System V, you might need to type
59      `sh ./configure' instead to prevent `csh' from trying to execute
60      `configure' itself.
61
62      Running `configure' takes a while.  While running, it prints some
63      messages telling which features it is checking for.
64
65      If atlc compiles and links okay when you run 'make', but fails to compile
66      or link when running 'make check', re-configure with the option 
67      --disable-hardware-info Let me know of any system that need this 
68      option. 
69
70    5) Type `make' to compile the package.
71
72    6) Type 'make check' to run quite a few checks 
73
74      This will also run a benchmark, which will generate so
75      timing information. This can be used to optimise the flags. 
76
77    7) Type 'make install' if you wish to install the programs and 
78      example files. If you don't want to install the examples
79      (they take up about 120 Mb) run 'make install-exec' and 
80      'make install-man'
81
82    8) You can remove the program binaries and object files from the
83      source code directory by typing `make clean'. To also remove the
84      files that `configure' created (so you can compile the package for
85      a different kind of computer), type `make distclean'.  There is
86      also a `make maintainer-clean' target, but that is intended mainly
87      for the package's developers.  If you use it, you may have to get
88      all sorts of other programs in order to regenerate files that came
89      with the distribution.
90
91 Compilers and Options
92 =====================
93
94    Some systems require unusual options for compilation or linking that
95 the `configure' script does not know about.  You can give `configure'
96 initial values for variables by setting them in the environment.  Using
97 a Bourne-compatible shell, you can do that on the command line like
98 this:
99      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
100
101 Or on systems that have the `env' program, you can do it like this:
102      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
103
104 Compiling For Multiple Architectures
105 ====================================
106
107    You can compile the package for more than one kind of computer at the
108 same time, by placing the object files for each architecture in their
109 own directory.  To do this, you must use a version of `make' that
110 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
111 directory where you want the object files and executables to go and run
112 the `configure' script.  `configure' automatically checks for the
113 source code in the directory that `configure' is in and in `..'.
114
115    If you have to use a `make' that does not supports the `VPATH'
116 variable, you have to compile the package for one architecture at a time
117 in the source code directory.  After you have installed the package for
118 one architecture, use `make distclean' before reconfiguring for another
119 architecture.
120
121 Installation Names
122 ==================
123
124    By default, `make install' will install the package's files in
125 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
126 installation prefix other than `/usr/local' by giving `configure' the
127 option `--prefix=PATH'.
128
129    You can specify separate installation prefixes for
130 architecture-specific files and architecture-independent files.  If you
131 give `configure' the option `--exec-prefix=PATH', the package will use
132 PATH as the prefix for installing programs and libraries.
133 Documentation and other data files will still use the regular prefix.
134
135    In addition, if you use an unusual directory layout you can give
136 options like `--bindir=PATH' to specify different values for particular
137 kinds of files.  Run `configure --help' for a list of the directories
138 you can set and what kinds of files go in them.
139
140    If the package supports it, you can cause programs to be installed
141 with an extra prefix or suffix on their names by giving `configure' the
142 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
143
144 Optional Features
145 =================
146
147 specific options are --with-threads to build a threaded version for
148 multi-processor machines. The option --with-gui will not build 
149 anything useful. I'm new to C++, so there is only a test program or two. 
150
151 Specifying the System Type
152 ==========================
153
154    There may be some features `configure' can not figure out
155 automatically, but needs to determine by the type of host the package
156 will run on.  Usually `configure' can figure that out, but if it prints
157 a message saying it can not guess the host type, give it the
158 `--host=TYPE' option.  TYPE can either be a short name for the system
159 type, such as `sun4', or a canonical name with three fields:
160      CPU-COMPANY-SYSTEM
161
162 See the file `config.sub' for the possible values of each field.  If
163 `config.sub' isn't included in this package, then this package doesn't
164 need to know the host type.
165
166 Sharing Defaults
167 ================
168
169    If you want to set default values for `configure' scripts to share,
170 you can create a site shell script called `config.site' that gives
171 default values for variables like `CC', `cache_file', and `prefix'.
172 `configure' looks for `PREFIX/share/config.site' if it exists, then
173 `PREFIX/etc/config.site' if it exists.  Or, you can set the
174 `CONFIG_SITE' environment variable to the location of the site script.
175 A warning: not all `configure' scripts look for a site script.
176
177 Operation Controls
178 ==================
179
180    `configure' recognizes the following options to control how it
181 operates.
182
183 `--cache-file=FILE'
184      Use and save the results of the tests in FILE instead of
185      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
186      debugging `configure'.
187
188 `--help'
189      Print a summary of the options to `configure', and exit.
190
191 `--quiet'
192 `--silent'
193 `-q'
194      Do not print messages saying which checks are being made.  To
195      suppress all normal output, redirect it to `/dev/null' (any error
196      messages will still be shown).
197
198 `--srcdir=DIR'
199      Look for the package's source code in directory DIR.  Usually
200      `configure' can determine that directory automatically.
201
202 `--version'
203      Print the version of Autoconf used to generate the `configure'
204      script, and exit.
205
206 `configure' also accepts some other, not widely useful, options.