| blob | 1ae54951cdf7c1c3af20bf8d94992920b63e8171 |
1 *gui.txt* For Vim version 7.4. Last change: 2013 Jun 12
4 VIM REFERENCE MANUAL by Bram Moolenaar
7 Vim's Graphical User Interface *gui* *GUI*
9 1. Starting the GUI |gui-start|
10 2. Scrollbars |gui-scrollbars|
11 3. Mouse Control |gui-mouse|
12 4. Making GUI Selections |gui-selections|
13 5. Menus |menus|
14 6. Extras |gui-extras|
15 7. Shell Commands |gui-shell|
17 Other GUI documentation:
18 |gui_x11.txt| For specific items of the X11 GUI.
19 |gui_w32.txt| For specific items of the Win32 GUI.
21 {Vi does not have any of these commands}
23 ==============================================================================
24 1. Starting the GUI *gui-start* *E229* *E233*
26 First you must make sure you actually have a version of Vim with the GUI code
27 included. You can check this with the ":version" command, it says "with xxx
28 GUI", where "xxx" is X11-Motif, X11-Athena, Photon, GTK, GTK2, etc., or
29 "MS-Windows 32 bit GUI version".
31 How to start the GUI depends on the system used. Mostly you can run the
32 GUI version of Vim with:
33 gvim [options] [files...]
35 The X11 version of Vim can run both in GUI and in non-GUI mode. See
36 |gui-x11-start|.
38 *gui-init* *gvimrc* *.gvimrc* *_gvimrc* *$MYGVIMRC*
39 The gvimrc file is where GUI-specific startup commands should be placed. It
40 is always sourced after the |vimrc| file. If you have one then the $MYGVIMRC
41 environment variable has its name.
43 When the GUI starts up initializations are carried out, in this order:
44 - The 'term' option is set to "builtin_gui" and terminal options are reset to
45 their default value for the GUI |terminal-options|.
46 - If the system menu file exists, it is sourced. The name of this file is
47 normally "$VIMRUNTIME/menu.vim". You can check this with ":version". Also
48 see |$VIMRUNTIME|. To skip loading the system menu include 'M' in
49 'guioptions'. *buffers-menu* *no_buffers_menu*
50 The system menu file includes a "Buffers" menu. If you don't want this, set
51 the "no_buffers_menu" variable in your .vimrc (not .gvimrc!): >
52 :let no_buffers_menu = 1
53 < NOTE: Switching on syntax highlighting also loads the menu file, thus
54 disabling the Buffers menu must be done before ":syntax on".
55 The path names are truncated to 35 characters. You can truncate them at a
56 different length, for example 50, like this: >
57 :let bmenu_max_pathlen = 50
58 - If the "-U {gvimrc}" command-line option has been used when starting Vim,
59 the {gvimrc} file will be read for initializations. The following
60 initializations are skipped. When {gvimrc} is "NONE" no file will be read
61 for initializations.
62 - For Unix and MS-Windows, if the system gvimrc exists, it is sourced. The
63 name of this file is normally "$VIM/gvimrc". You can check this with
64 ":version". Also see |$VIM|.
65 - The following are tried, and only the first one that exists is used:
66 - If the GVIMINIT environment variable exists and is not empty, it is
67 executed as an Ex command.
68 - If the user gvimrc file exists, it is sourced. The name of this file is
69 normally "$HOME/.gvimrc". You can check this with ":version".
70 - For Win32, when $HOME is not set, "$VIM\_gvimrc" is used.
71 - When a "_gvimrc" file is not found, ".gvimrc" is tried too. And vice
72 versa.
73 The name of the first file found is stored in $MYGVIMRC, unless it was
74 already set.
75 - If the 'exrc' option is set (which is NOT the default) the file ./.gvimrc
76 is sourced, if it exists and isn't the same file as the system or user
77 gvimrc file. If this file is not owned by you, some security restrictions
78 apply. When ".gvimrc" is not found, "_gvimrc" is tried too. For Macintosh
79 and DOS/Win32 "_gvimrc" is tried first.
81 NOTE: All but the first one are not carried out if Vim was started with
82 "-u NONE" and no "-U" argument was given, or when started with "-U NONE".
84 All this happens AFTER the normal Vim initializations, like reading your
85 .vimrc file. See |initialization|.
86 But the GUI window is only opened after all the initializations have been
87 carried out. If you want some commands to be executed just after opening the
88 GUI window, use the |GUIEnter| autocommand event. Example: >
89 :autocmd GUIEnter * winpos 100 50
91 You can use the gvimrc files to set up your own customized menus (see |:menu|)
92 and initialize other things that you may want to set up differently from the
93 terminal version.
95 Recommended place for your personal GUI initializations:
96 Unix $HOME/.gvimrc or $HOME/.vim/gvimrc
97 OS/2 $HOME/.gvimrc, $HOME/vimfiles/gvimrc
98 or $VIM/.gvimrc
99 MS-DOS and Win32 $HOME/_gvimrc, $HOME/vimfiles/gvimrc
100 or $VIM/_gvimrc
101 Amiga s:.gvimrc, home:.gvimrc, home:vimfiles:gvimrc
102 or $VIM/.gvimrc
104 The personal initialization files are searched in the order specified above
105 and only the first one that is found is read.
107 There are a number of options which only have meaning in the GUI version of
108 Vim. These are 'guicursor', 'guifont', 'guipty' and 'guioptions'. They are
109 documented in |options.txt| with all the other options.
111 If using the Motif or Athena version of the GUI (but not for the GTK+ or
112 Win32 version), a number of X resources are available. See |gui-resources|.
114 Another way to set the colors for different occasions is with highlight
115 groups. The "Normal" group is used to set the background and foreground
116 colors. Example (which looks nice): >
118 :highlight Normal guibg=grey90
120 The "guibg" and "guifg" settings override the normal background and
121 foreground settings. The other settings for the Normal highlight group are
122 not used. Use the 'guifont' option to set the font.
124 Also check out the 'guicursor' option, to set the colors for the cursor in
125 various modes.
127 Vim tries to make the window fit on the screen when it starts up. This avoids
128 that you can't see part of it. On the X Window System this requires a bit of
129 guesswork. You can change the height that is used for the window title and a
130 task bar with the 'guiheadroom' option.
132 *:winp* *:winpos* *E188*
133 :winp[os]
134 Display current position of the top left corner of the GUI vim
135 window in pixels. Does not work in all versions.
137 :winp[os] {X} {Y} *E466*
138 Put the GUI vim window at the given {X} and {Y} coordinates.
139 The coordinates should specify the position in pixels of the
140 top left corner of the window. Does not work in all versions.
141 Does work in an (new) xterm |xterm-color|.
142 When the GUI window has not been opened yet, the values are
143 remembered until the window is opened. The position is
144 adjusted to make the window fit on the screen (if possible).
146 *:win* *:winsize* *E465*
147 :win[size] {width} {height}
148 Set the window height to {width} by {height} characters.
149 Obsolete, use ":set lines=11 columns=22".
150 If you get less lines than expected, check the 'guiheadroom'
151 option.
153 If you are running the X Window System, you can get information about the
154 window Vim is running in with this command: >
155 :!xwininfo -id $WINDOWID
156 <
157 *gui-IME* *iBus*
158 Input methods for international characters in X that rely on the XIM
159 framework, most notably iBus, have been known to produce undesirable results
160 in gVim. These may include an inability to enter spaces, or long delays
161 between typing a character and it being recognized by the application.
163 One workaround that has been successful, for unknown reasons, is to prevent
164 gvim from forking into the background by starting it with the |-f| argument.
166 ==============================================================================
167 2. Scrollbars *gui-scrollbars*
169 There are vertical scrollbars and a horizontal scrollbar. You may
170 configure which ones appear with the 'guioptions' option.
172 The interface looks like this (with ":set guioptions=mlrb"):
174 +------------------------------+ `
175 | File Edit Help | <- Menu bar (m) `
176 +-+--------------------------+-+ `
177 |^| |^| `
178 |#| Text area. |#| `
179 | | | | `
180 |v|__________________________|v| `
181 Normal status line -> |-+ File.c 5,2 +-| `
182 between Vim windows |^|""""""""""""""""""""""""""|^| `
183 | | | | `
184 | | Another file buffer. | | `
185 | | | | `
186 |#| |#| `
187 Left scrollbar (l) -> |#| |#| <- Right `
188 |#| |#| scrollbar (r) `
189 | | | | `
190 |v| |v| `
191 +-+--------------------------+-+ `
192 | |< #### >| | <- Bottom `
193 +-+--------------------------+-+ scrollbar (b) `
195 Any of the scrollbar or menu components may be turned off by not putting the
196 appropriate letter in the 'guioptions' string. The bottom scrollbar is
197 only useful when 'nowrap' is set.
200 VERTICAL SCROLLBARS *gui-vert-scroll*
202 Each Vim window has a scrollbar next to it which may be scrolled up and down
203 to move through the text in that buffer. The size of the scrollbar-thumb
204 indicates the fraction of the buffer which can be seen in the window.
205 When the scrollbar is dragged all the way down, the last line of the file
206 will appear in the top of the window.
208 If a window is shrunk to zero height (by the growth of another window) its
209 scrollbar disappears. It reappears when the window is restored.
211 If a window is vertically split, it will get a scrollbar when it is the
212 current window and when, taking the middle of the current window and drawing a
213 vertical line, this line goes through the window.
214 When there are scrollbars on both sides, and the middle of the current window
215 is on the left half, the right scrollbar column will contain scrollbars for
216 the rightmost windows. The same happens on the other side.
219 HORIZONTAL SCROLLBARS *gui-horiz-scroll*
221 The horizontal scrollbar (at the bottom of the Vim GUI) may be used to
222 scroll text sideways when the 'wrap' option is turned off. The
223 scrollbar-thumb size is such that the text of the longest visible line may be
224 scrolled as far as possible left and right. The cursor is moved when
225 necessary, it must remain on a visible character (unless 'virtualedit' is
226 set).
228 Computing the length of the longest visible line takes quite a bit of
229 computation, and it has to be done every time something changes. If this
230 takes too much time or you don't like the cursor jumping to another line,
231 include the 'h' flag in 'guioptions'. Then the scrolling is limited by the
232 text of the current cursor line.
234 *athena-intellimouse*
235 If you have an Intellimouse and an X server that supports using the wheel,
236 then you can use the wheel to scroll the text up and down in gvim. This works
237 with XFree86 4.0 and later, and with some older versions when you add patches.
238 See |scroll-mouse-wheel|.
240 For older versions of XFree86 you must patch your X server. The following
241 page has a bit of information about using the Intellimouse on Linux as well as
242 links to the patches and X server binaries (may not have the one you need
243 though):
244 http://www.inria.fr/koala/colas/mouse-wheel-scroll/
246 ==============================================================================
247 3. Mouse Control *gui-mouse*
249 The mouse only works if the appropriate flag in the 'mouse' option is set.
250 When the GUI is switched on, and 'mouse' wasn't set yet, the 'mouse' option is
251 automatically set to "a", enabling it for all modes except for the
252 |hit-enter| prompt. If you don't want this, a good place to change the
253 'mouse' option is the "gvimrc" file.
255 Other options that are relevant:
256 'mousefocus' window focus follows mouse pointer |gui-mouse-focus|
257 'mousemodel' what mouse button does which action
258 'mousehide' hide mouse pointer while typing text
259 'selectmode' whether to start Select mode or Visual mode
261 A quick way to set these is with the ":behave" command.
262 *:behave* *:be*
263 :be[have] {model} Set behavior for mouse and selection. Valid
264 arguments are:
265 mswin MS-Windows behavior
266 xterm Xterm behavior
268 Using ":behave" changes these options:
269 option mswin xterm ~
270 'selectmode' "mouse,key" ""
271 'mousemodel' "popup" "extend"
272 'keymodel' "startsel,stopsel" ""
273 'selection' "exclusive" "inclusive"
275 In the $VIMRUNTIME directory, there is a script called |mswin.vim|, which will
276 also map a few keys to the MS-Windows cut/copy/paste commands. This is NOT
277 compatible, since it uses the CTRL-V, CTRL-X and CTRL-C keys. If you don't
278 mind, use this command: >
279 :so $VIMRUNTIME/mswin.vim
281 For scrolling with a wheel on a mouse, see |scroll-mouse-wheel|.
284 3.1 Moving Cursor with Mouse *gui-mouse-move*
286 Click the left mouse button somewhere in a text buffer where you want the
287 cursor to go, and it does!
288 This works in when 'mouse' contains ~
289 Normal mode 'n' or 'a'
290 Visual mode 'v' or 'a'
291 Insert mode 'i' or 'a'
293 Select mode is handled like Visual mode.
295 You may use this with an operator such as 'd' to delete text from the current
296 cursor position to the position you point to with the mouse. That is, you hit
297 'd' and then click the mouse somewhere.
299 *gui-mouse-focus*
300 The 'mousefocus' option can be set to make the keyboard focus follow the
301 mouse pointer. This means that the window where the mouse pointer is, is the
302 active window. Warning: this doesn't work very well when using a menu,
303 because the menu command will always be applied to the top window.
305 If you are on the ':' line (or '/' or '?'), then clicking the left or right
306 mouse button will position the cursor on the ':' line (if 'mouse' contains
307 'c', 'a' or 'A').
309 In any situation the middle mouse button may be clicked to paste the current
310 selection.
313 3.2 Selection with Mouse *gui-mouse-select*
315 The mouse can be used to start a selection. How depends on the 'mousemodel'
316 option:
317 'mousemodel' is "extend": use the right mouse button
318 'mousemodel' is "popup": use the left mouse button, while keeping the Shift
319 key pressed.
321 If there was no selection yet, this starts a selection from the old cursor
322 position to the position pointed to with the mouse. If there already is a
323 selection then the closest end will be extended.
325 If 'selectmode' contains "mouse", then the selection will be in Select mode.
326 This means that typing normal text will replace the selection. See
327 |Select-mode|. Otherwise, the selection will be in Visual mode.
329 Double clicking may be done to make the selection word-wise, triple clicking
330 makes it line-wise, and quadruple clicking makes it rectangular block-wise.
332 See |gui-selections| on how the selection is used.
335 3.3 Other Text Selection with Mouse *gui-mouse-modeless*
336 *modeless-selection*
337 A different kind of selection is used when:
338 - in Command-line mode
339 - in the Command-line window and pointing in another window
340 - at the |hit-enter| prompt
341 - whenever the current mode is not in the 'mouse' option
342 - when holding the CTRL and SHIFT keys in the GUI
344 Since Vim continues like the selection isn't there, and there is no mode
345 associated with the selection, this is called modeless selection. Any text in
346 the Vim window can be selected. Select the text by pressing the left mouse
347 button at the start, drag to the end and release. To extend the selection,
348 use the right mouse button when 'mousemodel' is "extend", or the left mouse
349 button with the shift key pressed when 'mousemodel' is "popup".
350 The selection is removed when the selected text is scrolled or changed.
352 On the command line CTRL-Y can be used to copy the selection into the
353 clipboard. To do this from Insert mode, use CTRL-O : CTRL-Y <CR>. When
354 'guioptions' contains a or A (default on X11), the selection is automatically
355 copied to the "* register.
357 The middle mouse button can then paste the text. On non-X11 systems, you can
358 use CTRL-R +.
361 3.4 Using Mouse on Status Lines *gui-mouse-status*
363 Clicking the left or right mouse button on the status line below a Vim
364 window makes that window the current window. This actually happens on button
365 release (to be able to distinguish a click from a drag action).
367 With the left mouse button a status line can be dragged up and down, thus
368 resizing the windows above and below it. This does not change window focus.
370 The same can be used on the vertical separator: click to give the window left
371 of it focus, drag left and right to make windows wider and narrower.
374 3.5 Various Mouse Clicks *gui-mouse-various*
376 <S-LeftMouse> Search forward for the word under the mouse click.
377 When 'mousemodel' is "popup" this starts or extends a
378 selection.
379 <S-RightMouse> Search backward for the word under the mouse click.
380 <C-LeftMouse> Jump to the tag name under the mouse click.
381 <C-RightMouse> Jump back to position before the previous tag jump
382 (same as "CTRL-T")
385 3.6 Mouse Mappings *gui-mouse-mapping*
387 The mouse events, complete with modifiers, may be mapped. Eg: >
388 :map <S-LeftMouse> <RightMouse>
389 :map <S-LeftDrag> <RightDrag>
390 :map <S-LeftRelease> <RightRelease>
391 :map <2-S-LeftMouse> <2-RightMouse>
392 :map <2-S-LeftDrag> <2-RightDrag>
393 :map <2-S-LeftRelease> <2-RightRelease>
394 :map <3-S-LeftMouse> <3-RightMouse>
395 :map <3-S-LeftDrag> <3-RightDrag>
396 :map <3-S-LeftRelease> <3-RightRelease>
397 :map <4-S-LeftMouse> <4-RightMouse>
398 :map <4-S-LeftDrag> <4-RightDrag>
399 :map <4-S-LeftRelease> <4-RightRelease>
400 These mappings make selection work the way it probably should in a Motif
401 application, with shift-left mouse allowing for extending the visual area
402 rather than the right mouse button.
404 Mouse mapping with modifiers does not work for modeless selection.
407 3.7 Drag and drop *drag-n-drop*
409 You can drag and drop one or more files into the Vim window, where they will
410 be opened as if a |:drop| command was used.
412 If you hold down Shift while doing this, Vim changes to the first dropped
413 file's directory. If you hold Ctrl Vim will always split a new window for the
414 file. Otherwise it's only done if the current buffer has been changed.
416 You can also drop a directory on Vim. This starts the explorer plugin for
417 that directory (assuming it was enabled, otherwise you'll get an error
418 message). Keep Shift pressed to change to the directory instead.
420 If Vim happens to be editing a command line, the names of the dropped files
421 and directories will be inserted at the cursor. This allows you to use these
422 names with any Ex command. Special characters (space, tab, double quote and
423 '|'; backslash on non-MS-Windows systems) will be escaped.
425 ==============================================================================
426 4. Making GUI Selections *gui-selections*
428 *quotestar*
429 You may make selections with the mouse (see |gui-mouse-select|), or by using
430 Vim's Visual mode (see |v|). If 'a' is present in 'guioptions', then
431 whenever a selection is started (Visual or Select mode), or when the selection
432 is changed, Vim becomes the owner of the windowing system's primary selection
433 (on MS-Windows the |gui-clipboard| is used; under X11, the |x11-selection| is
434 used - you should read whichever of these is appropriate now).
436 *clipboard*
437 There is a special register for storing this selection, it is the "*
438 register. Nothing is put in here unless the information about what text is
439 selected is about to change (e.g. with a left mouse click somewhere), or when
440 another application wants to paste the selected text. Then the text is put
441 in the "* register. For example, to cut a line and make it the current
442 selection/put it on the clipboard: >
444 "*dd
446 Similarly, when you want to paste a selection from another application, e.g.,
447 by clicking the middle mouse button, the selection is put in the "* register
448 first, and then 'put' like any other register. For example, to put the
449 selection (contents of the clipboard): >
451 "*p
453 When using this register under X11, also see |x11-selection|. This also
454 explains the related "+ register.
456 Note that when pasting text from one Vim into another separate Vim, the type
457 of selection (character, line, or block) will also be copied. For other
458 applications the type is always character. However, if the text gets
459 transferred via the |x11-cut-buffer|, the selection type is ALWAYS lost.
461 When the "unnamed" string is included in the 'clipboard' option, the unnamed
462 register is the same as the "* register. Thus you can yank to and paste the
463 selection without prepending "* to commands.
465 ==============================================================================
466 5. Menus *menus*
468 For an introduction see |usr_42.txt| in the user manual.
471 5.1 Using Menus *using-menus*
473 Basically, menus can be used just like mappings. You can define your own
474 menus, as many as you like.
475 Long-time Vim users won't use menus much. But the power is in adding your own
476 menus and menu items. They are most useful for things that you can't remember
477 what the key sequence was.
479 For creating menus in a different language, see |:menutrans|.
481 *menu.vim*
482 The default menus are read from the file "$VIMRUNTIME/menu.vim". See
483 |$VIMRUNTIME| for where the path comes from. You can set up your own menus.
484 Starting off with the default set is a good idea. You can add more items, or,
485 if you don't like the defaults at all, start with removing all menus
486 |:unmenu-all|. You can also avoid the default menus being loaded by adding
487 this line to your .vimrc file (NOT your .gvimrc file!): >
488 :let did_install_default_menus = 1
489 If you also want to avoid the Syntax menu: >
490 :let did_install_syntax_menu = 1
491 The first item in the Syntax menu can be used to show all available filetypes
492 in the menu (which can take a bit of time to load). If you want to have all
493 filetypes already present at startup, add: >
494 :let do_syntax_sel_menu = 1
496 <
497 *console-menus*
498 Although this documentation is in the GUI section, you can actually use menus
499 in console mode too. You will have to load |menu.vim| explicitly then, it is
500 not done by default. You can use the |:emenu| command and command-line
501 completion with 'wildmenu' to access the menu entries almost like a real menu
502 system. To do this, put these commands in your .vimrc file: >
503 :source $VIMRUNTIME/menu.vim
504 :set wildmenu
505 :set cpo-=<
506 :set wcm=<C-Z>
507 :map <F4> :emenu <C-Z>
508 Pressing <F4> will start the menu. You can now use the cursor keys to select
509 a menu entry. Hit <Enter> to execute it. Hit <Esc> if you want to cancel.
510 This does require the |+menu| feature enabled at compile time.
512 *tear-off-menus*
513 GTK+ and Motif support Tear-off menus. These are sort of sticky menus or
514 pop-up menus that are present all the time. If the resizing does not work
515 correctly, this may be caused by using something like "Vim*geometry" in the
516 defaults. Use "Vim.geometry" instead.
518 The Win32 GUI version emulates Motif's tear-off menus. Actually, a Motif user
519 will spot the differences easily, but hopefully they're just as useful. You
520 can also use the |:tearoff| command together with |hidden-menus| to create
521 floating menus that do not appear on the main menu bar.
524 5.2 Creating New Menus *creating-menus*
526 *:me* *:menu* *:noreme* *:noremenu*
527 *:am* *:amenu* *:an* *:anoremenu*
528 *:nme* *:nmenu* *:nnoreme* *:nnoremenu*
529 *:ome* *:omenu* *:onoreme* *:onoremenu*
530 *:vme* *:vmenu* *:vnoreme* *:vnoremenu*
531 *:xme* *:xmenu* *:xnoreme* *:xnoremenu*
532 *:sme* *:smenu* *:snoreme* *:snoremenu*
533 *:ime* *:imenu* *:inoreme* *:inoremenu*
534 *:cme* *:cmenu* *:cnoreme* *:cnoremenu*
535 *E330* *E327* *E331* *E336* *E333*
536 *E328* *E329* *E337* *E792*
537 To create a new menu item, use the ":menu" commands. They are mostly like
538 the ":map" set of commands but the first argument is a menu item name, given
539 as a path of menus and submenus with a '.' between them, e.g.: >
541 :menu File.Save :w<CR>
542 :inoremenu File.Save <C-O>:w<CR>
543 :menu Edit.Big\ Changes.Delete\ All\ Spaces :%s/[ ^I]//g<CR>
545 This last one will create a new item in the menu bar called "Edit", holding
546 the mouse button down on this will pop up a menu containing the item
547 "Big Changes", which is a sub-menu containing the item "Delete All Spaces",
548 which when selected, performs the operation.
550 Special characters in a menu name:
552 & The next character is the shortcut key. Make sure each
553 shortcut key is only used once in a (sub)menu. If you want to
554 insert a literal "&" in the menu name use "&&".
555 <Tab> Separates the menu name from right-aligned text. This can be
556 used to show the equivalent typed command. The text "<Tab>"
557 can be used here for convenience. If you are using a real
558 tab, don't forget to put a backslash before it!
559 Example: >
561 :amenu &File.&Open<Tab>:e :browse e<CR>
563 [typed literally]
564 With the shortcut "F" (while keeping the <Alt> key pressed), and then "O",
565 this menu can be used. The second part is shown as "Open :e". The ":e"
566 is right aligned, and the "O" is underlined, to indicate it is the shortcut.
568 The ":amenu" command can be used to define menu entries for all modes at once.
569 To make the command work correctly, a character is automatically inserted for
570 some modes:
571 mode inserted appended ~
572 Normal nothing nothing
573 Visual <C-C> <C-\><C-G>
574 Insert <C-\><C-O>
575 Cmdline <C-C> <C-\><C-G>
576 Op-pending <C-C> <C-\><C-G>
578 Appending CTRL-\ CTRL-G is for going back to insert mode when 'insertmode' is
579 set. |CTRL-\_CTRL-G|
581 Example: >
583 :amenu File.Next :next^M
585 is equal to: >
587 :nmenu File.Next :next^M
588 :vmenu File.Next ^C:next^M^\^G
589 :imenu File.Next ^\^O:next^M
590 :cmenu File.Next ^C:next^M^\^G
591 :omenu File.Next ^C:next^M^\^G
593 Careful: In Insert mode this only works for a SINGLE Normal mode command,
594 because of the CTRL-O. If you have two or more commands, you will need to use
595 the ":imenu" command. For inserting text in any mode, you can use the
596 expression register: >
598 :amenu Insert.foobar "='foobar'<CR>P
600 Note that the '<' and 'k' flags in 'cpoptions' also apply here (when
601 included they make the <> form and raw key codes not being recognized).
603 Note that <Esc> in Cmdline mode executes the command, like in a mapping. This
604 is Vi compatible. Use CTRL-C to quit Cmdline mode.
606 *:menu-<silent>* *:menu-silent*
607 To define a menu which will not be echoed on the command line, add
608 "<silent>" as the first argument. Example: >
609 :menu <silent> Settings.Ignore\ case :set ic<CR>
610 The ":set ic" will not be echoed when using this menu. Messages from the
611 executed command are still given though. To shut them up too, add a ":silent"
612 in the executed command: >
613 :menu <silent> Search.Header :exe ":silent normal /Header\r"<CR>
614 "<silent>" may also appear just after "<special>" or "<script>".
616 *:menu-<special>* *:menu-special*
617 Define a menu with <> notation for special keys, even though the "<" flag
618 may appear in 'cpoptions'. This is useful if the side effect of setting
619 'cpoptions' is not desired. Example: >
620 :menu <special> Search.Header /Header<CR>
621 "<special>" must appear as the very first argument to the ":menu" command or
622 just after "<silent>" or "<script>".
624 *:menu-<script>* *:menu-script*
625 The "to" part of the menu will be inspected for mappings. If you don't want
626 this, use the ":noremenu" command (or the similar one for a specific mode).
627 If you do want to use script-local mappings, add "<script>" as the very first
628 argument to the ":menu" command or just after "<silent>" or "<special>".
630 *menu-priority*
631 You can give a priority to a menu. Menus with a higher priority go more to
632 the right. The priority is given as a number before the ":menu" command.
633 Example: >
634 :80menu Buffer.next :bn<CR>
636 The default menus have these priorities:
637 File 10
638 Edit 20
639 Tools 40
640 Syntax 50
641 Buffers 60
642 Window 70
643 Help 9999
645 When no or zero priority is given, 500 is used.
646 The priority for the PopUp menu is not used.
648 The Help menu will be placed on the far right side of the menu bar on systems
649 which support this (Motif and GTK+). For GTK+ 2, this is not done anymore
650 because right-aligning the Help menu is now discouraged UI design.
652 You can use a priority higher than 9999, to make it go after the Help menu,
653 but that is non-standard and is discouraged. The highest possible priority is
654 about 32000. The lowest is 1.
656 *sub-menu-priority*
657 The same mechanism can be used to position a sub-menu. The priority is then
658 given as a dot-separated list of priorities, before the menu name: >
659 :menu 80.500 Buffer.next :bn<CR>
660 Giving the sub-menu priority is only needed when the item is not to be put
661 in a normal position. For example, to put a sub-menu before the other items: >
662 :menu 80.100 Buffer.first :brew<CR>
663 Or to put a sub-menu after the other items, and further items with default
664 priority will be put before it: >
665 :menu 80.900 Buffer.last :blast<CR>
666 When a number is missing, the default value 500 will be used: >
667 :menu .900 myMenu.test :echo "text"<CR>
668 The menu priority is only used when creating a new menu. When it already
669 existed, e.g., in another mode, the priority will not change. Thus, the
670 priority only needs to be given the first time a menu is used.
671 An exception is the PopUp menu. There is a separate menu for each mode
672 (Normal, Op-pending, Visual, Insert, Cmdline). The order in each of these
673 menus can be different. This is different from menu-bar menus, which have
674 the same order for all modes.
675 NOTE: sub-menu priorities currently don't work for all versions of the GUI.
677 *menu-separator* *E332*
678 Menu items can be separated by a special item that inserts some space between
679 items. Depending on the system this is displayed as a line or a dotted line.
680 These items must start with a '-' and end in a '-'. The part in between is
681 used to give it a unique name. Priorities can be used as with normal items.
682 Example: >
683 :menu Example.item1 :do something
684 :menu Example.-Sep- :
685 :menu Example.item2 :do something different
686 Note that the separator also requires a rhs. It doesn't matter what it is,
687 because the item will never be selected. Use a single colon to keep it
688 simple.
690 *gui-toolbar*
691 The toolbar is currently available in the Win32, Athena, Motif, GTK+ (X11),
692 and Photon GUI. It should turn up in other GUIs in due course. The
693 default toolbar is setup in menu.vim.
694 The display of the toolbar is controlled by the 'guioptions' letter 'T'. You
695 can thus have menu & toolbar together, or either on its own, or neither.
696 The appearance is controlled by the 'toolbar' option. You can choose between
697 an image, text or both.
699 *toolbar-icon*
700 The toolbar is defined as a special menu called ToolBar, which only has one
701 level. Vim interprets the items in this menu as follows:
702 1) If an "icon=" argument was specified, the file with this name is used.
703 The file can either be specified with the full path or with the base name.
704 In the last case it is searched for in the "bitmaps" directory in
705 'runtimepath', like in point 3. Examples: >
706 :amenu icon=/usr/local/pixmaps/foo_icon.xpm ToolBar.Foo :echo "Foo"<CR>
707 :amenu icon=FooIcon ToolBar.Foo :echo "Foo"<CR>
708 < Note that in the first case the extension is included, while in the second
709 case it is omitted.
710 If the file cannot be opened the next points are tried.
711 A space in the file name must be escaped with a backslash.
712 A menu priority must come _after_ the icon argument: >
713 :amenu icon=foo 1.42 ToolBar.Foo :echo "42!"<CR>
714 2) An item called 'BuiltIn##', where ## is a number, is taken as number ## of
715 the built-in bitmaps available in Vim. Currently there are 31 numbered
716 from 0 to 30 which cover most common editing operations |builtin-tools|. >
717 :amenu ToolBar.BuiltIn22 :call SearchNext("back")<CR>
718 3) An item with another name is first searched for in the directory
719 "bitmaps" in 'runtimepath'. If found, the bitmap file is used as the
720 toolbar button image. Note that the exact filename is OS-specific: For
721 example, under Win32 the command >
722 :amenu ToolBar.Hello :echo "hello"<CR>
723 < would find the file 'hello.bmp'. Under GTK+/X11 it is 'Hello.xpm'. With
724 GTK+ 2 the files 'Hello.png', 'Hello.xpm' and 'Hello.bmp' are checked for
725 existence, and the first one found would be used.
726 For MS-Windows and GTK+ 2 the bitmap is scaled to fit the button. For
727 MS-Windows a size of 18 by 18 pixels works best.
728 For MS-Windows the bitmap should have 16 colors with the standard palette.
729 The light grey pixels will be changed to the Window frame color and the
730 dark grey pixels to the window shadow color. More colors might also work,
731 depending on your system.
732 4) If the bitmap is still not found, Vim checks for a match against its list
733 of built-in names. Each built-in button image has a name.
734 So the command >
735 :amenu ToolBar.Open :e
736 < will show the built-in "open a file" button image if no open.bmp exists.
737 All the built-in names can be seen used in menu.vim.
738 5) If all else fails, a blank, but functioning, button is displayed.
740 *builtin-tools*
741 nr Name Normal action ~
742 00 New open new window
743 01 Open browse for file to open in current window
744 02 Save write buffer to file
745 03 Undo undo last change
746 04 Redo redo last undone change
747 05 Cut delete selected text to clipboard
748 06 Copy copy selected text to clipboard
749 07 Paste paste text from clipboard
750 08 Print print current buffer
751 09 Help open a buffer on Vim's builtin help
752 10 Find start a search command
753 11 SaveAll write all modified buffers to file
754 12 SaveSesn write session file for current situation
755 13 NewSesn write new session file
756 14 LoadSesn load session file
757 15 RunScript browse for file to run as a Vim script
758 16 Replace prompt for substitute command
759 17 WinClose close current window
760 18 WinMax make current window use many lines
761 19 WinMin make current window use few lines
762 20 WinSplit split current window
763 21 Shell start a shell
764 22 FindPrev search again, backward
765 23 FindNext search again, forward
766 24 FindHelp prompt for word to search help for
767 25 Make run make and jump to first error
768 26 TagJump jump to tag under the cursor
769 27 RunCtags build tags for files in current directory
770 28 WinVSplit split current window vertically
771 29 WinMaxWidth make current window use many columns
772 30 WinMinWidth make current window use few columns
774 *hidden-menus* *win32-hidden-menus*
775 In the Win32 and GTK+ GUI, starting a menu name with ']' excludes that menu
776 from the main menu bar. You must then use the |:popup| or |:tearoff| command
777 to display it.
779 *popup-menu*
780 In the Win32, GTK+, Motif, Athena and Photon GUI, you can define the
781 special menu "PopUp". This is the menu that is displayed when the right mouse
782 button is pressed, if 'mousemodel' is set to popup or popup_setpos.
785 5.3 Showing What Menus Are Mapped To *showing-menus*
787 To see what an existing menu is mapped to, use just one argument after the
788 menu commands (just like you would with the ":map" commands). If the menu
789 specified is a submenu, then all menus under that hierarchy will be shown.
790 If no argument is given after :menu at all, then ALL menu items are shown
791 for the appropriate mode (e.g., Command-line mode for :cmenu).
793 Special characters in the list, just before the rhs:
794 * The menu was defined with "nore" to disallow remapping.
795 & The menu was defined with "<script>" to allow remapping script-local
796 mappings only.
797 - The menu was disabled.
799 Note that hitting <Tab> while entering a menu name after a menu command may
800 be used to complete the name of the menu item.
803 5.4 Executing Menus *execute-menus*
805 *:em* *:emenu* *E334* *E335*
806 :[range]em[enu] {menu} Execute {menu} from the command line.
807 The default is to execute the Normal mode
808 menu. If a range is specified, it executes
809 the Visual mode menu.
810 If used from <c-o>, it executes the
811 insert-mode menu Eg: >
812 :emenu File.Exit
814 If the console-mode vim has been compiled with WANT_MENU defined, you can
815 use :emenu to access useful menu items you may have got used to from GUI
816 mode. See 'wildmenu' for an option that works well with this. See
817 |console-menus| for an example.
819 When using a range, if the lines match with '<,'>, then the menu is executed
820 using the last visual selection.
823 5.5 Deleting Menus *delete-menus*
825 *:unme* *:unmenu*
826 *:aun* *:aunmenu*
827 *:nunme* *:nunmenu*
828 *:ounme* *:ounmenu*
829 *:vunme* *:vunmenu*
830 *:xunme* *:xunmenu*
831 *:sunme* *:sunmenu*
832 *:iunme* *:iunmenu*
833 *:cunme* *:cunmenu*
834 To delete a menu item or a whole submenu, use the unmenu commands, which are
835 analogous to the unmap commands. Eg: >
836 :unmenu! Edit.Paste
838 This will remove the Paste item from the Edit menu for Insert and
839 Command-line modes.
841 Note that hitting <Tab> while entering a menu name after an umenu command
842 may be used to complete the name of the menu item for the appropriate mode.
844 To remove all menus use: *:unmenu-all* >
845 :unmenu * " remove all menus in Normal and visual mode
846 :unmenu! * " remove all menus in Insert and Command-line mode
847 :aunmenu * " remove all menus in all modes
849 If you want to get rid of the menu bar: >
850 :set guioptions-=m
853 5.6 Disabling Menus *disable-menus*
855 *:menu-disable* *:menu-enable*
856 If you do not want to remove a menu, but disable it for a moment, this can be
857 done by adding the "enable" or "disable" keyword to a ":menu" command.
858 Examples: >
859 :menu disable &File.&Open\.\.\.
860 :amenu enable *
861 :amenu disable &Tools.*
863 The command applies to the modes as used with all menu commands. Note that
864 characters like "&" need to be included for translated names to be found.
865 When the argument is "*", all menus are affected. Otherwise the given menu
866 name and all existing submenus below it are affected.
869 5.7 Examples for Menus *menu-examples*
871 Here is an example on how to add menu items with menu's! You can add a menu
872 item for the keyword under the cursor. The register "z" is used. >
874 :nmenu Words.Add\ Var wb"zye:menu! Words.<C-R>z <C-R>z<CR>
875 :nmenu Words.Remove\ Var wb"zye:unmenu! Words.<C-R>z<CR>
876 :vmenu Words.Add\ Var "zy:menu! Words.<C-R>z <C-R>z <CR>
877 :vmenu Words.Remove\ Var "zy:unmenu! Words.<C-R>z<CR>
878 :imenu Words.Add\ Var <Esc>wb"zye:menu! Words.<C-R>z <C-R>z<CR>a
879 :imenu Words.Remove\ Var <Esc>wb"zye:unmenu! Words.<C-R>z<CR>a
881 (the rhs is in <> notation, you can copy/paste this text to try out the
882 mappings, or put these lines in your gvimrc; "<C-R>" is CTRL-R, "<CR>" is
883 the <CR> key. |<>|)
886 5.8 Tooltips & Menu tips
888 See section |42.4| in the user manual.
890 *:tmenu* *:tm*
891 :tm[enu] {menupath} {rhs} Define a tip for a menu or tool. {only in
892 X11 and Win32 GUI}
894 :tm[enu] [menupath] List menu tips. {only in X11 and Win32 GUI}
896 *:tunmenu* *:tu*
897 :tu[nmenu] {menupath} Remove a tip for a menu or tool.
898 {only in X11 and Win32 GUI}
900 When a tip is defined for a menu item, it appears in the command-line area
901 when the mouse is over that item, much like a standard Windows menu hint in
902 the status bar. (Except when Vim is in Command-line mode, when of course
903 nothing is displayed.)
904 When a tip is defined for a ToolBar item, it appears as a tooltip when the
905 mouse pauses over that button, in the usual fashion. Use the |hl-Tooltip|
906 highlight group to change its colors.
908 A "tip" can be defined for each menu item. For example, when defining a menu
909 item like this: >
910 :amenu MyMenu.Hello :echo "Hello"<CR>
911 The tip is defined like this: >
912 :tmenu MyMenu.Hello Displays a greeting.
913 And delete it with: >
914 :tunmenu MyMenu.Hello
916 Tooltips are currently only supported for the X11 and Win32 GUI. However, they
917 should appear for the other gui platforms in the not too distant future.
919 The ":tmenu" command works just like other menu commands, it uses the same
920 arguments. ":tunmenu" deletes an existing menu tip, in the same way as the
921 other unmenu commands.
923 If a menu item becomes invalid (i.e. its actions in all modes are deleted) Vim
924 deletes the menu tip (and the item) for you. This means that :aunmenu deletes
925 a menu item - you don't need to do a :tunmenu as well.
928 5.9 Popup Menus
930 In the Win32 and GTK+ GUI, you can cause a menu to popup at the cursor.
931 This behaves similarly to the PopUp menus except that any menu tree can
932 be popped up.
934 This command is for backwards compatibility, using it is discouraged, because
935 it behaves in a strange way.
937 *:popup* *:popu*
938 :popu[p] {name} Popup the menu {name}. The menu named must
939 have at least one subentry, but need not
940 appear on the menu-bar (see |hidden-menus|).
941 {only available for Win32 and GTK GUI}
943 :popu[p]! {name} Like above, but use the position of the mouse
944 pointer instead of the cursor.
946 Example: >
947 :popup File
948 will make the "File" menu (if there is one) appear at the text cursor (mouse
949 pointer if ! was used). >
951 :amenu ]Toolbar.Make :make<CR>
952 :popup ]Toolbar
953 This creates a popup menu that doesn't exist on the main menu-bar.
955 Note that a menu that starts with ']' will not be displayed.
957 ==============================================================================
958 6. Extras *gui-extras*
960 This section describes other features which are related to the GUI.
962 - With the GUI, there is no wait for one second after hitting escape, because
963 the key codes don't start with <Esc>.
965 - Typing ^V followed by a special key in the GUI will insert "<Key>", since
966 the internal string used is meaningless. Modifiers may also be held down to
967 get "<Modifiers-Key>".
969 - In the GUI, the modifiers SHIFT, CTRL, and ALT (or META) may be used within
970 mappings of special keys and mouse events. E.g.: :map <M-LeftDrag> <LeftDrag>
972 - In the GUI, several normal keys may have modifiers in mappings etc, these
973 are <Space>, <Tab>, <NL>, <CR>, <Esc>.
975 - To check in a Vim script if the GUI is being used, you can use something
976 like this: >
978 if has("gui_running")
979 echo "yes, we have a GUI"
980 else
981 echo "Boring old console"
982 endif
983 < *setting-guifont*
984 - When you use the same vimrc file on various systems, you can use something
985 like this to set options specifically for each type of GUI: >
987 if has("gui_running")
988 if has("gui_gtk2")
989 :set guifont=Luxi\ Mono\ 12
990 elseif has("x11")
991 " Also for GTK 1
992 :set guifont=*-lucidatypewriter-medium-r-normal-*-*-180-*-*-m-*-*
993 elseif has("gui_win32")
994 :set guifont=Luxi_Mono:h12:cANSI
995 endif
996 endif
998 A recommended Japanese font is MS Mincho. You can find info here:
999 http://www.lexikan.com/mincho.htm
1001 ==============================================================================
1002 7. Shell Commands *gui-shell*
1004 For the X11 GUI the external commands are executed inside the gvim window.
1005 See |gui-pty|.
1007 WARNING: Executing an external command from the X11 GUI will not always
1008 work. "normal" commands like "ls", "grep" and "make" mostly work fine.
1009 Commands that require an intelligent terminal like "less" and "ispell" won't
1010 work. Some may even hang and need to be killed from another terminal. So be
1011 careful!
1013 For the Win32 GUI the external commands are executed in a separate window.
1014 See |gui-shell-win32|.
1016 vim:tw=78:sw=4:ts=8:ft=help:norl: