1Installation From SVN 2===================== 3 4If you intend to compile PrBoom from a source tar file, such as 5prboom-2.5.0.tar.gz, as opposed to SVN, skip to the "Basic Installation" 6section. 7 8 1. Install and configure deutex. If deutex is already installed and 9 configured skip to step 2. 10 a. Install deutex from http://www.teaser.fr/~amajorel/deutex 11 b. Set the DOOMWADDIR environment variable to the directory that 12 contains the IWAD files: 13 export DOOMWADDIR=/usr/local/share/games/doom 14 15 2. 'cd' to a suitable parent directory for the PrBoom distribution: 16 cd /usr/local/src 17 18 3. Extract the PrBoom distribution from SVN: 19 svn co http://www.crowproductions.de/repos/prboom/trunk/prboom2 20 21 4. 'cd' to the directory containing the PrBoom distribution (the directory 22 this file is in): 23 cd prboom2 24 25 5. Run the 'bootstrap' script in order to create the 'configure' script. 26 ./bootstrap 27 If you get this error: 28 aclocal: configure.ac: 153: macro `AM_PATH_SDL' not found in library 29 Then you have to locate sdl.m4 and copy it to ./autotools/sdl.m4 in your 30 prboom directory. 31 32 6. If the 'configure' script was created by step 5 then proceed to the 33 "Basic Installation" section. 34 35Basic Installation 36================== 37 38 1. To compile PrBoom, you need the SDL development headers and libraries 39 installed (SDL, SDL_mixer, SDL_net). See 40 http://prboom.sourceforge.net/linux.html for information on downloading 41 the right libraries for your system. 42 43 2. `cd' to the directory containing the PrBoom distribution (the directory 44 this file is in). 45 46 Type `./configure' to configure PrBoom for your system. If you're 47 using `csh' on an old version of System V, you might need to type 48 `sh ./configure' instead to prevent `csh' from trying to execute 49 `configure' itself. 50 51 Running `configure' takes awhile. While running, it prints some 52 messages telling which features it is checking for. 53 54 3. Type `make' to compile PrBoom. This may take some time; while it's 55 compiling I suggest you read the README, or maybe go and look for some 56 good doom levels to play when it's finished :-). 57 58 This should work on all Linux systems, but systems that have a make 59 utility other than GNU make may have problems. E.g. you might need to 60 install GNU make, and then use it instead of make for these 61 instructions. I have tested BSD pmake and it works fine. 62 63 4. Type `make install-strip' as root, to install the programs, data files 64 and man pages for PrBoom. If you don't have root access on the machine, 65 you should ask the syadmin to do this and the next step for you. 66 67 5. Copy your Doom, Doom 2, Ultimate Doom or Final Doom IWAD (doom.wad or 68 doom2.wad) to /usr/local/share/games/doom/ (or symlink it from there). 69 Or if you don't have any of those, use the shareware IWAD, which you can 70 get from http://www.doomworld.com/ or http://www.idsoftware.com/. 71 72 If you have a system with many users, you should read the license for 73 your version of Doom, and make sure only those users allowed to use it 74 can access the IWAD file. 75 76 6. You can remove the program binaries and object files from the 77 source directory by typing `make clean'. To also remove the 78 files that `configure' created (so you can compile the package for 79 a different kind of computer), type `make distclean'. There is 80 also a `make maintainer-clean' target, but that is intended mainly 81 for the package's developers. If you use it, you may have to get 82 all sorts of other programs in order to regenerate files that came 83 with the distribution. 84 85 7. PrBoom is now ready for use. If /usr/local/games is in your path, 86 you can just run prboom; otherwise give the full path. 87 88 See the README file for information about getting the Timidity 89 patches needed for music support, and more. 90 91Building an RPM 92=============== 93 94If you are on a system which uses the RPM packaging format, you might prefer 95to build an RPM containing the PrBoom binaries rather than installing them 96directly. Follow steps 1 and 2 above, then run a "make rpm". This performs 97the usual proceedure for building the rpm in /usr/src/redhat/. Note that 98the RPM sets its own parameters to ./configure; if you want to override 99them you'll have to edit the build scripts yourself. Note that to get the 100correct permissions, you either have to run this process as root, or use the 101wrapper program fakeroot (version 0.4.5 or later - grab it from the Debian 102source archive) and make sure you have permissions to the RPM build area. 103 104Installation Details 105==================== 106 107 These are generic installation instructions. 108 109 The `configure' shell script attempts to guess correct values for 110various system-dependent variables used during compilation. It uses 111those values to create a `Makefile' in each directory of the package. 112It may also create one or more `.h' files containing system-dependent 113definitions. Finally, it creates a shell script `config.status' that 114you can run in the future to recreate the current configuration, a file 115`config.cache' that saves the results of its tests to speed up 116reconfiguring, and a file `config.log' containing compiler output 117(useful mainly for debugging `configure'). 118 119 If you need to do unusual things to compile the package, please try 120to figure out how `configure' could check whether to do them, and mail 121diffs or instructions to the address given in the `README' so they can 122be considered for the next release. If at some point `config.cache' 123contains results you don't want to keep, you may remove or edit it. 124 125 The file `configure.ac' is used to create `configure' by a program 126called `autoconf'. You only need `configure.ac' if you want to change 127it or regenerate `configure' using a newer version of `autoconf'. 128 129Compilers and Options 130===================== 131 132 Some systems require unusual options for compilation or linking that 133the `configure' script does not know about. You can give `configure' 134initial values for variables by setting them in the environment. Using 135a Bourne-compatible shell, you can do that on the command line like 136this: 137 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure 138 139Or on systems that have the `env' program, you can do it like this: 140 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure 141 142Compiling For Multiple Architectures 143==================================== 144 145 You can compile the package for more than one kind of computer at the 146same time, by placing the object files for each architecture in their 147own directory. To do this, you must use a version of `make' that 148supports the `VPATH' variable, such as GNU `make'. `cd' to the 149directory where you want the object files and executables to go and run 150the `configure' script. `configure' automatically checks for the 151source code in the directory that `configure' is in and in `..'. 152 153 If you have to use a `make' that does not supports the `VPATH' 154variable, you have to compile the package for one architecture at a time 155in the source code directory. After you have installed the package for 156one architecture, use `make distclean' before reconfiguring for another 157architecture. 158 159Installation Names 160================== 161 162 By default, `make install' will install the package's files in 163`/usr/local/bin', `/usr/local/man', etc. You can specify an 164installation prefix other than `/usr/local' by giving `configure' the 165option `--prefix=PATH'. 166 167 You can specify separate installation prefixes for 168architecture-specific files and architecture-independent files. If you 169give `configure' the option `--exec-prefix=PATH', the package will use 170PATH as the prefix for installing programs and libraries. 171Documentation and other data files will still use the regular prefix. 172 173 In addition, if you use an unusual directory layout you can give 174options like `--bindir=PATH' to specify different values for particular 175kinds of files. Run `configure --help' for a list of the directories 176you can set and what kinds of files go in them. 177 178 If the package supports it, you can cause programs to be installed 179with an extra prefix or suffix on their names by giving `configure' the 180option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 181 182Optional Features 183================= 184 185 Some packages pay attention to `--enable-FEATURE' options to 186`configure', where FEATURE indicates an optional part of the package. 187They may also pay attention to `--with-PACKAGE' options, where PACKAGE 188is something like `gnu-as' or `x' (for the X Window System). The 189`README' should mention any `--enable-' and `--with-' options that the 190package recognizes. 191 192 For packages that use the X Window System, `configure' can usually 193find the X include and library files automatically, but if it doesn't, 194you can use the `configure' options `--x-includes=DIR' and 195`--x-libraries=DIR' to specify their locations. 196 197Specifying the System Type 198========================== 199 200 There may be some features `configure' can not figure out 201automatically, but needs to determine by the type of host the package 202will run on. Usually `configure' can figure that out, but if it prints 203a message saying it can not guess the host type, give it the 204`--host=TYPE' option. TYPE can either be a short name for the system 205type, such as `sun4', or a canonical name with three fields: 206 CPU-COMPANY-SYSTEM 207 208See the file `config.sub' for the possible values of each field. If 209`config.sub' isn't included in this package, then this package doesn't 210need to know the host type. 211 212 If you are building compiler tools for cross-compiling, you can also 213use the `--target=TYPE' option to select the type of system they will 214produce code for and the `--build=TYPE' option to select the type of 215system on which you are compiling the package. 216 217Sharing Defaults 218================ 219 220 If you want to set default values for `configure' scripts to share, 221you can create a site shell script called `config.site' that gives 222default values for variables like `CC', `cache_file', and `prefix'. 223`configure' looks for `PREFIX/share/config.site' if it exists, then 224`PREFIX/etc/config.site' if it exists. Or, you can set the 225`CONFIG_SITE' environment variable to the location of the site script. 226A warning: not all `configure' scripts look for a site script. 227 228Operation Controls 229================== 230 231 `configure' recognizes the following options to control how it 232operates. 233 234`--cache-file=FILE' 235 Use and save the results of the tests in FILE instead of 236 `./config.cache'. Set FILE to `/dev/null' to disable caching, for 237 debugging `configure'. 238 239`--help' 240 Print a summary of the options to `configure', and exit. 241 242`--quiet' 243`--silent' 244`-q' 245 Do not print messages saying which checks are being made. To 246 suppress all normal output, redirect it to `/dev/null' (any error 247 messages will still be shown). 248 249`--srcdir=DIR' 250 Look for the package's source code in directory DIR. Usually 251 `configure' can determine that directory automatically. 252 253`--version' 254 Print the version of Autoconf used to generate the `configure' 255 script, and exit. 256 257`configure' also accepts some other, not widely useful, options. 258