INSTALL

   1 MAXIMA BUILD AND INSTALL INSTRUCTIONS
   2
   3 INTRODUCTION
   4 ============
   5
   6 Maxima is written in Common Lisp. For details about supported Common
   7 Lisp implementations, please see the file README.lisps.
   8
   9 You can download installers for Maxima for Microsoft Windows, Mac OS
  10 and RPM based Linux distributions from:
  11 https://sourceforge.net/projects/maxima/files/
  12
  13
  14 If you want to build it from source, Maxima can be built in four ways.
  15
  16 (1) Lisp-only build
  17
  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).
  25
  26 (2) Win32 build and install
  27
  28     Win32 build and install is suitable for MS Windows systems
  29     with GNU Autotools (Mingw or otherwise).
  30
  31 (3) Crosscompiling a Windows installer on Linux/Unix
  32
  33     An installer for MS Windows can be crosscompiled
  34     on a Linux/Unix system.
  35
  36 (4) Unix GNU Autotools build and install
  37
  38     Unix GNU Autotools build and install is suitable for Unix and
  39     Unix-like systems (e.g. Linux) with GNU Autotools.
  40
  41
  42
  43 LISP-ONLY BUILD
  44 ===============
  45
  46 See: INSTALL.lisp
  47
  48
  49 WIN32 BUILD AND INSTALL
  50 =======================
  51
  52 See: INSTALL.win32 (for build instructions with GCL) or
  53 INSTALL.win32nogcl (for build instructions with CCL/SBCL)
  54
  55
  56 CROSSCOMPILING A WINDOWS INSTALLER ON LINUX/UNIX
  57 ================================================
  58
  59 See crosscompile-windows/README.txt for build instructions.
  60
  61
  62 UNIX GNU AUTOTOOLS BUILD AND INSTALL
  63 ====================================
  64
  65 IF CONFIGURE SCRIPT IS ABSENT
  66 -----------------------------
  67
  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.)
  71
  72
  73 IF CONFIGURE SCRIPT IS PRESENT
  74 ------------------------------
  75
  76 ``./configure --help'' prints information about configuration options.
  77
  78 To build with GNU Autotools using the default options, type
  79         ./configure
  80         make
  81         make check
  82         make install
  83 configure supports many options. Type
  84         ./configure --help
  85 to see them enumerated.
  86
  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();.
  89
  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
  93         LANG=C make
  94         LANG=C make install
  95 Otherwise problems with Maxima on-line help system (describe command)
  96 can be expected.
  97
  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) :
 101
 102 *** - invalid byte sequence #xED #x73 #x69 in CHARSET:UTF-8 conversion
 103 The following restarts are available:
 104 ABORT          :R1      ABORT
 105 Break 1 [2]>
 106
 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.
 111
 112 If you want, you can build the documentation in PDF and EPUB format
 113 (by default these formats are not build). Run
 114 make pdf
 115 after "make" to build PDFs from the reference manual and some
 116 other documents.
 117 make -C doc/info maxima.epub
 118 will generate a EPUB version of the Maxima reference manual in
 119 doc/info/maxima.epub
 120 Calibre is required for building the EPUB, LaTeX is required for
 121 building the PDFs.
 122
 123
 124 Generic Autotools build instructions follow.
 125
 126
 127
 128 Basic Installation
 129 ==================
 130
 131    These are generic installation instructions.
 132
 133    The `configure' shell script attempts to guess correct values for
 134 various system-dependent variables used during compilation.  It uses
 135 those values to create a `Makefile' in each directory of the package.
 136 It may also create one or more `.h' files containing system-dependent
 137 definitions.  Finally, it creates a shell script `config.status' that
 138 you can run in the future to recreate the current configuration, a file
 139 `config.cache' that saves the results of its tests to speed up
 140 reconfiguring, and a file `config.log' containing compiler output
 141 (useful mainly for debugging `configure').
 142
 143    If you need to do unusual things to compile the package, please try
 144 to figure out how `configure' could check whether to do them, and mail
 145 diffs or instructions to the address given in the `README' so they can
 146 be considered for the next release.  If at some point `config.cache'
 147 contains results you don't want to keep, you may remove or edit it.
 148
 149    The file `configure.ac' is used to create `configure' by a program
 150 called `autoconf'.  You only need `configure.ac' if you want to change
 151 it or regenerate `configure' using a newer version of `autoconf'.
 152
 153 The simplest way to compile this package is:
 154
 155   1. `cd' to the directory containing the package's source code and type
 156      `./configure' to configure the package for your system.  If you're
 157      using `csh' on an old version of System V, you might need to type
 158      `sh ./configure' instead to prevent `csh' from trying to execute
 159      `configure' itself.
 160
 161      Running `configure' takes awhile.  While running, it prints some
 162      messages telling which features it is checking for.
 163
 164   2. Type `make' to compile the package.
 165
 166   3. Optionally, type `make check' to run any self-tests that come with
 167      the package.
 168
 169   4. Type `make install' to install the programs and any data files and
 170      documentation.
 171
 172   5. You can remove the program binaries and object files from the
 173      source code directory by typing `make clean'.  To also remove the
 174      files that `configure' created (so you can compile the package for
 175      a different kind of computer), type `make distclean'.  There is
 176      also a `make maintainer-clean' target, but that is intended mainly
 177      for the package's developers.  If you use it, you may have to get
 178      all sorts of other programs in order to regenerate files that came
 179      with the distribution.
 180
 181 Compilers and Options
 182 =====================
 183
 184    Some systems require unusual options for compilation or linking that
 185 the `configure' script does not know about.  You can give `configure'
 186 initial values for variables by setting them in the environment.  Using
 187 a Bourne-compatible shell, you can do that on the command line like
 188 this:
 189      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
 190
 191 Or on systems that have the `env' program, you can do it like this:
 192      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
 193
 194 Compiling For Multiple Architectures
 195 ====================================
 196
 197    You can compile the package for more than one kind of computer at the
 198 same time, by placing the object files for each architecture in their
 199 own directory.  To do this, you must use a version of `make' that
 200 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 201 directory where you want the object files and executables to go and run
 202 the `configure' script.  `configure' automatically checks for the
 203 source code in the directory that `configure' is in and in `..'.
 204
 205    If you have to use a `make' that does not supports the `VPATH'
 206 variable, you have to compile the package for one architecture at a time
 207 in the source code directory.  After you have installed the package for
 208 one architecture, use `make distclean' before reconfiguring for another
 209 architecture.
 210
 211 Installation Names
 212 ==================
 213
 214    By default, `make install' will install the package's files in
 215 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
 216 installation prefix other than `/usr/local' by giving `configure' the
 217 option `--prefix=PATH'.
 218
 219    You can specify separate installation prefixes for
 220 architecture-specific files and architecture-independent files.  If you
 221 give `configure' the option `--exec-prefix=PATH', the package will use
 222 PATH as the prefix for installing programs and libraries.
 223 Documentation and other data files will still use the regular prefix.
 224
 225    In addition, if you use an unusual directory layout you can give
 226 options like `--bindir=PATH' to specify different values for particular
 227 kinds of files.  Run `configure --help' for a list of the directories
 228 you can set and what kinds of files go in them.
 229
 230    If the package supports it, you can cause programs to be installed
 231 with an extra prefix or suffix on their names by giving `configure' the
 232 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 233
 234 Optional Features
 235 =================
 236
 237    Some packages pay attention to `--enable-FEATURE' options to
 238 `configure', where FEATURE indicates an optional part of the package.
 239 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 240 is something like `gnu-as' or `x' (for the X Window System).  The
 241 `README' should mention any `--enable-' and `--with-' options that the
 242 package recognizes.
 243
 244    For packages that use the X Window System, `configure' can usually
 245 find the X include and library files automatically, but if it doesn't,
 246 you can use the `configure' options `--x-includes=DIR' and
 247 `--x-libraries=DIR' to specify their locations.
 248
 249 Specifying the System Type
 250 ==========================
 251
 252    There may be some features `configure' can not figure out
 253 automatically, but needs to determine by the type of host the package
 254 will run on.  Usually `configure' can figure that out, but if it prints
 255 a message saying it can not guess the host type, give it the
 256 `--host=TYPE' option.  TYPE can either be a short name for the system
 257 type, such as `sun4', or a canonical name with three fields:
 258      CPU-COMPANY-SYSTEM
 259
 260 See the file `config.sub' for the possible values of each field.  If
 261 `config.sub' isn't included in this package, then this package doesn't
 262 need to know the host type.
 263
 264    If you are building compiler tools for cross-compiling, you can also
 265 use the `--target=TYPE' option to select the type of system they will
 266 produce code for and the `--build=TYPE' option to select the type of
 267 system on which you are compiling the package.
 268
 269 Sharing Defaults
 270 ================
 271
 272    If you want to set default values for `configure' scripts to share,
 273 you can create a site shell script called `config.site' that gives
 274 default values for variables like `CC', `cache_file', and `prefix'.
 275 `configure' looks for `PREFIX/share/config.site' if it exists, then
 276 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 277 `CONFIG_SITE' environment variable to the location of the site script.
 278 A warning: not all `configure' scripts look for a site script.
 279
 280 Operation Controls
 281 ==================
 282
 283    `configure' recognizes the following options to control how it
 284 operates.
 285
 286 `--cache-file=FILE'
 287      Use and save the results of the tests in FILE instead of
 288      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 289      debugging `configure'.
 290
 291 `--help'
 292      Print a summary of the options to `configure', and exit.
 293
 294 `--quiet'
 295 `--silent'
 296 `-q'
 297      Do not print messages saying which checks are being made.  To
 298      suppress all normal output, redirect it to `/dev/null' (any error
 299      messages will still be shown).
 300
 301 `--srcdir=DIR'
 302      Look for the package's source code in directory DIR.  Usually
 303      `configure' can determine that directory automatically.
 304
 305 `--version'
 306      Print the version of Autoconf used to generate the `configure'
 307      script, and exit.
 308
 309 `configure' also accepts some other, not widely useful, options.