blob: 0c01ef27dcbcc649f6010b44c8c0949836cf1ceb [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001INSTALL - 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. Macintosh
115. OS/2 (with EMX 0.9b)
126. Atari MiNT
13
14For OS/390 Unix see ../runtime/doc/os_390.txt
15For BeBox see ../runtime/doc/os_beos.txt.
16For Amiga see INSTALLami.txt
17For PC (MS-DOS, Windows NT, Windows 95) see INSTALLpc.txt
18For Macintosh see INSTALLmac.txt
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 Motif 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
90These configure arguments can be used to select which GUI to use:
Bram Moolenaar843ee412004-06-30 16:16:41 +000091--enable-gui= gtk, kde, motif, athena or auto
Bram Moolenaar071d4272004-06-13 20:20:40 +000092--disable-gtk-check
93--disable-motif-check
94--disable-athena-check
95
96--enable-gui defaults to "auto", so it will automatically look for a GUI (in
97the order of GTK, Motif, then Athena). If one is found, then is uses it and
98does not proceed to check any of the remaining ones. Otherwise, it moves on
99to the next one.
100
Bram Moolenaar843ee412004-06-30 16:16:41 +0000101--enable-{gtk,kde,motif,athena}-check all default to "yes", such that if
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102--enable-gui is "auto" (which it is by default), GTK, Motif, and Athena will
103be checked for. If you want to *exclude* a certain check, then you use
Bram Moolenaar843ee412004-06-30 16:16:41 +0000104--disable-{gtk,kde,motif,athena}-check.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105
106For example, if --enable-gui is set to "auto", but you don't want it look for
107Motif, you then also specify --disable-motif-check. This results in only
108checking for GTK and Athena.
109
110Lastly, if you know which one you want to use, then you can just do
Bram Moolenaar843ee412004-06-30 16:16:41 +0000111--enable-gui={gtk,kde,motif,athena}. So if you wanted to only use Motif, then
Bram Moolenaar071d4272004-06-13 20:20:40 +0000112you'd specify --enable-gui=motif. Once you specify what you want, the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000113--enable-{gtk,kde,motif,athena}-check options are ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114
115For compiling with the GTK+ GUI, you need a recent version of glib and gtk+.
116Configure checks for at least version 1.1.16, but below 2.0. An older versions
117is not selected automatically. If you want to use it anyway, run configure
118with "--disable-gtktest". GTK 2.0 doesn't work yet.
119GTK requires an ANSI C compiler. If you fail to compile Vim with GTK+ (it
120is the preferred choice), try selecting another one in the Makefile.
121If you are sure you have GTK installed, but for some reason configure says you
122do not, you may have left-over header files and/or library files from an older
123(and incompatible) version of GTK. if this is the case, please check
124auto/config.log for any error messages that may give you a hint as to what's
125happening.
126
Bram Moolenaar843ee412004-06-30 16:16:41 +0000127For KDE see INSTALLkde.txt.
128
129
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130Unix: COMPILING WITH MULTI-BYTE
131
132When you want to compile with the multi-byte features enabled, make sure you
133compile on a machine where the locale settings actually work. otherwise the
134configure tests may fail. You need to compile with "big" features:
135
136 ./configure --with-features=big
137
138Unix: COMPILING ON LINUX
139
140On Linux, when using -g to compile (which is default for gcc), the executable
141will probably be statically linked. If you don't want this, remove the -g
142option from CFLAGS.
143
144Unix: PUTTING vimrc IN /etc
145
146Some Linux distributions prefer to put the global vimrc file in /etc, and the
147Vim runtime files in /usr. This can be done with:
148 ./configure --prefix=/usr
149 make VIMRCLOC=/etc VIMRUNTIMEDIR=/usr/share/vim MAKE="make -e"
150
151Unix: COMPILING ON NeXT
152
153Add the "-posix" argument to the compiler by using one of these commands:
154 setenv CC 'cc -posix' (csh)
155 export CC='cc -posix' (sh)
156And run configure with "--disable-motif-check".
157
158
1593. RISC OS
160=============
161
162Much file renaming is needed before you can compile anything.
163You'll need UnixLib to link against, GCC and GNU make.
164
165I suggest you get the RISC OS binary distribution, which includes the
166Templates file and the loader.
167
168Try here: http://www.ecs.soton.ac.uk/~tal197
169
170Do
171 :help riscos
172
173within the editor for more information, or read the os_riscos.txt help file.
174
175
1764. Macintosh
177============
178
179Vim should work on the Macintosh, but I don't have a makefile for it.
180Work is being done to update the Macintosh port. It's a lot of work; don't
181expect it soon.
182
183
1845. 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 paul@wau.mis.ah.nl
206 (email valid up to at least September 1996, after that try
207 paul@wurtel.hobby.nl, paul@murphy.nl, or paulS@toecompst.nl).
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 vim_os2.txt for additional info on running Vim.
227
228
2296. Atari MiNT
230=============
231
232
233To compile Vim for MiNT you may either copy makefile.mint to Makefile or use
234the Unix Makefile adapted for the MiNT configuration.
235
236Now proceed as described in the Unix section.
237
238Prerequisites:
239
240You need a curses or termcap library that supports non-alphanumeric
241termcap names. If you don't have any, link with termlib.o.
242
243-----------------------------------------------------------------------------
244
245The rest of this file is based on the INSTALL file that comes with GNU
246autoconf 2.12. Not everything applies to Vim. Read Makefile too!
247
248
249Basic Installation
250==================
251
252 These are generic installation instructions.
253
254 The `configure' shell script attempts to guess correct values for
255various system-dependent variables used during compilation. It uses
256those values to create a `Makefile' in each directory of the package.
257It may also create one or more `.h' files containing system-dependent
258definitions. Finally, it creates a shell script `config.status' that
259you can run in the future to recreate the current configuration, a file
260`config.cache' that saves the results of its tests to speed up
261reconfiguring, and a file `config.log' containing compiler output
262(useful mainly for debugging `configure').
263
264 If you need to do unusual things to compile the package, please try
265to figure out how `configure' could check whether to do them, and mail
266diffs or instructions to the address given in the `README' so they can
267be considered for the next release. If at some point `config.cache'
268contains results you don't want to keep, you may remove or edit it.
269
270 The file `configure.in' is used to create `configure' by a program
271called `autoconf'. You only need `configure.in' if you want to change
272it or regenerate `configure' using a newer version of `autoconf'.
273
274The simplest way to compile this package is:
275
276 1. `cd' to the directory containing the package's source code and type
277 `./configure' to configure the package for your system. If you're
278 using `csh' on an old version of System V, you might need to type
279 `sh ./configure' instead to prevent `csh' from trying to execute
280 `configure' itself.
281
282 Running `configure' takes awhile. While running, it prints some
283 messages telling which features it is checking for.
284
285 2. Type `make' to compile the package.
286
287 3. Optionally, type `make check' to run any self-tests that come with
288 the package.
289
290 4. Type `make install' to install the programs and any data files and
291 documentation.
292
293 5. You can remove the program binaries and object files from the
294 source code directory by typing `make clean'. To also remove the
295 files that `configure' created (so you can compile the package for
296 a different kind of computer), type `make distclean'. There is
297 also a `make maintainer-clean' target, but that is intended mainly
298 for the package's developers. If you use it, you may have to get
299 all sorts of other programs in order to regenerate files that came
300 with the distribution.
301
302Compilers and Options
303=====================
304
305 Some systems require unusual options for compilation or linking that
306the `configure' script does not know about. You can give `configure'
307initial values for variables by setting them in the environment. Using
308a Bourne-compatible shell, you can do that on the command line like
309this:
310 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
311
312Or on systems that have the `env' program, you can do it like this:
313 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
314
315Compiling For Multiple Architectures
316====================================
317
318 You can compile the package for more than one kind of computer at the
319same time, by placing the object files for each architecture in their
320own directory. To do this, you must use a version of `make' that
321supports the `VPATH' variable, such as GNU `make'. `cd' to the
322directory where you want the object files and executables to go and run
323the `configure' script. `configure' automatically checks for the
324source code in the directory that `configure' is in and in `..'.
325
326 If you have to use a `make' that does not supports the `VPATH'
327variable, you have to compile the package for one architecture at a time
328in the source code directory. After you have installed the package for
329one architecture, use `make distclean' before reconfiguring for another
330architecture.
331
332Installation Names
333==================
334
335 By default, `make install' will install the package's files in
336`/usr/local/bin', `/usr/local/man', etc. You can specify an
337installation prefix other than `/usr/local' by giving `configure' the
338option `--prefix=PATH'.
339
340 You can specify separate installation prefixes for
341architecture-specific files and architecture-independent files. If you
342give `configure' the option `--exec-prefix=PATH', the package will use
343PATH as the prefix for installing programs and libraries.
344Documentation and other data files will still use the regular prefix.
345
346 In addition, if you use an unusual directory layout you can give
347options like `--bindir=PATH' to specify different values for particular
348kinds of files. Run `configure --help' for a list of the directories
349you can set and what kinds of files go in them.
350
351 If the package supports it, you can cause programs to be installed
352with an extra prefix or suffix on their names by giving `configure' the
353option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
354
355Optional Features
356=================
357
358 Some packages pay attention to `--enable-FEATURE' options to
359`configure', where FEATURE indicates an optional part of the package.
360They may also pay attention to `--with-PACKAGE' options, where PACKAGE
361is something like `gnu-as' or `x' (for the X Window System). The
362`README' should mention any `--enable-' and `--with-' options that the
363package recognizes.
364
365 For packages that use the X Window System, `configure' can usually
366find the X include and library files automatically, but if it doesn't,
367you can use the `configure' options `--x-includes=DIR' and
368`--x-libraries=DIR' to specify their locations.
369
370Specifying the System Type
371==========================
372
373 There may be some features `configure' can not figure out
374automatically, but needs to determine by the type of host the package
375will run on. Usually `configure' can figure that out, but if it prints
376a message saying it can not guess the host type, give it the
377`--host=TYPE' option. TYPE can either be a short name for the system
378type, such as `sun4', or a canonical name with three fields:
379 CPU-COMPANY-SYSTEM
380
381See the file `config.sub' for the possible values of each field. If
382`config.sub' isn't included in this package, then this package doesn't
383need to know the host type.
384
385 If you are building compiler tools for cross-compiling, you can also
386use the `--target=TYPE' option to select the type of system they will
387produce code for and the `--build=TYPE' option to select the type of
388system on which you are compiling the package.
389
390Sharing Defaults
391================
392
393 If you want to set default values for `configure' scripts to share,
394you can create a site shell script called `config.site' that gives
395default values for variables like `CC', `cache_file', and `prefix'.
396`configure' looks for `PREFIX/share/config.site' if it exists, then
397`PREFIX/etc/config.site' if it exists. Or, you can set the
398`CONFIG_SITE' environment variable to the location of the site script.
399A warning: not all `configure' scripts look for a site script.
400
401Operation Controls
402==================
403
404 `configure' recognizes the following options to control how it
405operates.
406
407`--cache-file=FILE'
408 Use and save the results of the tests in FILE instead of
409 `./config.cache'. Set FILE to `/dev/null' to disable caching, for
410 debugging `configure'.
411
412`--help'
413 Print a summary of the options to `configure', and exit.
414
415`--quiet'
416`--silent'
417`-q'
418 Do not print messages saying which checks are being made. To
419 suppress all normal output, redirect it to `/dev/null' (any error
420 messages will still be shown).
421
422`--srcdir=DIR'
423 Look for the package's source code in directory DIR. Usually
424 `configure' can determine that directory automatically.
425
426`--version'
427 Print the version of Autoconf used to generate the `configure'
428 script, and exit.
429
430`configure' also accepts some other, not widely useful, options.