diff --git a/doc/gui_macvim.txt b/doc/gui_macvim.txt index 96e989c7bc..b0827fcb15 100644 --- a/doc/gui_macvim.txt +++ b/doc/gui_macvim.txt @@ -25,11 +25,11 @@ Other relevant documentation: One of the goals of MacVim is to make Vim behave like a proper Mac OS X application. For this reason MacVim behaves slightly different from other GUI -ports. Most of the modifications are provided in the system gvimrc file; you -can quickly open this file and look at it yourself by typing: > +ports of Vim. Most of the modifications are provided in the system gvimrc +file; you can quickly open this file and look at it yourself by typing: > :tabe $VIM/gvimrc Note that this file will be overwritten each time you update MacVim, so it is -better (where possible) to keep your own modifications inside "~/.gvimrc". +better to keep your own modifications inside "~/.gvimrc". *macvim-windows* There is some confusion regarding the term "window" in MacVim since it means @@ -69,20 +69,23 @@ and want to contribute to MacVim you could do so by making the menus better. ============================================================================== 2. Starting MacVim *gui-macvim-start* -MacVim can be started from Terminal or by double clicking its icon in the -Finder. If you use the Dock then you might want to drag the MacVim icon to -the Dock so that you have easy access to it. MacVim automatically registers -itself as an editor of several standard file formats. This enables you to -double-click a file to open it with MacVim (if it is not associated with -another program), or to right-click a file to bring up the "Open with" menu. -You can also drag and drop files onto the Dock icon to open them in tabs in a -new window, or you can drop them in an already open window to open the files -in tabs in that specific window. Finally, you can use Mac OS X System -Services to open files in MacVim, see |macvim-services|. +The easiest way to start MacVim is by double-clicking its icon in the Finder, +but most users will probably prefer to use the Terminal. First some Finder +related ways of starting MacVim are described, then Terminal is discussed. +Note that you can put MacVim anywhere on your hard drive, but in this help +file it is assumed that you have put it inside your /Applications folder. + +MacVim automatically registers itself as an editor of several standard file +formats. This enables you to double-click a file to open it with MacVim (if +it is not associated with another program), or to right-click a file to bring +up the "Open with" menu. You can also drag and drop files onto the Dock icon +to open them in tabs in a new window, or you can drop them in an already open +window to open the files in tabs in that specific window. Finally, you can +use Mac OS X System Services to open files in MacVim, see |macvim-services|. There are essentially two ways to start MacVim from Terminal: either call the Vim binary with the -g switch > - MacVim.app/Contents/MacOS/Vim -g file ... + /Applications/MacVim.app/Contents/MacOS/Vim -g file ... or use the "open" command (which is of limited use since it cannot be used to pass parameters to Vim) > open -a MacVim file ... @@ -90,7 +93,6 @@ pass parameters to Vim) > In order to save you from having to type the entire path every time you start MacVim, add the following alias to "~/.profile": > alias gvim='/Applications/MacVim.app/Contents/MacOS/Vim -g' -(This assumes that you have put MacVim.app in /Applications.) Once in terminal Vim it is possible to start MacVim by using the following command: @@ -109,20 +111,20 @@ lowercase. *SystemColors.plist* There are only a few system colors that can be accessed from Vim. These colors are defined in the dictionary "SystemColors.plist". This dictionary -stores (key, value) pairs where the key is the name of the color and the +stores (key, value) pairs where the key is the name of the color and the value is an NSColor selector name. The most useful system colors are: > MacSelectedTextBackgroundColor MacSecondarySelectedColor The former is the "Highlight Color" which can be changed in the "Appearance" -section of the System Preferences. The latter is the selection color used -when an application is not in focus. +section of the System Preferences. The latter is the selection color used by +a Cocoa application when it is not in focus. *Colors.plist* Apart from the system colors, it is also possible to use the colors listed in the dictionary "Colors.plist". The key in this dictionary is the name of the -color and the value is an RGB value on the for #rrggbb stored as an integer. +color and the value is an RGB value on the form #rrggbb stored as an integer. ============================================================================== 4. Menus *macvim-menus* @@ -145,7 +147,7 @@ command takes the name of an action message as its only parameter. (An action message is an Objective-C message with "void" return type and a single parameter of type "id".) For example, the "New Window" menu item on the "File" menu is created in the following manner: > - :an 10.290 File.New\ Window :action newVimWindow: + :an 10.290 File.New\ Window :action newWindow: Note 1: A menu item which is bound to ":action" will automatically be bound to that action in all modes (as if ":an" was used). It is not possible to bind @@ -172,9 +174,11 @@ These are the currently supported services: * New Tab Containing Selection: Opens a new tab in the topmost window and pastes the currently selected text in that tab. A new window will be opened if necessary. -* Open Selected File in Tab (Window): If the selected text represents a file +* Open Selected File in Tab: If the selected text represents a file name, then the corresponding file is opened in a new tab in the topmost - window (in a new window). + window. +* Open Selected File in Window: Same as the above, but always open in a new + window. ============================================================================== 6. Known bugs/missing features *macvim-todo* @@ -192,7 +196,7 @@ these are ones that are know and/or which were judged major. If you find new bugs then add a new issue at http://code.google.com/p/macvim/ or post your findings to the vim_mac mailing list. If you are missing feature X in MacVim then voice your opinion on the vim_mac mailing list; it might be -simple to implement, but unless somebody ask for a particular feature then +simple to implement, but unless somebody asks for a particular feature then there is little incentive to add it. ============================================================================== @@ -212,10 +216,14 @@ Solution: Use the |--remote-tab| switch. If you have several windows open you might have to specify which window you want the file to open in by using the |--servername| switch. The title of a window usually ends in something like "VIM" or "VIM3" --- this is the server name of that window. So to open a file -named "foobar.txt" in a window which ends in "VIM3" you would type: > +named "foobar.txt" in a window whose title ends in "VIM3" you would type (the +order of the arguments matters): > gvim --servername VIM3 --remote-tab foobar.txt For more information, consult the |client-server| manual page. +Scenario: Selection doesn't work the way you are used to. +Solution: See |macvim-shift-movement|. + Scenario: You can't find the information on MacVim you thought should be in this manual page. Solution: Post your question on the vim_mac mailing list and wait for an