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