Mercurial > vim
annotate src/INSTALL @ 18478:94223687df0e
Added tag v8.1.2233 for changeset e93cab5d0f0f27fad7882f1f412927df055b090d
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Tue, 29 Oct 2019 04:30:05 +0100 |
| parents | 6e4e0d43b20b |
| children | 22f0dda71638 |
| 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 | |
| 2834 | 9 3. OS/2 (with EMX 0.9b) |
| 10 4. Atari MiNT | |
| 7 | 11 |
| 1268 | 12 See INSTALLami.txt for Amiga |
| 13 See INSTALLmac.txt for Macintosh | |
|
15034
6e4e0d43b20b
patch 8.1.0528: various typos in comments
Bram Moolenaar <Bram@vim.org>
parents:
10375
diff
changeset
|
14 See INSTALLpc.txt for PC (Windows XP/Vista/7/8/10) |
| 1268 | 15 See INSTALLvms.txt for VMS |
| 1622 | 16 See INSTALLx.txt for cross-compiling on Unix |
|
15034
6e4e0d43b20b
patch 8.1.0528: various typos in comments
Bram Moolenaar <Bram@vim.org>
parents:
10375
diff
changeset
|
17 See ../READMEdir/README_390.txt for z/OS and OS/390 Unix |
| 1268 | 18 See ../runtime/doc/os_beos.txt for BeBox |
| 7 | 19 |
| 20 | |
| 21 1. Generic | |
| 22 ========== | |
| 23 | |
| 24 If you compile Vim without specifying anything, you will get the default | |
| 25 behaviour as is documented, which should be fine for most people. | |
| 26 | |
| 27 For features that you can't enable/disable in another way, you can edit the | |
| 28 file "feature.h" to match your preferences. | |
| 29 | |
| 30 | |
| 31 2. Unix | |
| 32 ======= | |
| 33 | |
| 34 Summary: | |
| 35 1. make run configure, compile and link | |
| 36 2. make install installation in /usr/local | |
| 37 | |
| 38 This will include the GUI and X11 libraries, if you have them. If you want a | |
| 39 version of Vim that is small and starts up quickly, see the Makefile for how | |
| 1268 | 40 to disable the GUI and X11. If you don't have GUI libraries and/or X11, these |
| 7 | 41 features will be disabled automatically. |
| 42 | |
| 43 See the start of Makefile for more detailed instructions about how to compile | |
| 44 Vim. | |
| 45 | |
| 46 If you need extra compiler and/or linker arguments, set $CFLAGS and/or $LIBS | |
| 47 before starting configure. Example: | |
| 48 | |
| 49 env CFLAGS=-I/usr/local/include LIBS=-lm make | |
| 50 | |
| 51 This is only needed for things that configure doesn't offer a specific argument | |
| 52 for or figures out by itself. First try running configure without extra | |
| 53 arguments. | |
| 54 | |
| 55 GNU Autoconf and a few other tools have been used to make Vim work on many | |
| 56 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
|
57 on most systems without any adjustments. The disadvantage is that when |
| 7 | 58 adjustments are required, it takes some time to understand what is happening. |
| 59 | |
| 60 If configure finds all library files and then complains when linking that some | |
| 61 of them can't be found, your linker doesn't return an error code for missing | |
| 62 libraries. Vim should be linked fine anyway, mostly you can just ignore these | |
| 63 errors. | |
| 64 | |
| 65 If you run configure by hand (not using the Makefile), remember that any | |
| 66 changes in the Makefile have no influence on configure. This may be what you | |
| 67 want, but maybe not! | |
| 68 | |
| 69 The advantage of running configure separately, is that you can write a script | |
| 70 to build Vim, without changing the Makefile or feature.h. Example (using sh): | |
| 71 | |
| 72 CFLAGS=-DCOMPILER_FLAG ./configure --enable-gui=motif | |
| 73 | |
| 74 One 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 | |
| 76 run configure again. | |
| 77 | |
| 78 If 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 | |
| 85 that "make shadow" creates won't work.] | |
| 86 | |
| 87 | |
| 88 Unix: COMPILING WITH/WITHOUT GUI | |
| 89 | |
| 1268 | 90 NOTE: This is incomplete, look in Makefile for more info. |
| 91 | |
| 7 | 92 These configure arguments can be used to select which GUI to use: |
| 1268 | 93 --enable-gui=gtk or: gtk2, motif, athena or auto |
| 7 | 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 | |
| 99 the order of GTK, Motif, then Athena). If one is found, then is uses it and | |
| 100 does not proceed to check any of the remaining ones. Otherwise, it moves on | |
| 101 to the next one. | |
| 102 | |
| 1268 | 103 --enable-{gtk,gtk2,kde,motif,athena}-check all default to "yes", such that if |
| 7 | 104 --enable-gui is "auto" (which it is by default), GTK, Motif, and Athena will |
| 105 be checked for. If you want to *exclude* a certain check, then you use | |
| 1268 | 106 --disable-{gtk,gtk2,kde,motif,athena}-check. |
| 7 | 107 |
| 108 For example, if --enable-gui is set to "auto", but you don't want it look for | |
| 109 Motif, you then also specify --disable-motif-check. This results in only | |
| 110 checking for GTK and Athena. | |
| 111 | |
| 112 Lastly, if you know which one you want to use, then you can just do | |
| 1268 | 113 --enable-gui={gtk,gtk2,kde,motif,athena}. So if you wanted to only use Motif, |
| 114 then 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 | |
| 117 On Linux you usually need GUI "-devel" packages. You may already have GTK | |
| 118 libraries installed, but that doesn't mean you can compile Vim with GTK, you | |
| 119 also need the header files. | |
| 7 | 120 |
| 121 For compiling with the GTK+ GUI, you need a recent version of glib and gtk+. | |
| 1268 | 122 Configure checks for at least version 1.1.16. An older version is not selected |
| 123 automatically. If you want to use it anyway, run configure with | |
| 124 "--disable-gtktest". | |
| 7 | 125 GTK requires an ANSI C compiler. If you fail to compile Vim with GTK+ (it |
| 126 is the preferred choice), try selecting another one in the Makefile. | |
| 127 If you are sure you have GTK installed, but for some reason configure says you | |
| 128 do 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 | |
| 130 auto/config.log for any error messages that may give you a hint as to what's | |
| 131 happening. | |
| 132 | |
| 1268 | 133 There used to be a KDE version of Vim, using Qt libraries, but since it didn't |
| 134 work very well and there was no maintainer it was dropped. | |
| 11 | 135 |
| 136 | |
| 7 | 137 Unix: COMPILING WITH MULTI-BYTE |
| 138 | |
| 139 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
|
140 compile on a machine where the locale settings actually work, otherwise the |
| 7 | 141 configure tests may fail. You need to compile with "big" features: |
| 142 | |
| 143 ./configure --with-features=big | |
| 144 | |
| 145 Unix: COMPILING ON LINUX | |
| 146 | |
| 147 On Linux, when using -g to compile (which is default for gcc), the executable | |
| 148 will probably be statically linked. If you don't want this, remove the -g | |
| 149 option from CFLAGS. | |
| 150 | |
| 151 Unix: PUTTING vimrc IN /etc | |
| 152 | |
| 153 Some Linux distributions prefer to put the global vimrc file in /etc, and the | |
| 154 Vim 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 | |
| 158 Unix: COMPILING ON NeXT | |
| 159 | |
| 160 Add the "-posix" argument to the compiler by using one of these commands: | |
| 161 setenv CC 'cc -posix' (csh) | |
| 162 export CC='cc -posix' (sh) | |
| 163 And run configure with "--disable-motif-check". | |
| 164 | |
| 1668 | 165 Unix: LOCAL HEADERS AND LIBRARIES NOT IN /usr/local |
| 166 | |
| 167 Sometimes it is necessary to search different path than /usr/local for locally | |
| 168 installed headers (/usr/local/include) and libraries (/usr/local/lib). | |
| 169 To search /stranger/include and /stranger/lib for locally installed | |
| 170 headers and libraries, use: | |
| 171 ./configure --with-local-dir=/stranger | |
| 172 And to not search for locally installed headers and libraries at all, use: | |
| 173 ./configure --without-local-dir | |
| 174 | |
| 7 | 175 |
| 2834 | 176 3. OS/2 |
| 7 | 177 ======= |
| 178 | |
|
7408
1886f2863437
commit https://github.com/vim/vim/commit/e7fedb6ebe72d9a475aa65109b77d5ed4667067a
Christian Brabandt <cb@256bit.org>
parents:
6448
diff
changeset
|
179 OS/2 support was removed in patch 7.4.1008 |
| 7 | 180 |
| 181 | |
| 2834 | 182 4. Atari MiNT |
| 7 | 183 ============= |
| 184 | |
| 1268 | 185 [NOTE: this is quite old, it might not work anymore] |
| 7 | 186 |
| 1268 | 187 To compile Vim for MiNT you may either copy Make_mint.mak to Makefile or use |
| 7 | 188 the Unix Makefile adapted for the MiNT configuration. |
| 189 | |
| 190 Now proceed as described in the Unix section. | |
| 191 | |
| 192 Prerequisites: | |
| 193 | |
| 194 You need a curses or termcap library that supports non-alphanumeric | |
| 195 termcap names. If you don't have any, link with termlib.o. | |
| 196 | |
| 197 ----------------------------------------------------------------------------- | |
| 198 | |
| 199 The rest of this file is based on the INSTALL file that comes with GNU | |
| 200 autoconf 2.12. Not everything applies to Vim. Read Makefile too! | |
| 201 | |
| 202 | |
| 203 Basic Installation | |
| 204 ================== | |
| 205 | |
| 206 These are generic installation instructions. | |
| 207 | |
| 208 The `configure' shell script attempts to guess correct values for | |
| 209 various system-dependent variables used during compilation. It uses | |
| 210 those values to create a `Makefile' in each directory of the package. | |
| 211 It may also create one or more `.h' files containing system-dependent | |
| 212 definitions. Finally, it creates a shell script `config.status' that | |
| 213 you can run in the future to recreate the current configuration, a file | |
| 214 `config.cache' that saves the results of its tests to speed up | |
| 215 reconfiguring, and a file `config.log' containing compiler output | |
| 216 (useful mainly for debugging `configure'). | |
| 217 | |
| 218 If you need to do unusual things to compile the package, please try | |
| 219 to figure out how `configure' could check whether to do them, and mail | |
| 220 diffs or instructions to the address given in the `README' so they can | |
| 221 be considered for the next release. If at some point `config.cache' | |
| 222 contains results you don't want to keep, you may remove or edit it. | |
| 223 | |
|
10375
2055d3722c5b
commit https://github.com/vim/vim/commit/3f7d0907269558cb3ea184a3083640f9e20bb21e
Christian Brabandt <cb@256bit.org>
parents:
9228
diff
changeset
|
224 The file `configure.ac' is used to create `configure' by a program |
|
2055d3722c5b
commit https://github.com/vim/vim/commit/3f7d0907269558cb3ea184a3083640f9e20bb21e
Christian Brabandt <cb@256bit.org>
parents:
9228
diff
changeset
|
225 called `autoconf'. You only need `configure.ac' if you want to change |
| 7 | 226 it or regenerate `configure' using a newer version of `autoconf'. |
| 227 | |
| 228 The simplest way to compile this package is: | |
| 229 | |
| 230 1. `cd' to the directory containing the package's source code and type | |
| 231 `./configure' to configure the package for your system. If you're | |
| 232 using `csh' on an old version of System V, you might need to type | |
| 233 `sh ./configure' instead to prevent `csh' from trying to execute | |
| 234 `configure' itself. | |
| 235 | |
| 236 Running `configure' takes awhile. While running, it prints some | |
| 237 messages telling which features it is checking for. | |
| 238 | |
| 239 2. Type `make' to compile the package. | |
| 240 | |
| 241 3. Optionally, type `make check' to run any self-tests that come with | |
| 242 the package. | |
| 243 | |
| 244 4. Type `make install' to install the programs and any data files and | |
| 245 documentation. | |
| 246 | |
| 247 5. You can remove the program binaries and object files from the | |
| 248 source code directory by typing `make clean'. To also remove the | |
| 249 files that `configure' created (so you can compile the package for | |
| 250 a different kind of computer), type `make distclean'. There is | |
| 251 also a `make maintainer-clean' target, but that is intended mainly | |
| 252 for the package's developers. If you use it, you may have to get | |
| 253 all sorts of other programs in order to regenerate files that came | |
| 254 with the distribution. | |
| 255 | |
| 256 Compilers and Options | |
| 257 ===================== | |
| 258 | |
| 259 Some systems require unusual options for compilation or linking that | |
| 260 the `configure' script does not know about. You can give `configure' | |
| 261 initial values for variables by setting them in the environment. Using | |
| 262 a Bourne-compatible shell, you can do that on the command line like | |
| 263 this: | |
| 264 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure | |
| 265 | |
| 266 Or on systems that have the `env' program, you can do it like this: | |
| 267 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure | |
| 268 | |
| 269 Compiling For Multiple Architectures | |
| 270 ==================================== | |
| 271 | |
| 272 You can compile the package for more than one kind of computer at the | |
| 273 same time, by placing the object files for each architecture in their | |
| 274 own directory. To do this, you must use a version of `make' that | |
| 275 supports the `VPATH' variable, such as GNU `make'. `cd' to the | |
| 276 directory where you want the object files and executables to go and run | |
| 277 the `configure' script. `configure' automatically checks for the | |
| 278 source code in the directory that `configure' is in and in `..'. | |
| 279 | |
| 6448 | 280 If you have to use a `make' that does not support the `VPATH' |
| 7 | 281 variable, you have to compile the package for one architecture at a time |
| 282 in the source code directory. After you have installed the package for | |
| 283 one architecture, use `make distclean' before reconfiguring for another | |
| 284 architecture. | |
| 285 | |
| 286 Installation Names | |
| 287 ================== | |
| 288 | |
| 289 By default, `make install' will install the package's files in | |
| 290 `/usr/local/bin', `/usr/local/man', etc. You can specify an | |
| 291 installation prefix other than `/usr/local' by giving `configure' the | |
| 292 option `--prefix=PATH'. | |
| 293 | |
| 294 You can specify separate installation prefixes for | |
| 295 architecture-specific files and architecture-independent files. If you | |
| 296 give `configure' the option `--exec-prefix=PATH', the package will use | |
| 297 PATH as the prefix for installing programs and libraries. | |
| 298 Documentation and other data files will still use the regular prefix. | |
| 299 | |
| 300 In addition, if you use an unusual directory layout you can give | |
| 301 options like `--bindir=PATH' to specify different values for particular | |
| 302 kinds of files. Run `configure --help' for a list of the directories | |
| 303 you can set and what kinds of files go in them. | |
| 304 | |
| 305 If the package supports it, you can cause programs to be installed | |
| 306 with an extra prefix or suffix on their names by giving `configure' the | |
| 307 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. | |
| 308 | |
| 309 Optional Features | |
| 310 ================= | |
| 311 | |
| 312 Some packages pay attention to `--enable-FEATURE' options to | |
| 313 `configure', where FEATURE indicates an optional part of the package. | |
| 314 They may also pay attention to `--with-PACKAGE' options, where PACKAGE | |
| 315 is something like `gnu-as' or `x' (for the X Window System). The | |
| 316 `README' should mention any `--enable-' and `--with-' options that the | |
| 317 package recognizes. | |
| 318 | |
| 319 For packages that use the X Window System, `configure' can usually | |
| 320 find the X include and library files automatically, but if it doesn't, | |
| 321 you can use the `configure' options `--x-includes=DIR' and | |
| 322 `--x-libraries=DIR' to specify their locations. | |
| 323 | |
| 324 Specifying the System Type | |
| 325 ========================== | |
| 326 | |
| 327 There may be some features `configure' can not figure out | |
| 328 automatically, but needs to determine by the type of host the package | |
| 329 will run on. Usually `configure' can figure that out, but if it prints | |
| 330 a message saying it can not guess the host type, give it the | |
| 331 `--host=TYPE' option. TYPE can either be a short name for the system | |
| 332 type, such as `sun4', or a canonical name with three fields: | |
| 333 CPU-COMPANY-SYSTEM | |
| 334 | |
| 335 See the file `config.sub' for the possible values of each field. If | |
| 336 `config.sub' isn't included in this package, then this package doesn't | |
| 337 need to know the host type. | |
| 338 | |
| 339 If you are building compiler tools for cross-compiling, you can also | |
| 340 use the `--target=TYPE' option to select the type of system they will | |
| 341 produce code for and the `--build=TYPE' option to select the type of | |
| 342 system on which you are compiling the package. | |
| 343 | |
| 344 Sharing Defaults | |
| 345 ================ | |
| 346 | |
| 347 If you want to set default values for `configure' scripts to share, | |
| 348 you can create a site shell script called `config.site' that gives | |
| 349 default values for variables like `CC', `cache_file', and `prefix'. | |
| 350 `configure' looks for `PREFIX/share/config.site' if it exists, then | |
| 351 `PREFIX/etc/config.site' if it exists. Or, you can set the | |
| 352 `CONFIG_SITE' environment variable to the location of the site script. | |
| 353 A warning: not all `configure' scripts look for a site script. | |
| 354 | |
| 355 Operation Controls | |
| 356 ================== | |
| 357 | |
| 358 `configure' recognizes the following options to control how it | |
| 359 operates. | |
| 360 | |
| 361 `--cache-file=FILE' | |
| 362 Use and save the results of the tests in FILE instead of | |
| 363 `./config.cache'. Set FILE to `/dev/null' to disable caching, for | |
| 364 debugging `configure'. | |
| 365 | |
| 366 `--help' | |
| 367 Print a summary of the options to `configure', and exit. | |
| 368 | |
| 369 `--quiet' | |
| 370 `--silent' | |
| 371 `-q' | |
| 372 Do not print messages saying which checks are being made. To | |
| 373 suppress all normal output, redirect it to `/dev/null' (any error | |
| 374 messages will still be shown). | |
| 375 | |
| 376 `--srcdir=DIR' | |
| 377 Look for the package's source code in directory DIR. Usually | |
| 378 `configure' can determine that directory automatically. | |
| 379 | |
| 380 `--version' | |
| 381 Print the version of Autoconf used to generate the `configure' | |
| 382 script, and exit. | |
| 383 | |
| 384 `configure' also accepts some other, not widely useful, options. |