1INSTALL - Installation of Vim on different machines. 2 3This file contains instructions for compiling Vim. If you already have an 4executable version of Vim, you don't need this. 5 6Contents: 71. Generic 82. Unix 93. RISC OS 104. OS/2 (with EMX 0.9b) 115. Atari MiNT 12 13See INSTALLami.txt for Amiga 14See INSTALLmac.txt for Macintosh 15See INSTALLpc.txt for PC (MS-DOS, Windows 95/98/NT/XP) 16See INSTALLvms.txt for VMS 17See INSTALLx.txt for cross-compiling on Unix 18See ../runtime/doc/os_390.txt for OS/390 Unix 19See ../runtime/doc/os_beos.txt for BeBox 20 21 221. Generic 23========== 24 25If you compile Vim without specifying anything, you will get the default 26behaviour as is documented, which should be fine for most people. 27 28For features that you can't enable/disable in another way, you can edit the 29file "feature.h" to match your preferences. 30 31 322. Unix 33======= 34 35Summary: 361. make run configure, compile and link 372. make install installation in /usr/local 38 39This will include the GUI and X11 libraries, if you have them. If you want a 40version of Vim that is small and starts up quickly, see the Makefile for how 41to disable the GUI and X11. If you don't have GUI libraries and/or X11, these 42features will be disabled automatically. 43 44See the start of Makefile for more detailed instructions about how to compile 45Vim. 46 47If you need extra compiler and/or linker arguments, set $CFLAGS and/or $LIBS 48before starting configure. Example: 49 50 env CFLAGS=-I/usr/local/include LIBS=-lm make 51 52This is only needed for things that configure doesn't offer a specific argument 53for or figures out by itself. First try running configure without extra 54arguments. 55 56GNU Autoconf and a few other tools have been used to make Vim work on many 57different Unix systems. The advantage of this is that Vim should compile 58on most sytems without any adjustments. The disadvantage is that when 59adjustments are required, it takes some time to understand what is happening. 60 61If configure finds all library files and then complains when linking that some 62of them can't be found, your linker doesn't return an error code for missing 63libraries. Vim should be linked fine anyway, mostly you can just ignore these 64errors. 65 66If you run configure by hand (not using the Makefile), remember that any 67changes in the Makefile have no influence on configure. This may be what you 68want, but maybe not! 69 70The advantage of running configure separately, is that you can write a script 71to build Vim, without changing the Makefile or feature.h. Example (using sh): 72 73 CFLAGS=-DCOMPILER_FLAG ./configure --enable-gui=motif 74 75One thing to watch out for: If the configure script itself changes, running 76"make" will execute it again, but without your arguments. Do "make clean" and 77run configure again. 78 79If you are compiling Vim for several machines, for each machine: 80 a. make shadow 81 b. mv shadow machine_name 82 c. cd machine_name 83 d. make; make install 84 85[Don't use a path for machine_name, just a directory name, otherwise the links 86that "make shadow" creates won't work.] 87 88 89Unix: COMPILING WITH/WITHOUT GUI 90 91NOTE: This is incomplete, look in Makefile for more info. 92 93These configure arguments can be used to select which GUI to use: 94--enable-gui=gtk or: gtk2, motif, athena or auto 95--disable-gtk-check 96--disable-motif-check 97--disable-athena-check 98 99--enable-gui defaults to "auto", so it will automatically look for a GUI (in 100the order of GTK, Motif, then Athena). If one is found, then is uses it and 101does not proceed to check any of the remaining ones. Otherwise, it moves on 102to the next one. 103 104--enable-{gtk,gtk2,kde,motif,athena}-check all default to "yes", such that if 105--enable-gui is "auto" (which it is by default), GTK, Motif, and Athena will 106be checked for. If you want to *exclude* a certain check, then you use 107--disable-{gtk,gtk2,kde,motif,athena}-check. 108 109For example, if --enable-gui is set to "auto", but you don't want it look for 110Motif, you then also specify --disable-motif-check. This results in only 111checking for GTK and Athena. 112 113Lastly, if you know which one you want to use, then you can just do 114--enable-gui={gtk,gtk2,kde,motif,athena}. So if you wanted to only use Motif, 115then you'd specify --enable-gui=motif. Once you specify what you want, the 116--enable-{gtk,gtk2,kde,motif,athena}-check options are ignored. 117 118On Linux you usually need GUI "-devel" packages. You may already have GTK 119libraries installed, but that doesn't mean you can compile Vim with GTK, you 120also need the header files. 121 122For compiling with the GTK+ GUI, you need a recent version of glib and gtk+. 123Configure checks for at least version 1.1.16. An older version is not selected 124automatically. If you want to use it anyway, run configure with 125"--disable-gtktest". 126GTK requires an ANSI C compiler. If you fail to compile Vim with GTK+ (it 127is the preferred choice), try selecting another one in the Makefile. 128If you are sure you have GTK installed, but for some reason configure says you 129do not, you may have left-over header files and/or library files from an older 130(and incompatible) version of GTK. if this is the case, please check 131auto/config.log for any error messages that may give you a hint as to what's 132happening. 133 134There used to be a KDE version of Vim, using Qt libraries, but since it didn't 135work very well and there was no maintainer it was dropped. 136 137 138Unix: COMPILING WITH MULTI-BYTE 139 140When you want to compile with the multi-byte features enabled, make sure you 141compile on a machine where the locale settings actually work. otherwise the 142configure tests may fail. You need to compile with "big" features: 143 144 ./configure --with-features=big 145 146Unix: COMPILING ON LINUX 147 148On Linux, when using -g to compile (which is default for gcc), the executable 149will probably be statically linked. If you don't want this, remove the -g 150option from CFLAGS. 151 152Unix: PUTTING vimrc IN /etc 153 154Some Linux distributions prefer to put the global vimrc file in /etc, and the 155Vim runtime files in /usr. This can be done with: 156 ./configure --prefix=/usr 157 make VIMRCLOC=/etc VIMRUNTIMEDIR=/usr/share/vim MAKE="make -e" 158 159Unix: COMPILING ON NeXT 160 161Add the "-posix" argument to the compiler by using one of these commands: 162 setenv CC 'cc -posix' (csh) 163 export CC='cc -posix' (sh) 164And run configure with "--disable-motif-check". 165 166 1673. RISC OS 168============= 169 170Much file renaming is needed before you can compile anything. 171You'll need UnixLib to link against, GCC and GNU make. 172 173I suggest you get the RISC OS binary distribution, which includes the 174Templates file and the loader. 175 176Try here: http://www.ecs.soton.ac.uk/~tal197 177 178Do 179 :help riscos 180 181within the editor for more information, or read the 182../runtime/doc/os_risc.txt help file. 183 184 1854. OS/2 186======= 187 188Summary: 189ren Makefile Makefile.unix 190ren makefile.os2 Makefile 191make 192 193This port of Vim to OS/2 is based on the emx environment together 194with GNU C. The main design goal of emx is to simplify porting Unix 195software to OS/2 and DOS. Because of this, almost all the Unix defines 196etc. already existing in the Vim source code could be reused. Only where 197OS/2 specifics came into play were additional changes necessary. Those 198places can be found by searching for "OS2" and "__EMX__" (I've tried to 199keep emx-specific things separate from generic OS/2 stuff). 200 201Note: This OS/2 port works well for me and an additional OS/2 user on 202 the Vim development team (Karsten Sievert); however, since I 203 haven't had any other feedback from other people, that either 204 means no (OS/2-specific) bugs exist, or no one has yet created 205 a situation in which any bugs are apparent. 206 Report any problems or other comments to [email protected] 207 (email valid up to at least September 1996, after that try 208 [email protected], [email protected], or [email protected]). 209 Textmode/notextmode and binary mode both seem to work well. 210 211Prerequisites: 212- To compile, you need the emx environment (at least rev. 0.9b), GCC, 213 some make utility (GNU make works fine). These are generally 214 available as (ask Archie about them): 215 emxrt.zip emx runtime package 216 emxdev.zip emx development system (without compiler) 217 GNU programs compiled for emx, patches and patched sources: 218 gnudev1.zip GNU development tools compiled for emx (part 1) 219 gnudev2.zip GNU development tools compiled for emx (part 2) 220 gnumake.zip GNU make 221- Don't set a TERM environment variable; Vim defaults to os2ansi 222 which is available as a builtin termcap entry. Using other values 223 may give problems! (OS/2 ANSI emulation is quite limited.) If you 224 need to set TERM for other programs, you may consider putting 225 set term=os2ansi in the vimrc file. 226 227Check ../runtime/doc/os_os2.txt for additional info on running Vim. 228 229 2305. Atari MiNT 231============= 232 233[NOTE: this is quite old, it might not work anymore] 234 235To compile Vim for MiNT you may either copy Make_mint.mak to Makefile or use 236the Unix Makefile adapted for the MiNT configuration. 237 238Now proceed as described in the Unix section. 239 240Prerequisites: 241 242You need a curses or termcap library that supports non-alphanumeric 243termcap names. If you don't have any, link with termlib.o. 244 245----------------------------------------------------------------------------- 246 247The rest of this file is based on the INSTALL file that comes with GNU 248autoconf 2.12. Not everything applies to Vim. Read Makefile too! 249 250 251Basic Installation 252================== 253 254 These are generic installation instructions. 255 256 The `configure' shell script attempts to guess correct values for 257various system-dependent variables used during compilation. It uses 258those values to create a `Makefile' in each directory of the package. 259It may also create one or more `.h' files containing system-dependent 260definitions. Finally, it creates a shell script `config.status' that 261you can run in the future to recreate the current configuration, a file 262`config.cache' that saves the results of its tests to speed up 263reconfiguring, and a file `config.log' containing compiler output 264(useful mainly for debugging `configure'). 265 266 If you need to do unusual things to compile the package, please try 267to figure out how `configure' could check whether to do them, and mail 268diffs or instructions to the address given in the `README' so they can 269be considered for the next release. If at some point `config.cache' 270contains results you don't want to keep, you may remove or edit it. 271 272 The file `configure.in' is used to create `configure' by a program 273called `autoconf'. You only need `configure.in' if you want to change 274it or regenerate `configure' using a newer version of `autoconf'. 275 276The simplest way to compile this package is: 277 278 1. `cd' to the directory containing the package's source code and type 279 `./configure' to configure the package for your system. If you're 280 using `csh' on an old version of System V, you might need to type 281 `sh ./configure' instead to prevent `csh' from trying to execute 282 `configure' itself. 283 284 Running `configure' takes awhile. While running, it prints some 285 messages telling which features it is checking for. 286 287 2. Type `make' to compile the package. 288 289 3. Optionally, type `make check' to run any self-tests that come with 290 the package. 291 292 4. Type `make install' to install the programs and any data files and 293 documentation. 294 295 5. You can remove the program binaries and object files from the 296 source code directory by typing `make clean'. To also remove the 297 files that `configure' created (so you can compile the package for 298 a different kind of computer), type `make distclean'. There is 299 also a `make maintainer-clean' target, but that is intended mainly 300 for the package's developers. If you use it, you may have to get 301 all sorts of other programs in order to regenerate files that came 302 with the distribution. 303 304Compilers and Options 305===================== 306 307 Some systems require unusual options for compilation or linking that 308the `configure' script does not know about. You can give `configure' 309initial values for variables by setting them in the environment. Using 310a Bourne-compatible shell, you can do that on the command line like 311this: 312 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure 313 314Or on systems that have the `env' program, you can do it like this: 315 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure 316 317Compiling For Multiple Architectures 318==================================== 319 320 You can compile the package for more than one kind of computer at the 321same time, by placing the object files for each architecture in their 322own directory. To do this, you must use a version of `make' that 323supports the `VPATH' variable, such as GNU `make'. `cd' to the 324directory where you want the object files and executables to go and run 325the `configure' script. `configure' automatically checks for the 326source code in the directory that `configure' is in and in `..'. 327 328 If you have to use a `make' that does not supports the `VPATH' 329variable, you have to compile the package for one architecture at a time 330in the source code directory. After you have installed the package for 331one architecture, use `make distclean' before reconfiguring for another 332architecture. 333 334Installation Names 335================== 336 337 By default, `make install' will install the package's files in 338`/usr/local/bin', `/usr/local/man', etc. You can specify an 339installation prefix other than `/usr/local' by giving `configure' the 340option `--prefix=PATH'. 341 342 You can specify separate installation prefixes for 343architecture-specific files and architecture-independent files. If you 344give `configure' the option `--exec-prefix=PATH', the package will use 345PATH as the prefix for installing programs and libraries. 346Documentation and other data files will still use the regular prefix. 347 348 In addition, if you use an unusual directory layout you can give 349options like `--bindir=PATH' to specify different values for particular 350kinds of files. Run `configure --help' for a list of the directories 351you can set and what kinds of files go in them. 352 353 If the package supports it, you can cause programs to be installed 354with an extra prefix or suffix on their names by giving `configure' the 355option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 356 357Optional Features 358================= 359 360 Some packages pay attention to `--enable-FEATURE' options to 361`configure', where FEATURE indicates an optional part of the package. 362They may also pay attention to `--with-PACKAGE' options, where PACKAGE 363is something like `gnu-as' or `x' (for the X Window System). The 364`README' should mention any `--enable-' and `--with-' options that the 365package recognizes. 366 367 For packages that use the X Window System, `configure' can usually 368find the X include and library files automatically, but if it doesn't, 369you can use the `configure' options `--x-includes=DIR' and 370`--x-libraries=DIR' to specify their locations. 371 372Specifying the System Type 373========================== 374 375 There may be some features `configure' can not figure out 376automatically, but needs to determine by the type of host the package 377will run on. Usually `configure' can figure that out, but if it prints 378a message saying it can not guess the host type, give it the 379`--host=TYPE' option. TYPE can either be a short name for the system 380type, such as `sun4', or a canonical name with three fields: 381 CPU-COMPANY-SYSTEM 382 383See the file `config.sub' for the possible values of each field. If 384`config.sub' isn't included in this package, then this package doesn't 385need to know the host type. 386 387 If you are building compiler tools for cross-compiling, you can also 388use the `--target=TYPE' option to select the type of system they will 389produce code for and the `--build=TYPE' option to select the type of 390system on which you are compiling the package. 391 392Sharing Defaults 393================ 394 395 If you want to set default values for `configure' scripts to share, 396you can create a site shell script called `config.site' that gives 397default values for variables like `CC', `cache_file', and `prefix'. 398`configure' looks for `PREFIX/share/config.site' if it exists, then 399`PREFIX/etc/config.site' if it exists. Or, you can set the 400`CONFIG_SITE' environment variable to the location of the site script. 401A warning: not all `configure' scripts look for a site script. 402 403Operation Controls 404================== 405 406 `configure' recognizes the following options to control how it 407operates. 408 409`--cache-file=FILE' 410 Use and save the results of the tests in FILE instead of 411 `./config.cache'. Set FILE to `/dev/null' to disable caching, for 412 debugging `configure'. 413 414`--help' 415 Print a summary of the options to `configure', and exit. 416 417`--quiet' 418`--silent' 419`-q' 420 Do not print messages saying which checks are being made. To 421 suppress all normal output, redirect it to `/dev/null' (any error 422 messages will still be shown). 423 424`--srcdir=DIR' 425 Look for the package's source code in directory DIR. Usually 426 `configure' can determine that directory automatically. 427 428`--version' 429 Print the version of Autoconf used to generate the `configure' 430 script, and exit. 431 432`configure' also accepts some other, not widely useful, options. 433