Changeset a56b3a in git for factory/INSTALL
- Timestamp:
- Oct 28, 1997, 6:27:48 PM (27 years ago)
- Branches:
- (u'fieker-DuVal', '117eb8c30fc9e991c4decca4832b1d19036c4c65')(u'spielwiese', 'aefe9ae36ec8df52dbdbefda02828f18f27715b3')
- Children:
- e4126ace46ae0b2e08ae0ce999784ad0aa4591df
- Parents:
- bee961a23de01f8d01feadc945c768843ae13239
- File:
-
- 1 edited
-
factory/INSTALL (modified) (16 diffs)
Legend:
- Unmodified
- Added
- Removed
-
factory/INSTALL
rbee961 ra56b3a 1 1 2 2 3 --- This INSTALL file corresponds to Factory version 1.3a---3 --- This `INSTALL' file corresponds to Factory version 1.3b --- 4 4 5 5 … … 9 9 NOTE: The copyright state of Factory is still unclear. Sooner or later it 10 10 will be free software, but by now please do *not* distribute the sources. 11 11 12 12 13 Overview Installation for the impatient … … 14 15 1. Configuring Factory ./configure 15 16 2. Building Factory make all 16 3. Creating GF(q) tables make gftables17 3. Creating GF(q) Tables make gftables 17 18 4. Installing Factory make install 18 5. Installing GF(q) tables make installgftables 19 5. Installing GF(q) Tables make installgftables 20 6. Testing Installation of Factory make installtest 19 21 20 22 21 23 1. Configuring Factory 22 24 ====================== 23 The configureshell script attempts to guess correct values for various25 The `configure' shell script attempts to guess correct values for various 24 26 system-dependent variables used during compilation. It uses those values 25 to create a GNUmakefile and a config.hfile containing system-dependent26 definitions. Finally, it creates a shell script config.status that you can27 run in the future to recreate the current configuration, a file28 config.cache that saves the results of its tests to speed up reconfiguring, 29 and a file config.log containing compiler output (useful mainly for 30 debugging configure).27 to create a `GNUmakefile' and a `config.h' file containing system-dependent 28 definitions. Finally, it creates a shell script `config.status' that you 29 can run in the future to recreate the current configuration, a file 30 `config.cache' that saves the results of its tests to speed up 31 reconfiguring, and a file `config.log' containing compiler output (useful 32 mainly for debugging `configure'). 31 33 32 34 If you need to do unusual things to compile the package, please try to 33 figure out how configure could check whether to do them, and mail diffs or34 instructions to the address given in the READMEfile so they can be35 considered for the next release. If at some point config.cachecontains35 figure out how `configure' could check whether to do them, and mail diffs 36 or instructions to the address given in the `README' file so they can be 37 considered for the next release. If at some point `config.cache' contains 36 38 results you don't want to keep, you may remove or edit it. 37 39 38 The file configure.in is used to create configure by a program called 39 autoconf. You only need configure.in if you want to change it or 40 regenerate configure using a newer version of autoconf. 41 42 Normally, the configure script's guesses are correct. However, you may 43 want to check the values it came up with. Especially the way configure 44 tries to figure out the path to the GF(q) tables ('GFTABLEDIR') may be 45 fooled in some circumstances. See the marked sections in the files 46 config.h and GNUmakefile which configure created. 40 The file `configure.in' is used to create `configure' by a program called 41 `autoconf'. You only need `configure.in' if you want to change it or 42 regenerate `configure' using a newer version of `autoconf'. 43 44 Normally, `configure's guesses are correct. However, you may want to 45 check the values it came up with. Especially the way `configure' tries to 46 figure out the path to the GF(q) tables (`GFTABLEDIR') may be fooled in 47 some circumstances. See the marked sections in the files `config.h' and 48 `GNUmakefile' which configure created. See also the description of the 49 `GNUmakefile' target `installtest', which, among others, tests the 50 installation of the GF(q) tables. 47 51 48 52 … … 50 54 ---------------- 51 55 Some systems require unusual options for compilation or linking that the 52 configure script does not know about. You can give configureinitial56 `configure' script does not know about. You can give `configure' initial 53 57 values for variables by setting them in the environment. Using a 54 58 Bourne-compatible shell, you can do that on the command line like this: … … 56 60 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure 57 61 58 Or on systems that have the envprogram, you can do it like this:62 Or on systems that have the `env' program, you can do it like this: 59 63 60 64 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure 61 65 62 In contrast to the GNU-world, Factory is translated with 'CFLAGS=-O263 -fomit-frame-pointer' 'CXXFLAGS=-O2 -fomit-frame-pointer' by default. If64 you do not like this, configurewith66 In contrast to the GNU-world, Factory is translated with `CFLAGS=-O2 67 -fomit-frame-pointer' `CXXFLAGS=-O2 -fomit-frame-pointer' by default. If 68 you do not like this, run `configure' with 65 69 66 70 CFLAGS='-g -O' CXXFLAGS='-g -O' ./configure … … 68 72 Specifying source and installation directories 69 73 ---------------------------------------------- 70 configure recognizes the '--srcdir=<srcdir>' option and looks in <srcdir>71 for the source files when building Factory. This is useful if you want to 72 translate Factory with different configurations (see the corresponding 73 section).74 75 By default, 'make install' will install the package's files in76 /usr/local/lib, /usr/local/include, etc. You can specify an installation77 prefix other than /usr/local by giving configure the option 78 --prefix=<path>.74 `configure' recognizes the `--srcdir=<srcdir>' option and looks in 75 <srcdir> for the source files when building Factory. This is useful if you 76 want to translate Factory with different configurations (see the 77 corresponding section). 78 79 By default, `make install' will install the package's files in 80 `/usr/local/lib', `/usr/local/include', etc. You can specify an 81 installation prefix other than `/usr/local' by giving `configure' the 82 option `--prefix=<path>'. 79 83 You can specify separate installation prefixes for architecture-specific 80 84 files and architecture-independent files. If you give configure the option 81 '--exec-prefix=<path>' the package will use <path> as the prefix for85 `--exec-prefix=<path>' the package will use <path> as the prefix for 82 86 installing the libraries. The other data files will still use the regular 83 87 prefix. … … 88 92 The configure script that comes with Factory recognizes a number of 89 93 additional options. Here is a list of them which you can get entering 90 './configure --help':94 `./configure --help': 91 95 92 96 --with-memman(=<memman>) specify Factory memory manager. 93 <memman> is either 'old' (default), 'new', or 'no'.97 <memman> is either `old' (default), `new', or `no'. 94 98 --with-gmp(=<gmp_inc_path>(,<gmp_lib_path>)) 95 99 specify where to find gmp library. … … 97 101 --disable-streamio build Factory without stream IO 98 102 --enable-memdebug=<level> switch on memory management debugging. Meaningful 99 with --with-memman=newonly. <level> may be either100 'no' (default), 'normal', or 'full'.103 with `--with-memman=new' only. <level> may be either 104 `no' (default), `normal', or `full'. 101 105 --enable-assertions build Factory with assertions activated 102 106 --enable-timing build Factory so it will print timing information 103 107 --enable-debugoutput build Factory so it will print debugging information 104 --enable-gmp together with --with-Singularmeans: installation105 in process, be graceful when there is no gmp.h106 107 For more detailed information, see the READMEfile. Note that not all108 possible combinations of the --with's and--enable's are meaningful. The109 dependencies between them are described in the READMEfile, too.108 --enable-gmp together with `--with-Singular' means: installation 109 in process, be graceful when there is no `gmp.h' 110 111 For more detailed information, see the `README' file. Note that not all 112 possible combinations of the `--with's and `--enable's are meaningful. The 113 dependencies between them are described in the `README' file, too. 110 114 111 115 You can compile the package for more than one configuration at the same … … 131 135 ../configure --srcdir=.. --prefix=/usr/local/factory.opt 132 136 make install 133 # Better set a symbolic link from one $(gftabledir) to the other. The y137 # Better set a symbolic link from one $(gftabledir) to the other. The 134 138 # GF(q) tables are the same for all configurations. 135 139 make installgftables … … 140 144 Factory translates on Macintosh with the Metroworks CodeWarrior compiler 141 145 now. If you want to build Factory on this or other non-Unix platforms you 142 either have to configure config.h and GNUmakefile by hand or you have to143 create a suitable config.cache file and run configure on a machine that 144 supports it.146 either have to configure `config.h' and `GNUmakefile' by hand or you have 147 to create a suitable `config.cache' file and run `configure' on a machine 148 that supports it. 145 149 146 150 … … 150 154 Targets/commands for building Factory: 151 155 152 'make all'156 `make all' 153 157 ---------- 154 Builds Factory. According to configuration, 'make all' builds only155 Factory ( 'make cf') or Factory and the Factory memory manager ('make cf;158 Builds Factory. According to configuration, `make all' builds only 159 Factory (`make cf') or Factory and the Factory memory manager (`make cf; 156 160 make mem'). 157 161 158 'make clean', 'make mostlyclean', 'make distclean'162 `make clean', `make mostlyclean', `make distclean' 159 163 -------------------------------------------------- 160 164 Deletes all files from the current directory that have been created by 161 building Factory. In addition, 'make mostlyclean' deletes the GF(q) tables162 if they have been created by 'make gftables'. 'make distclean' is like163 'make mostlyclean', but also deletes all files from the current directory165 building Factory. In addition, `make mostlyclean' deletes the GF(q) tables 166 if they have been created by `make gftables'. `make distclean' is like 167 `make mostlyclean', but also deletes all files from the current directory 164 168 that have been created by configuring. If you have unpacked the source and 165 built the program without creating any other files, 'make distclean' leaves169 built the program without creating any other files, `make distclean' leaves 166 170 only the files that were in the distribution. 167 171 168 'make TAGS'172 `make TAGS' 169 173 ----------- 170 174 Updates a tags table for Factory. 171 175 172 'make depend'176 `make depend' 173 177 ------------- 174 178 Creates dependencies. Once created, they will be automatically updated as 175 179 source files change. Intended to be used by developers. 176 180 177 'make ftmpl_inst.o'181 `make ftmpl_inst.o' 178 182 ------------------- 179 Creates the Factory template instantiation . Necessary when linking183 Creates the Factory template instantiations. Necessary when linking 180 184 Factory with your application. 181 185 182 186 183 3. Creating GF(q) tables187 3. Creating GF(q) Tables 184 188 ======================== 185 189 … … 188 192 189 193 There are two possibilities to get the tables: 190 a) Get them from the net where you got Factory from. Unpack the archive 191 factory-gftables.tgz in the source directory (factory-<version>.tgz). 192 b) Create them using Factory itself. Since this process does not require 193 arithmetics in GF(q) there are not any bootstrapping problems. There 194 are two targets which accomplish this, the second depending from the 195 first: 196 197 'make gengftables' 194 o Get them from the net where you got Factory from. Unpack the archive 195 `factory-gftables.tgz' in the source directory (`factory-<version>.tgz') 196 or in the directory in which you are going to build Factory. 197 o Create them using Factory itself. Since this process does not require 198 arithmetics in GF(q) there are not any bootstrapping problems. There 199 are two targets which accomplish this, the second depending from the 200 first: 201 202 `make gengftables' 198 203 ------------------ 199 Creates the executable gengftablesnecessary to build the tables.200 201 'make gftables'204 Creates the executable `gengftables' necessary to build the tables. 205 206 `make gftables' 202 207 --------------- 203 Creates a directory gftables/ and executes gengftables. This is a208 Creates a directory `gftables/' and executes `gengftables'. This is a 204 209 rather time consuming process, so you may want to start it in the 205 background or as 'nohup' ('nohup make gftables &').210 background using `nohup' (`nohup make gftables &'). 206 211 207 212 … … 211 216 Targets/commands for installing Factory: 212 217 213 'make install'218 `make install' 214 219 -------------- 215 220 Builds and installs Factory. This target also creates the directories … … 217 222 The files are installed in the following directories: 218 223 219 File Symb.Name (Default) phys .location224 File Symb.Name (Default) physical location 220 225 ------------------------------------------------------------------------ 221 226 libcf.a $(libdir) = /usr/local/lib … … 235 240 236 241 gftables/* $(gftabledir) = /usr/local/share/factory/gftables 237 (Factory GF(q) tables, installed by 'make installgftables')238 239 'make uninstall'242 (Factory GF(q) tables, installed by `make installgftables') 243 244 `make uninstall' 240 245 ---------------- 241 246 Deletes all the installed files that the install target created. Also … … 243 248 244 249 245 5. Installing GF(q) tables250 5. Installing GF(q) Tables 246 251 ========================== 247 'make installgftables' 252 Targets/commands for installing the GF(q) tables. 253 254 `make installgftables' 248 255 ---------------------- 249 Installs the GF(q) tables in $(gftabledir). 250 251 'make unistallgftables' 256 Installs the GF(q) tables in `$(gftabledir)' ( by default this is 257 `/usr/local/share/factory/gftables'). 258 259 `make unistallgftables' 252 260 ----------------------- 253 261 Uninstalls the GF(q) tables and attempts to delete the directories created 254 262 by the installation process. 263 264 265 6. Testing Installation of Factory 266 ================================== 267 `make installtest' 268 ------------------ 269 Builds and runs the small executable `test_install' which tests whether 270 Factory and the GF(q) tables have been configured, built, and installed 271 correctly.
Note: See TracChangeset
for help on using the changeset viewer.
