1 MAXIMA BUILD AND INSTALL INSTRUCTIONS
6 Maxima is written in Common Lisp. For details about supported Common
7 Lisp implementations, please see the file README.lisps.
9 You can download installers for Maxima for Microsoft Windows, Mac OS
10 and RPM based Linux distributions from:
11 http://sourceforge.net/projects/maxima/files/
14 If you want to build it from source, Maxima can be built in four ways.
18 Lisp-only build is suitable for systems lacking GNU Autotools,
19 e.g. MS Windows systems. Lisp-only build creates a Maxima
20 executable image, but it does not create the Maxima texinfo
21 documentation, it does not adjust various pathnames and other
22 environmental variables in the maxima and xmaxima scripts,
23 it does not install Gnuplot, and it does not create an
24 installer file (neither RPM or Windows installer).
26 (2) Win32 build and install
28 Win32 build and install is suitable for MS Windows systems
29 with GNU Autotools (Mingw or otherwise).
31 (3) Crosscompiling a Windows installer on Linux/Unix
33 A (Clisp-based) installer for MS Windows can be crosscompiled
34 on a Linux/Unix system.
36 (4) Unix GNU Autotools build and install
38 Unix GNU Autotools build and install is suitable for Unix and
39 Unix-like systems (e.g. Linux) with GNU Autotools.
49 WIN32 BUILD AND INSTALL
50 =======================
52 See: INSTALL.win32 (for build instructions with GCL) or
53 INSTALL.win32nogcl (for build instructions with CCL/SBCL)
56 CROSSCOMPILING A WINDOWS INSTALLER ON LINUX/UNIX
57 ================================================
59 See crosscompile-windows/README.txt for build instructions.
62 UNIX GNU AUTOTOOLS BUILD AND INSTALL
63 ====================================
65 IF CONFIGURE SCRIPT IS ABSENT
66 -----------------------------
68 Execute ``sh bootstrap'' to create the Maxima configure script.
69 (configure is absent if the source code is obtained directly
70 from GIT instead of rpm or tar.gz release file.)
73 IF CONFIGURE SCRIPT IS PRESENT
74 ------------------------------
76 ``./configure --help'' prints information about configuration options.
78 To build with GNU Autotools using the default options, type
83 configure supports many options. Type
85 to see them enumerated.
87 The "make check" step runs the Maxima test suite. The Maxima test
88 suite is also available at run time via the command run_testsuite();.
90 If locale under which Maxima is built is not C, POSIX or
91 any English language locale then is is highly recommended
92 to run "make/make install" in C locale
95 Otherwise problems with Maxima on-line help system (describe command)
98 On certain systems problem with Maxima under Clisp is reported.
99 When Maxima starts it gives the following error (exact content
100 of the message may vary) :
102 *** - invalid byte sequence #xED #x73 #x69 in CHARSET:UTF-8 conversion
103 The following restarts are available:
107 Quite likely this is Clisp installation problem. One can check
108 this by running clisp command -- it should produce the same
109 error message. Known workaround is to create empty .clisprc
110 file in user's home directory.
113 Generic Autotools build instructions follow.
120 These are generic installation instructions.
122 The `configure' shell script attempts to guess correct values for
123 various system-dependent variables used during compilation. It uses
124 those values to create a `Makefile' in each directory of the package.
125 It may also create one or more `.h' files containing system-dependent
126 definitions. Finally, it creates a shell script `config.status' that
127 you can run in the future to recreate the current configuration, a file
128 `config.cache' that saves the results of its tests to speed up
129 reconfiguring, and a file `config.log' containing compiler output
130 (useful mainly for debugging `configure').
132 If you need to do unusual things to compile the package, please try
133 to figure out how `configure' could check whether to do them, and mail
134 diffs or instructions to the address given in the `README' so they can
135 be considered for the next release. If at some point `config.cache'
136 contains results you don't want to keep, you may remove or edit it.
138 The file `configure.ac' is used to create `configure' by a program
139 called `autoconf'. You only need `configure.ac' if you want to change
140 it or regenerate `configure' using a newer version of `autoconf'.
142 The simplest way to compile this package is:
144 1. `cd' to the directory containing the package's source code and type
145 `./configure' to configure the package for your system. If you're
146 using `csh' on an old version of System V, you might need to type
147 `sh ./configure' instead to prevent `csh' from trying to execute
150 Running `configure' takes awhile. While running, it prints some
151 messages telling which features it is checking for.
153 2. Type `make' to compile the package.
155 3. Optionally, type `make check' to run any self-tests that come with
158 4. Type `make install' to install the programs and any data files and
161 5. You can remove the program binaries and object files from the
162 source code directory by typing `make clean'. To also remove the
163 files that `configure' created (so you can compile the package for
164 a different kind of computer), type `make distclean'. There is
165 also a `make maintainer-clean' target, but that is intended mainly
166 for the package's developers. If you use it, you may have to get
167 all sorts of other programs in order to regenerate files that came
168 with the distribution.
170 Compilers and Options
171 =====================
173 Some systems require unusual options for compilation or linking that
174 the `configure' script does not know about. You can give `configure'
175 initial values for variables by setting them in the environment. Using
176 a Bourne-compatible shell, you can do that on the command line like
178 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
180 Or on systems that have the `env' program, you can do it like this:
181 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
183 Compiling For Multiple Architectures
184 ====================================
186 You can compile the package for more than one kind of computer at the
187 same time, by placing the object files for each architecture in their
188 own directory. To do this, you must use a version of `make' that
189 supports the `VPATH' variable, such as GNU `make'. `cd' to the
190 directory where you want the object files and executables to go and run
191 the `configure' script. `configure' automatically checks for the
192 source code in the directory that `configure' is in and in `..'.
194 If you have to use a `make' that does not supports the `VPATH'
195 variable, you have to compile the package for one architecture at a time
196 in the source code directory. After you have installed the package for
197 one architecture, use `make distclean' before reconfiguring for another
203 By default, `make install' will install the package's files in
204 `/usr/local/bin', `/usr/local/man', etc. You can specify an
205 installation prefix other than `/usr/local' by giving `configure' the
206 option `--prefix=PATH'.
208 You can specify separate installation prefixes for
209 architecture-specific files and architecture-independent files. If you
210 give `configure' the option `--exec-prefix=PATH', the package will use
211 PATH as the prefix for installing programs and libraries.
212 Documentation and other data files will still use the regular prefix.
214 In addition, if you use an unusual directory layout you can give
215 options like `--bindir=PATH' to specify different values for particular
216 kinds of files. Run `configure --help' for a list of the directories
217 you can set and what kinds of files go in them.
219 If the package supports it, you can cause programs to be installed
220 with an extra prefix or suffix on their names by giving `configure' the
221 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
226 Some packages pay attention to `--enable-FEATURE' options to
227 `configure', where FEATURE indicates an optional part of the package.
228 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
229 is something like `gnu-as' or `x' (for the X Window System). The
230 `README' should mention any `--enable-' and `--with-' options that the
233 For packages that use the X Window System, `configure' can usually
234 find the X include and library files automatically, but if it doesn't,
235 you can use the `configure' options `--x-includes=DIR' and
236 `--x-libraries=DIR' to specify their locations.
238 Specifying the System Type
239 ==========================
241 There may be some features `configure' can not figure out
242 automatically, but needs to determine by the type of host the package
243 will run on. Usually `configure' can figure that out, but if it prints
244 a message saying it can not guess the host type, give it the
245 `--host=TYPE' option. TYPE can either be a short name for the system
246 type, such as `sun4', or a canonical name with three fields:
249 See the file `config.sub' for the possible values of each field. If
250 `config.sub' isn't included in this package, then this package doesn't
251 need to know the host type.
253 If you are building compiler tools for cross-compiling, you can also
254 use the `--target=TYPE' option to select the type of system they will
255 produce code for and the `--build=TYPE' option to select the type of
256 system on which you are compiling the package.
261 If you want to set default values for `configure' scripts to share,
262 you can create a site shell script called `config.site' that gives
263 default values for variables like `CC', `cache_file', and `prefix'.
264 `configure' looks for `PREFIX/share/config.site' if it exists, then
265 `PREFIX/etc/config.site' if it exists. Or, you can set the
266 `CONFIG_SITE' environment variable to the location of the site script.
267 A warning: not all `configure' scripts look for a site script.
272 `configure' recognizes the following options to control how it
276 Use and save the results of the tests in FILE instead of
277 `./config.cache'. Set FILE to `/dev/null' to disable caching, for
278 debugging `configure'.
281 Print a summary of the options to `configure', and exit.
286 Do not print messages saying which checks are being made. To
287 suppress all normal output, redirect it to `/dev/null' (any error
288 messages will still be shown).
291 Look for the package's source code in directory DIR. Usually
292 `configure' can determine that directory automatically.
295 Print the version of Autoconf used to generate the `configure'
298 `configure' also accepts some other, not widely useful, options.