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