Skip to content

Commit 6458d0b

Browse files
committed
Update mvim script document
1 parent 936eef5 commit 6458d0b

File tree

1 file changed

+19
-38
lines changed

1 file changed

+19
-38
lines changed

runtime/doc/gui_mac.txt

Lines changed: 19 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -158,55 +158,36 @@ have files open in e.g. splits by changing the "Open files from applications"
158158
option in the General preference pane). Finally, you can use Mac OS X System
159159
Services to open files in MacVim, see |macvim-services|.
160160

161-
There are essentially two ways to start MacVim from Terminal: either call the
162-
Vim binary with the -g switch >
163-
/Applications/MacVim.app/Contents/MacOS/Vim -g file ...
164-
or use the "open" command (this method can not be used to pass parameters to
161+
Use |mvim| script to start MacVim from Terminal.
162+
163+
Or use the "open" command (this method can not be used to pass parameters to
165164
Vim) >
166165
open -a MacVim file ...
167166
The advantage of using the latter method is that the settings relating to file
168167
opening in the preferences panel are respected, and files open instantly if
169168
|Quickstart| is enabled.
170169

171-
To save yourself from having to type the entire path to the Vim binary each
172-
time you start MacVim, you could create an alias such as >
173-
alias gvim='/Applications/MacVim.app/Contents/MacOS/Vim -g'
174-
and add that to "~/.profile".
175-
176-
Note: Do NOT call the MacVim binary inside the app bundle to start MacVim.
177-
178-
*mvim*
179-
A more flexible way to start MacVim is to use the shell script "mvim" which
180-
comes bundled with MacVim. Put this script in a folder in your path and then
181-
simply type "mvim" to start MacVim. This script will try to find MacVim.app
182-
in various typical folders such as >
183-
~/Applications ~/Applications/vim
184-
/Applications /Applications/vim
185-
/Applications/Utilities /Applications/Utilities/vim
186-
If you would rather put MacVim.app in some other directory then that is also
187-
possible, simply set the environment variable VIM_APP_DIR to whatever folder
188-
you have placed MacVim.app in.
189-
190-
The "mvim" script can be symlinked to in order to start up MacVim in different
191-
modes as follows (assuming you placed "mvim" in "/usr/local/bin"): >
192-
* Diff: ln -s /usr/local/bin/mvim mvimdiff
193-
* Read-only: ln -s /usr/local/bin/mvim mview
194-
* Ex: ln -s /usr/local/bin/mvim mex
195-
* Restricted: ln -s /usr/local/bin/mvim rmvim
196-
If the symlink destination starts with "m" (or "g"), Vim will start in GUI
197-
mode. Removing the initial "m" from the above destination names makes Vim
198-
start without the GUI. (In the last case, the destination name can be
199-
"rmvim", "rgvim" or "rvim".)
200-
201-
Note: Starting MacVim by creating a symlink to >
202-
.../MacVim.app/Contents/MacOS/Vim
203-
with 'ln -s' does not work.
204-
205170
Once in terminal Vim it is possible to start MacVim by using the following
206171
command:
207172
:gui [++opt] [+cmd] [-f|-b] [files...]
208173
Note: Forking ("-b") currently does not work.
209174

175+
*mvim*
176+
The "mvim" shell script bundled with MacVim. >
177+
/Applications/MacVim.app/Contents/bin/mvim
178+
This is a wrapper script to launch Vim executable in the bundle. Put this
179+
folder >
180+
/Applications/MacVim.app/Contents/bin
181+
in your path and then simply type "mvim" to start MacVim from Terminal. >
182+
$ mvim
183+
You can also specify files to open with. >
184+
$ mvim file ...
185+
Also the bin folder has convenient scripts for diffing and opening file as the file is read-only. >
186+
* Diff: mvimdiff
187+
* Read-only: mview
188+
189+
You can use "vim", "vimdiff", and "view" if you want to use non-GUI Vim.
190+
210191
*Quickstart*
211192
Quickstart ensures that new windows open instantaneously e.g. when <D-n> is
212193
pressed. This feature can be enabled from the Advanced preferences pane (it

0 commit comments

Comments
 (0)