xref: /vim-8.2.3635/src/INSTALLmac.txt (revision 56994d21)
1INSTALLmac.txt - Installation of Vim on Apple MacOS
2
3This file contains instructions for compiling Vim. If you already have an
4executable version of Vim, you don't need this.
5
6MacOS Classic is no longer supported.  If you really want it use Vim 6.4.
7Only '/' is supported as path separator.
8
9
10----------------------------------------------------------------------------
11Prerequisites
12----------------------------------------------------------------------------
13
14Make sure you've installed Xcode and CommandLineTools.  You can download Xcode
15from the Mac App Store, for free.
16
17To check for CommandLineTools open a terminal and do:
18
19	$ make --version
20
21If not installed yet a window pops up instructing you to install the developer
22tools.
23
24If you don't have the source yet, best is to use git (which you need to
25install first), see http://www.vim.org/git.php
26Or you can download and unpack the Unix tar archive, see
27   http://www.vim.org/download.php
28
29
30----------------------------------------------------------------------------
31Build and install the terminal version.
32----------------------------------------------------------------------------
33
34You can compile vim with the standard Unix routine:
35   cd vim/src
36   make
37   make test
38   sudo make install
39
40If you get an error "glibtool: command not found" search on stackoverflow for
41mac-osx-where-can-i-download-glibtool.
42
43With Homebrew, run:
44
45      brew install libtool
46
47To build libtool from source:
48
49    1. Download the source code from https://www.gnu.org/software/libtool/.
50
51    2. Run these commands from the root of the source code directory:
52
53           ./configure --program-prefix=g
54           make
55           sudo make install
56
57
58----------------------------------------------------------------------------
59Build and install the GUI version with X-Windows
60----------------------------------------------------------------------------
61
62First, install XQuartz, which you can download from https://www.xquartz.org.
63
64To tell configure to use a GUI you can edit the Makefile and uncomment these
65two lines (remove the # at the start of the line):
66
67    CONF_OPT_GUI = --enable-gui=athena
68    CONF_OPT_DARWIN = --disable-darwin
69
70Do "make distclean" to start with a clean slate.
71Then build as with the terminal version above.
72Instead of "athena" you can try "gtk2" but you probably need to install GTK
73first.
74
75
76----------------------------------------------------------------------------
77Notes
78----------------------------------------------------------------------------
79
80Mac-specific configure options are explained in the Makefile:
81	--disable-darwin
82	--with-mac-arch
83
84