Merged from the latest developing branch.
[MacVim.git] / runtime / doc / os_mac.txt
blob1b69078efb511ba0e6d883f4ee2ac9625c3bcda7
1 *os_mac.txt*    For Vim version 7.2.  Last change: 2006 Apr 30
4                   VIM REFERENCE MANUAL    by Bram Moolenaar et al.
7                                         *mac* *Mac* *macintosh* *Macintosh*
9 This file documents the particularities of the Macintosh version of Vim.
11 NOTE: This file is a bit outdated.  You might find more useful info here:
12         http://macvim.org/
14 1. Filename Convention          |mac-filename|
15 2. .vimrc an .vim files         |mac-vimfile|
16 3. FAQ                          |mac-faq|
17 4. Known Lack                   |mac-lack|
18 5. Mac Bug Report               |mac-bug|
19 6. Compiling Vim                |mac-compile|
21 There was a Mac port for version 3.0 of Vim.  Here are the first few lines
22 from the old file:
24 VIM Release Notes
25 Initial Macintosh release, VIM version 3.0
26 19 October 1994
28 Eric Fischer
29 <enf1@midway.uchicago.edu>, <eric@jcp.uchicago.edu>, <etaoin@uchicago.edu>
30 5759 N. Guilford Ave
31 Indianapolis IN 46220 USA
33 ==============================================================================
34 1. Filename Convention                                  *mac-filename*
36 Starting with Vim version 7 you can just use the unix path separators with
37 Vim. In order to determine if the specified filename is relative to the
38 current folder or absolute (i.e. relative to the "Desktop"), the following
39 algorithm is used:
41         If the path start by a "/", the path is absolute
42         If the path start by a ":", the path is relative
43         If the path doesn't start by neither a "/" nor ":",
44           and a ":" is found before a "/" then the path is absolute
46                 :e /HD/text
47                 :e HD:text
48 <       Edit the file "text" of the disk "HD" >
49                 :e :src:main.c
50                 :e src/main.c
51 <       Edit the file "main.c" in the folder "src" in the current folder >
52                 :e os_mac.c
53 <       Edit the file "os_mac.c" in the current folder.
55 You can use the |$VIM| and |$VIMRUNTIME|  variable. >
57                 :so $VIMRUNTIME:syntax:syntax.vim
59 ==============================================================================
60 2. .vimrc and .vim files                                *mac-vimfile*
62 It is recommended to use Unix style line separators for Vim scripts, thus a
63 single newline character.
65 When starting up Vim will load the $VIMRUNTIME/macmap.vim script to define
66 default command-key mappings.
68 On older systems files starting with a dot "." are discouraged, thus the rc
69 files are named "vimrc" or "_vimrc" and "gvimrc" or "_gvimrc".  These files
70 can be in any format (mac, dos or unix).  Vim can handle any file format when
71 the |'nocompatible'| option is set, otherwise it will only handle mac format
72 files.
74 ==============================================================================
75 3. Mac FAQ                                              *mac-faq*
77 On the internet:  http://macvim.org/OSX/index.php#FAQ
79 Q: I can't enter non-ASCII character in Apple Terminal.
80 A: Under Window Settings, Emulation, make sure that "Escape non-ASCII
81    characters" is not checked.
83 Q: How do I start the GUI from the command line?
84 A: Assuming that Vim.app is located in /Applications:
85         open /Applications/Vim.app
86    Or:
87         /Applications/Vim.app/Contents/MacOS/Vim -g  {arguments}
89 Q: How can I set $PATH to something reasonable when I start Vim.app from the
90    GUI or with open?
91 A: The following trick works with most shells.  Put it in your vimrc file.
92    This is included in the system vimrc file included with the binaries
93    distributed at macvim.org . >
94         let s:path = system("echo echo VIMPATH'${PATH}' | $SHELL -l")
95         let $PATH = matchstr(s:path, 'VIMPATH\zs.\{-}\ze\n')
97 ==============================================================================
98 4. Mac Lack                                             *mac-lack*
100 In a terminal CTRL-^ needs to be entered as Shift-Control-6.  CTRL-@ as
101 Shift-Control-2.
103 ==============================================================================
104 5. Mac Bug Report                                       *mac-bug*
106 When reporting any Mac specific bug or feature change, please use the vim-mac
107 maillist |vim-mac|.  However, you need to be subscribed.  An alternative is to
108 send a message to the current MacVim maintainers:
110         mac@vim.org
112 ==============================================================================
113 6. Compiling Vim                                        *mac-compile*
115 See the file "src/INSTALLmac.txt" that comes with the source files.
118  vim:tw=78:ts=8:ft=help:norl: