XZX-Pro An X11-based ZX Spectrum emulator by Erik Kunze based on XZX 1.0.2 by Des Herriott and many others $Id: INSTALL,v 4.15 2001/12/25 12:30:43 erik Rel $ Overview -------- XZX-Pro will run on most Unix systems, and by now most of the portability issues have been sorted out. However, since I am developing XZX-Pro using Linux, you may encounter problems from time to time. If this happens, let me know as soon as possible so these can be fixed in the next release. XZX-Pro is known to work on the following machines/operating systems: Sparc - Solaris, SunOS 4.x, Linux, NetBSD Intel - SVR4, SCO, SINIX, Linux, FreeBSD Mips - SVR4, DEC Ultrix, SGI Irix, SINIX, Linux, NetBSD IBM RS6000 - AIX 3.2.x PA-RISC - HP/UX DEC Alpha - OSF/1, Linux Motorola 68K - Bull B.O.S., Linux PowerPC - Linux, AIX 4.1.4 XZX-Pro will work with monochrome displays; contrasting colours are displayed with the darker colour in black and the lighter colour in white, which works reasonably well. Halftoning is used if the scaling factor is increased. If and when you succeed in getting XZX-Pro working on other platforms, please let me know. Any diffs or descriptions of changes you made to make it work are welcome. Requirements ------------ These are the requirements for getting the Unix version to run: o An X11R4 or newer server. R3 might work, but I have not tried it. o The MIT-SHM extension is *strongly* recommended. It will work without it, but will be SLOW. o A 'C' compiler which supports prototypes. GCC works fine, although not in strict ANSI mode (-ansi), since XZX-Pro uses some extensions. o Motif 2.1 or newer for the GUI. LessTif will not work! Installing ---------- To install the emulator, do the following: o Unpack the archive to an appropriate directory. o `cd' to the directory containing the package's source code and type `./configure' to configure the package for your system. If you're using `csh' on an old version of System V, you might need to type `sh ./configure' instead to prevent `csh' from trying to execute `configure' itself. Running `configure' takes awhile. While running, it prints some messages telling which features it is checking for. o Check the generated file "config.h" for some tweakable defines; descriptions of what each definition does appear in these files. Check that proper integer types are used for 8, 16 and 32 bit data on your platform. o Type `make' to compile the package. Ignore warnings if you get them. NOTE: z80.c takes quite a while to compile. If you run out of swapspace try to undefine HAVE_ENOUGH_SWAP in "config.h". o Type `make install' to install the programs and any data files and documentation. o You can test the emulator at this point by typing 'xzx'. This should start Sinclair BASIC and give you the familiar "(c)1982 Sinclair Research Ltd" message. If it does not, something is wrong. o You can remove the program binaries and object files from the source code directory by typing `make clean'. To also remove the files that `configure' created (so you can compile the package for a different kind of computer), type `make distclean'. Compilers and Options --------------------- Some systems require unusual options for compilation or linking that the `configure' script does not know about. You can give `configure' initial values for variables by setting them in the environment. Using a Bourne-compatible shell, you can do that on the command line like this: CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure Or on systems that have the `env' program, you can do it like this: env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure Installation Names ------------------ By default, `make install' will install the package's files in `/usr/local/bin', `/usr/local/man', etc. You can specify an installation prefix other than `/usr/local' by giving `configure' the option `--prefix=PATH'. You can specify separate installation prefixes for architecture-specific files and architecture-independent files. If you give `configure' the option `--exec-prefix=PATH', the package will use PATH as the prefix for installing programs and libraries. Documentation and other data files will still use the regular prefix. In addition, if you use an unusual directory layout you can give options like `--bindir=PATH' to specify different values for particular kinds of files. Run `configure --help' for a list of the directories you can set and what kinds of files go in them. If the package supports it, you can cause programs to be installed with an extra prefix or suffix on their names by giving `configure' the option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. Optional Features ----------------- XZX-Pro pays attention to `--enable-FEATURE' and `--with-FEATURE' options to `configure', where FEATURE indicates an optional part of the package. For packages that use the X Window System, `configure' can usually find the X include and library files automatically, but if it does not, you can use the `configure' options `--x-includes=DIR' and `--x-libraries=DIR' to specify their locations. Specifying the System Type -------------------------- There may be some features `configure' can not figure out automatically, but needs to determine by the type of host the package will run on. Usually `configure' can figure that out, but if it prints a message saying it can not guess the host type, give it the `--host=TYPE' option. TYPE can either be a short name for the system type, such as `sun4', or a canonical name with three fields: CPU-COMPANY-SYSTEM See the file `config.sub' for the possible values of each field. If `config.sub' isn't included in this package, then this package does not need to know the host type. Operation Controls ------------------ `configure' recognizes the following options to control how it operates. `--cache-file=FILE' Use and save the results of the tests in FILE instead of `./config.cache'. Set FILE to `/dev/null' to disable caching, for debugging `configure'. `--help' Print a summary of the options to `configure', and exit. `--quiet' `--silent' `-q' Do not print messages saying which checks are being made. To suppress all normal output, redirect it to `/dev/null' (any error messages will still be shown). `--srcdir=DIR' Look for the package's source code in directory DIR. Usually `configure' can determine that directory automatically. `--version' Print the version of Autoconf used to generate the `configure' script, and exit. `configure' also accepts some other, not widely useful, options.