source: git/Singular/INSTALL @ 98d771

Last change on this file since 98d771 was 98d771, checked in by Olaf Bachmann <obachman@…>, 27 years ago
Fri May 23 13:17:24 1997 Olaf Bachmann < (Olaf Bachmann)> * added option --without-info git-svn-id: file:///usr/local/Singular/svn/trunk@324 2c84dea3-7e68-4137-9b89-c4e89433aadc
  • Property mode set to 100644
File size: 12.1 KB
1                         Singular version 1.0
2                     University of Kaiserslautern
3     Department of Mathematics (or, Centre for Computer Algebra)
4          Authors: G.-M. Greuel, G. Pfister, H. Schoenemann
5                  (C) 1986-1997 All Rights Reserved
8                ======================================
10This file contains instructions on how to install Singular. For
11general information about Singular, see the file 'README' contained in this
12directory. For copying informations, see the file 'COPYING' contained
13in this directory. For comments, problems or bugs, please send mail to If you receive this file as part of a
15complete Singular distribution, see also the README, COPYING, and
16INSTALL files contained in the top directory of the full Singular
19Installation for the Impatient
21Being in the directory which contains this file, type
23  ./configure
24  make
26Basic Installation
30The `configure' shell script in this directory attempts to guess
31correct values for various system-dependent variables used during
32compilation.  It uses those values to create the `Makefile' from the
33file '' and the file 'mod2.h' (which contains
34system-dependent definitions) from the file ''. Finally, it
35creates a shell script `config.status' that you can run in the future
36to recreate the current configuration, a file `config.cache' that
37saves the results of its tests to speed up reconfiguring, and a file
38`config.log' containing compiler output (useful mainly for debugging
41The file `' is used to create `configure' by a program
42called `autoconf'.  You only need `' if you want to change
43it or regenerate `configure' using a newer version of `autoconf'.
45The simplest way to compile Singular is:
47  1. `cd' to the directory containing the Singular's source code and type
48     `./configure' to configure the package for your system.  If you're
49     using `csh' on an old version of System V, you might need to type
50     `sh ./configure' instead to prevent `csh' from trying to execute
51     `configure' itself.
53     Running `configure' takes awhile.  While running, it prints some
54     messages telling which features it is checking for.
56  2. Type `make' to compile Singular.
58  3. Optionally, type `make check' to run the self-tests that come with
59     the Singular (in the subdirectory tests).
61  4. Type `make install' to install the (executable) Singular program,
62     Singular's info files (from the subdirectory docs), and
63     Singular's program libraries written in Singular's
64     architecture-independent and interpreted programming language
65     (from the subdirectory LIB).
67  5. You can remove the program binaries and object files from the
68     source code directory by typing `make clean'.  To also remove the
69     files that `configure' created (so you can compile the package for
70     a different kind of computer), type `make distclean'.  There is
71     also a `make maintainer-clean' target, but that is intended mainly
72     for the package's developers.  If you use it, you may have to get
73     all sorts of other programs in order to regenerate files that came
74     with the distribution.
76  6. Other make targets include:
77     'dist'      : Creates a distribution of all source files of
78                   Singular.
79     'TAGS'      : Creates/updates a tags table for Singular's source
80                   files.
81     'info'      : Regenerates Singular's Info file.
82     'dvi'       : Generates the file docs/Singular.dvi -- a DVI file
83                   of Singular's user manual
84     'uninstall' : Deletes all installed files that the 'install'
85                   target created (i.e. Singular's executable program,
86                   Singular's info file, and Singular's libraries)
87     'check'     : Tests basic Singular functionality
89Compilers and Options
92You need an ANSI-C++ and ANSI-C compiler for compiling Singular. We
93strongly recommend that you use the GNU C/C++ (gcc) compiler. If you
94have gcc installed on your system, configure will automatically find
95and use it for building Singular. Otherwise, configure will try to
96find another ANSI-C and ANSI-C++ compiler. To use explicitly use an
97alternative compiler, or to set some unusual options for compilation
98or linking that the `configure' script does not know about, you can
99give `configure' initial values for variables by setting them in the
100environment.  Using a Bourne-compatible shell, you can do that on the
101command line like this:
102     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
103     CXX=CC CXXFLAGS=+O3 LIBS=-liostream ./configure
105Or on systems that have the `env' program, you can do it like this:
106     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
109Installation Names
112By default, `make install' will install the Singular program in
113`/usr/local/bin', Singular's info files in `/usr/local/info', and
114Singular's program libraries in '/usr/local/share'.  You can
115specify an installation prefix other than `/usr/local' by giving
116`configure' the option `--prefix=PATH'. You can specify an alternative
117directory where the Singular program is installed by giving configure
118the option `--bindir=PATH'. For Singular's info files, use
119'--infodir=PATH' and for Singular's program libraries, use
120'--datadir=PATH'. Make sure that PATH is an _absolute_ (not relative)
124Optional Features
127Singular's configure script pays attention to the following
128`--with-PACKAGE' options where PACKAGE can be:
130  'readline' : Uses the readline library for some fancy display.
131               Requires that libreadline.a and the readline header
132               files are installed on your system. If these files were
133               not found, then Singular is build without readline.
135  'gmp'      : Uses the gmp (Gnu Multiple Precision) library for
136               integer arithmetic. Requires that libgmp.a and gmp.h
137               are installed on your system. If these files were not
138               found, then Singular is build with its internal integer
139               arithmetic which is not as fast as the arithmetic
140               provided by gmp.
142  'dbm'      : Uses the dbm library for DBM links. Requires that
143               libdbm.a or libgdbm.a is installed on your system. If
144               this library is not found, then Singular is built
145               without DBM and DBM links are disabled.
147  'info'     : Uses the 'info' program for displaying the Singular
148               documentation on a 'help' copmmand. This requires that
149               the 'info' programm is installed on your system. If
150               this program is not found, the a built-in display
151               routine is used.
152  'MP'       : Uses the MP library for MP links. Requires that
153               libgmp.a, libMP.a, libMPT.a and gmp.h, MP.h, MPT.h are
154               installed on your system. If these files are not found,
155               then Singular is built without MP, and MP links ar disabled.
157  'factory'  : Uses the Factory library for polynomial
158               factorizations. Requires that libsingcf.a, factory.h
159               and the factory template files are installed on your
160               system. If these files are not found, then Singular is
161               built without factory, and polynomial factorization
162               routines are disabled.
164  'libfac'   : Uses the libfac library for characteristic set
165               computations. Requires libsingfac.a and libfac.h to be
166               installed on your system. If these files are not found,
167               then Singular is built without libfac and
168               characteristic set routines are disabled.
170By default, configure runs as if all the above '--with-PACKAGE'
171options were given and searches through the given includedir and the
172system's default include directories for header files, and through the
173given libdir and through the system's default library directory for
174the library files. If one of the requirements for a PACKAGE is not
175met, configure prints a warning message and builds Singular
176without the respective PACKAGE, disabling its functionality. To
177explicitly built Singular without one of the above PACKAGEs, give
178configure (an) appropriate '--without-PACKAGE' option(s). See the
179README file about instructions on how to obtain the above PACKAGEs.
182System Requirements
185The following requirements have to be met by your system, so that you
186can build Singular:
187  1. The condition (sizeof(int) == 4) has to be true.
188  2. The condition (sizeof(void*) == sizeof(long)) has to be true.
189  3. The condition (-2 >> 1 == -1) has to be true.
190  4. The headers limits.h and unistd.h have to be installed.
191  5. The standard C headers and libraries have to be installed.
194Operation Controls
197   `configure' recognizes the following options to control how it
201     Use and save the results of the tests in FILE instead of
202     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
203     debugging `configure'.
209     Do not print messages saying which checks are being made.
212     Print the version of Autoconf used to generate the `configure'
213     script, and exit.
216     Prints  the following summary of the options to `configure', and exits.
218Usage: configure [options] [host]
219Options: [defaults in brackets after descriptions]
221  --cache-file=FILE       cache test results in FILE
222  --help                  print this message
223  --no-create             do not create output files
224  --quiet, --silent       do not print `checking...' messages
225  --version               print the version of autoconf that created configure
226Directory and file names:
227  --prefix=PREFIX         install architecture-independent files in PREFIX
228                          [`pwd`]
229  --exec-prefix=EPREFIX   install architecture-dependent files in EPREFIX
230                          [same as prefix]
231  --bindir=DIR            user executables in DIR [EPREFIX/bin]
232  --sbindir=DIR           system admin executables in DIR [EPREFIX/sbin]
233  --libexecdir=DIR        program executables in DIR [EPREFIX/libexec]
234  --datadir=DIR           read-only architecture-independent data in DIR
235                          [PREFIX/share]
236  --sysconfdir=DIR        read-only single-machine data in DIR [PREFIX/etc]
237  --sharedstatedir=DIR    modifiable architecture-independent data in DIR
238                          [PREFIX/com]
239  --localstatedir=DIR     modifiable single-machine data in DIR [PREFIX/var]
240  --libdir=DIR            object code libraries in DIR [EPREFIX/lib]
241  --includedir=DIR        C header files in DIR [PREFIX/include]
242  --oldincludedir=DIR     C header files for non-gcc in DIR [/usr/include]
243  --infodir=DIR           info documentation in DIR [PREFIX/info]
244  --mandir=DIR            man documentation in DIR [PREFIX/man]
245  --srcdir=DIR            find the sources in DIR [configure dir or ..]
246  --program-prefix=PREFIX prepend PREFIX to installed program names
247  --program-suffix=SUFFIX append SUFFIX to installed program names
248  --program-transform-name=PROGRAM
249                          run sed PROGRAM on installed program names
250Host type:
251  --build=BUILD           configure for building on BUILD [BUILD=HOST]
252  --host=HOST             configure for HOST [guessed]
253  --target=TARGET         configure for TARGET [TARGET=HOST]
254Features and packages:
255  --disable-FEATURE       do not include FEATURE (same as --enable-FEATURE=no)
256  --enable-FEATURE[=ARG]  include FEATURE [ARG=yes]
257  --with-PACKAGE[=ARG]    use PACKAGE [ARG=yes]
258  --without-PACKAGE       do not use PACKAGE (same as --with-PACKAGE=no)
259  --x-includes=DIR        X include files are in DIR
260  --x-libraries=DIR       X library files are in DIR
261--enable and --with options recognized:
262  --without-readline   do not use readline for fancy display
263  --without-gmp        do not use gmp library
264  --without-MP         do not use MP (disables MP links)
265  --without-dbm        do not use dbm (disables DBM links)
266  --without-dld        do not use dld (disables dynamic linking)
267  --without-factory    do not use factory (disables poly factorization)
268  --without-libfac     do not use libfac (disables primary decompositions)
Note: See TracBrowser for help on using the repository browser.