ePiX-1.2 -- INSTALL Last Change: September 12, 2007 Please consult the following files as appropriate: INSTALL (this file) -- Detailed installation instructions NEWS -- Recent major changes (see ChangeLog for code changes) README -- General overview and information CONVENTIONS Lines starting with a "%" denote commands typed at a shell prompt. Lines starting with a "#" denote commands run as root. Don't type the prompt characters "%" or "#". :) "$(prefix)" stands for the complete path to the install directory, e.g. "/usr/local" or "/home/pootle/epix". DEPENDENCIES The following software must be installed on your system in order for you to use ePiX: * The GNU shell, bash * A C++ compiler and development libraries, preferably g++ (> 3.2) * GhostScript, ImageMagick, and teTeX * GNU binutils, textutils, and fileutils (ar, sed, grep, ln, rm...) Please consult your system documentation for information on installing these components. The POST-INSTALL file contains potentially helpful information, as well. The manual contains more detailed instructions for Windows (Cygwin) and Mac OS X (fink/fink commander) users. INSTALLATION --- Synopsis --- (1) Unpack (2) Configure: % ./configure [options] (3) Build: % make % make install (may require system privileges) --- Step-by-step Instructions --- (1) Unpack Tarballs are available gzip or bzip2 compressed. To unpack, use the appropriate version number and tar options (z for .gz, j for .bz2, v to see filenames unpacked): % tar -zxf epix-x.y.z.tar.gz or % tar -jxf epix-x.y.z.tar.bz2 If your "tar" doesn't understand decompression, do % gunzip -c epix-x.y.z.tar.gz | tar -xf - or % bzcat epix-x.y.z.tar.bz2 | tar -xf - Change to the source directory: % cd epix-x.y.z (2) Configure the package: Most users can run the command % ./configure To change the installation directory from the default (/usr/local) to (say) your home directory, do % ./configure --prefix=${HOME} To list all options, run % ./configure --help (3) Compile and install: % make Be sure you are using GNU make. If the build fails immediately with an error about unexpected characters in the Makefile, speak to your system administrator about availability of GNU make, or try running the command "gmake". If there are no build errors, you're ready to install. You must have write permission in the install directory you selected in step (2). If you have been logged on as yourself until now (a Very Good Idea) and are installing in a system directory, do: % su Password: # make install (The root prompt on many systems is # rather than %.) If the install succeeds, you're done: # exit If you are installing somewhere in your HOME directory, just type % make install (4) Post-Install: Documentation is installed in $(prefix)/share/doc/epix, as compiled files (ps, pdf, info) and tarred LaTeX sources. The directory $(prefix)/share/doc/epix/config contains two optional files: Jay Belanger's emacs mode for working with ePiX files, and completions for users of Ian MacDonald's bash completions package. POST-INSTALL has instructions on installing and using these files. From the source directory, do % make clean to clean the source tree of compiled files. This command removes the top-level Makefile. Run ./configure to re-create the Makefile if necessary. (5) Uninstalling: To remove a version of ePiX from your system, go to the directory where the sources were unpacked, run ./config.status, log on as root if necessary, and do: # make uninstall Alternatively, remove the following files and directories manually, replacing $(prefix) with the install path, e.g. "/usr/local". [] Shell scripts $(prefix)/bin/{elaps,epix,flix,laps} [] Static libraries and shell code $(prefix)/lib/epix/ [] Header files $(prefix)/include/epix.h (user header) $(prefix)/include/epix/ (devel headers) [] Configuration files, manuals, and samples $(prefix)/share/doc/epix/ --- Contact Information --- If you have questions, comments, suggestions, etc., please write to: Andrew D. ("Andy") Hwang Dept. of Mathematics and Computer Science College of the Holy Cross Worcester, MA, 01610-2395, USA