1*gui.txt* For Vim version 8.2. Last change: 2021 Jun 27 2 3 4 VIM REFERENCE MANUAL by Bram Moolenaar 5 6 7Vim's Graphical User Interface *gui* *GUI* 8 91. Starting the GUI |gui-start| 102. Scrollbars |gui-scrollbars| 113. Mouse Control |gui-mouse| 124. Making GUI Selections |gui-selections| 135. Menus |menus| 146. Font |gui-font| 157. Extras |gui-extras| 168. Shell Commands |gui-shell| 17 18Other GUI documentation: 19|gui_x11.txt| For specific items of the X11 GUI. 20|gui_w32.txt| For specific items of the Win32 GUI. 21 22 23============================================================================== 241. Starting the GUI *gui-start* *E229* *E233* 25 26First you must make sure you actually have a version of Vim with the GUI code 27included. You can check this with the ":version" command, it says "with xxx 28GUI", where "xxx" is X11-Motif, X11-Athena, Photon, GTK2, GTK3, etc., or 29"MS-Windows 32 bit GUI version". 30 31How to start the GUI depends on the system used. Mostly you can run the 32GUI version of Vim with: 33 gvim [options] [files...] 34 35The X11 version of Vim can run both in GUI and in non-GUI mode. See 36|gui-x11-start|. 37 38 *gui-init* *gvimrc* *.gvimrc* *_gvimrc* *$MYGVIMRC* 39The gvimrc file is where GUI-specific startup commands should be placed. It 40is always sourced after the |vimrc| file. If you have one then the $MYGVIMRC 41environment variable has its name. 42 43When 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, $HOME is set by Vim if needed, see |$HOME-windows|. 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. 80 81NOTE: All but the first one are not carried out if Vim was started with 82"-u NONE" or "-u DEFAULTS" and no "-U" argument was given, or when started 83with "-U NONE". 84 85All this happens AFTER the normal Vim initializations, like reading your 86.vimrc file. See |initialization|. 87But the GUI window is only opened after all the initializations have been 88carried out. If you want some commands to be executed just after opening the 89GUI window, use the |GUIEnter| autocommand event. Example: > 90 :autocmd GUIEnter * winpos 100 50 91 92You can use the gvimrc files to set up your own customized menus (see |:menu|) 93and initialize other things that you may want to set up differently from the 94terminal version. 95 96Recommended place for your personal GUI initializations: 97 Unix $HOME/.gvimrc or $HOME/.vim/gvimrc 98 Win32 $HOME/_gvimrc, $HOME/vimfiles/gvimrc 99 or $VIM/_gvimrc 100 Amiga s:.gvimrc, home:.gvimrc, home:vimfiles:gvimrc 101 or $VIM/.gvimrc 102 Haiku $HOME/config/settings/vim/gvimrc 103 104The personal initialization files are searched in the order specified above 105and only the first one that is found is read. 106 107There are a number of options which only have meaning in the GUI version of 108Vim. These are 'guicursor', 'guifont', 'guipty' and 'guioptions'. They are 109documented in |options.txt| with all the other options. 110 111If using the Motif or Athena version of the GUI (but not for the GTK+ or 112Win32 version), a number of X resources are available. See |gui-resources|. 113 114Another way to set the colors for different occasions is with highlight 115groups. The "Normal" group is used to set the background and foreground 116colors. Example (which looks nice): > 117 118 :highlight Normal guibg=grey90 119 120The "guibg" and "guifg" settings override the normal background and 121foreground settings. The other settings for the Normal highlight group are 122not used. Use the 'guifont' option to set the font. 123 124Also check out the 'guicursor' option, to set the colors for the cursor in 125various modes. 126 127Vim tries to make the window fit on the screen when it starts up. This avoids 128that you can't see part of it. On the X Window System this requires a bit of 129guesswork. You can change the height that is used for the window title and a 130task bar with the 'guiheadroom' option. 131 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. 136 Also see |getwinpos()|, |getwinposx()| and |getwinposy()|. 137 138:winp[os] {X} {Y} *E466* 139 Put the GUI vim window at the given {X} and {Y} coordinates. 140 The coordinates should specify the position in pixels of the 141 top left corner of the window. Does not work in all versions. 142 Does work in an (new) xterm |xterm-color|. 143 When the GUI window has not been opened yet, the values are 144 remembered until the window is opened. The position is 145 adjusted to make the window fit on the screen (if possible). 146 147 *:win* *:winsize* *E465* 148:win[size] {width} {height} 149 Set the window height to {width} by {height} characters. 150 Obsolete, use ":set lines=11 columns=22". 151 If you get less lines than expected, check the 'guiheadroom' 152 option. 153 154If you are running the X Window System, you can get information about the 155window Vim is running in with these commands: > 156 :!xwininfo -id $WINDOWID 157 :!xprop -id $WINDOWID 158 :execute '!xwininfo -id ' . v:windowid 159 :execute '!xprop -id ' . v:windowid 160< 161 *gui-IME* *iBus* 162Input methods for international characters in X that rely on the XIM 163framework, most notably iBus, have been known to produce undesirable results 164in gvim. These may include an inability to enter spaces, or long delays 165between typing a character and it being recognized by the application. 166 167One workaround that has been successful, for unknown reasons, is to prevent 168gvim from forking into the background by starting it with the |-f| argument. 169 170============================================================================== 1712. Scrollbars *gui-scrollbars* 172 173There are vertical scrollbars and a horizontal scrollbar. You may 174configure which ones appear with the 'guioptions' option. 175 176The interface looks like this (with ":set guioptions=mlrb"): 177 178 +------------------------------+ ` 179 | File Edit Help | <- Menu bar (m) ` 180 +-+--------------------------+-+ ` 181 |^| |^| ` 182 |#| Text area. |#| ` 183 | | | | ` 184 |v|__________________________|v| ` 185 Normal status line -> |-+ File.c 5,2 +-| ` 186 between Vim windows |^|""""""""""""""""""""""""""|^| ` 187 | | | | ` 188 | | Another file buffer. | | ` 189 | | | | ` 190 |#| |#| ` 191 Left scrollbar (l) -> |#| |#| <- Right ` 192 |#| |#| scrollbar (r) ` 193 | | | | ` 194 |v| |v| ` 195 +-+--------------------------+-+ ` 196 | |< #### >| | <- Bottom ` 197 +-+--------------------------+-+ scrollbar (b) ` 198 199Any of the scrollbar or menu components may be turned off by not putting the 200appropriate letter in the 'guioptions' string. The bottom scrollbar is 201only useful when 'nowrap' is set. 202 203 204VERTICAL SCROLLBARS *gui-vert-scroll* 205 206Each Vim window has a scrollbar next to it which may be scrolled up and down 207to move through the text in that buffer. The size of the scrollbar-thumb 208indicates the fraction of the buffer which can be seen in the window. 209When the scrollbar is dragged all the way down, the last line of the file 210will appear in the top of the window. 211 212If a window is shrunk to zero height (by the growth of another window) its 213scrollbar disappears. It reappears when the window is restored. 214 215If a window is vertically split, it will get a scrollbar when it is the 216current window and when, taking the middle of the current window and drawing a 217vertical line, this line goes through the window. 218When there are scrollbars on both sides, and the middle of the current window 219is on the left half, the right scrollbar column will contain scrollbars for 220the rightmost windows. The same happens on the other side. 221 222 223HORIZONTAL SCROLLBARS *gui-horiz-scroll* 224 225The horizontal scrollbar (at the bottom of the Vim GUI) may be used to 226scroll text sideways when the 'wrap' option is turned off. The 227scrollbar-thumb size is such that the text of the longest visible line may be 228scrolled as far as possible left and right. The cursor is moved when 229necessary, it must remain on a visible character (unless 'virtualedit' is 230set). 231 232Computing the length of the longest visible line takes quite a bit of 233computation, and it has to be done every time something changes. If this 234takes too much time or you don't like the cursor jumping to another line, 235include the 'h' flag in 'guioptions'. Then the scrolling is limited by the 236text of the current cursor line. 237 238 *athena-intellimouse* 239If you have an Intellimouse and an X server that supports using the wheel, 240then you can use the wheel to scroll the text up and down in gvim. This works 241with XFree86 4.0 and later, and with some older versions when you add patches. 242See |scroll-mouse-wheel|. 243 244For older versions of XFree86 you must patch your X server. The following 245page has a bit of information about using the Intellimouse on Linux as well as 246links to the patches and X server binaries (may not have the one you need 247though): 248 http://www.inria.fr/koala/colas/mouse-wheel-scroll/ 249 250============================================================================== 2513. Mouse Control *gui-mouse* 252 253The mouse only works if the appropriate flag in the 'mouse' option is set. 254When the GUI is switched on, and 'mouse' wasn't set yet, the 'mouse' option is 255automatically set to "a", enabling it for all modes except for the 256|hit-enter| prompt. If you don't want this, a good place to change the 257'mouse' option is the "gvimrc" file. 258 259Other options that are relevant: 260'mousefocus' window focus follows mouse pointer |gui-mouse-focus| 261'mousemodel' what mouse button does which action 262'mousehide' hide mouse pointer while typing text 263'selectmode' whether to start Select mode or Visual mode 264 265A quick way to set these is with the ":behave" command. 266 *:behave* *:be* 267:be[have] {model} Set behavior for mouse and selection. Valid 268 arguments are: 269 mswin MS-Windows behavior 270 xterm Xterm behavior 271 272 Using ":behave" changes these options: 273 option mswin xterm ~ 274 'selectmode' "mouse,key" "" 275 'mousemodel' "popup" "extend" 276 'keymodel' "startsel,stopsel" "" 277 'selection' "exclusive" "inclusive" 278 279In the $VIMRUNTIME directory, there is a script called |mswin.vim|, which will 280also map a few keys to the MS-Windows cut/copy/paste commands. This is NOT 281compatible, since it uses the CTRL-V, CTRL-X and CTRL-C keys. If you don't 282mind, use this command: > 283 :so $VIMRUNTIME/mswin.vim 284 285For scrolling with a wheel on a mouse, see |scroll-mouse-wheel|. 286 287 2883.1 Moving Cursor with Mouse *gui-mouse-move* 289 290Click the left mouse button somewhere in a text buffer where you want the 291cursor to go, and it does! 292This works in when 'mouse' contains ~ 293Normal mode 'n' or 'a' 294Visual mode 'v' or 'a' 295Insert mode 'i' or 'a' 296 297Select mode is handled like Visual mode. 298 299You may use this with an operator such as 'd' to delete text from the current 300cursor position to the position you point to with the mouse. That is, you hit 301'd' and then click the mouse somewhere. 302 303 *gui-mouse-focus* 304The 'mousefocus' option can be set to make the keyboard focus follow the 305mouse pointer. This means that the window where the mouse pointer is, is the 306active window. Warning: this doesn't work very well when using a menu, 307because the menu command will always be applied to the top window. 308 309If you are on the ':' line (or '/' or '?'), then clicking the left or right 310mouse button will position the cursor on the ':' line (if 'mouse' contains 311'c' or 'a'). 312 313In any situation the middle mouse button may be clicked to paste the current 314selection. 315 316 3173.2 Selection with Mouse *gui-mouse-select* 318 319The mouse can be used to start a selection. How depends on the 'mousemodel' 320option: 321'mousemodel' is "extend": use the right mouse button 322'mousemodel' is "popup": use the left mouse button, while keeping the Shift 323key pressed. 324 325If there was no selection yet, this starts a selection from the old cursor 326position to the position pointed to with the mouse. If there already is a 327selection then the closest end will be extended. 328 329If 'selectmode' contains "mouse", then the selection will be in Select mode. 330This means that typing normal text will replace the selection. See 331|Select-mode|. Otherwise, the selection will be in Visual mode. 332 333Double clicking may be done to make the selection word-wise, triple clicking 334makes it line-wise, and quadruple clicking makes it rectangular block-wise. 335 336See |gui-selections| on how the selection is used. 337 338 3393.3 Other Text Selection with Mouse *gui-mouse-modeless* 340 *modeless-selection* 341A different kind of selection is used when: 342- in Command-line mode 343- in the Command-line window and pointing in another window 344- at the |hit-enter| prompt 345- whenever the current mode is not in the 'mouse' option 346- when holding the CTRL and SHIFT keys in the GUI 347 348Since Vim continues like the selection isn't there, and there is no mode 349associated with the selection, this is called modeless selection. Any text in 350the Vim window can be selected. Select the text by pressing the left mouse 351button at the start, drag to the end and release. To extend the selection, 352use the right mouse button when 'mousemodel' is "extend", or the left mouse 353button with the shift key pressed when 'mousemodel' is "popup". 354The selection is removed when the selected text is scrolled or changed. 355 356On the command line CTRL-Y can be used to copy the selection into the 357clipboard. To do this from Insert mode, use CTRL-O : CTRL-Y <CR>. When 358'guioptions' contains a or A (default on X11), the selection is automatically 359copied to the "* register. 360 361The middle mouse button can then paste the text. On non-X11 systems, you can 362use CTRL-R +. 363 364 3653.4 Using Mouse on Status Lines *gui-mouse-status* 366 367Clicking the left or right mouse button on the status line below a Vim 368window makes that window the current window. This actually happens on button 369release (to be able to distinguish a click from a drag action). 370 371With the left mouse button a status line can be dragged up and down, thus 372resizing the windows above and below it. This does not change window focus. 373 374The same can be used on the vertical separator: click to give the window left 375of it focus, drag left and right to make windows wider and narrower. 376 377 3783.5 Various Mouse Clicks *gui-mouse-various* 379 380 <S-LeftMouse> Search forward for the word under the mouse click. 381 When 'mousemodel' is "popup" this starts or extends a 382 selection. 383 <S-RightMouse> Search backward for the word under the mouse click. 384 <C-LeftMouse> Jump to the tag name under the mouse click. 385 <C-RightMouse> Jump back to position before the previous tag jump 386 (same as "CTRL-T") 387 388 3893.6 Mouse Mappings *gui-mouse-mapping* 390 391The mouse events, complete with modifiers, may be mapped. Eg: > 392 :map <S-LeftMouse> <RightMouse> 393 :map <S-LeftDrag> <RightDrag> 394 :map <S-LeftRelease> <RightRelease> 395 :map <2-S-LeftMouse> <2-RightMouse> 396 :map <2-S-LeftDrag> <2-RightDrag> 397 :map <2-S-LeftRelease> <2-RightRelease> 398 :map <3-S-LeftMouse> <3-RightMouse> 399 :map <3-S-LeftDrag> <3-RightDrag> 400 :map <3-S-LeftRelease> <3-RightRelease> 401 :map <4-S-LeftMouse> <4-RightMouse> 402 :map <4-S-LeftDrag> <4-RightDrag> 403 :map <4-S-LeftRelease> <4-RightRelease> 404These mappings make selection work the way it probably should in a Motif 405application, with shift-left mouse allowing for extending the visual area 406rather than the right mouse button. 407 408Mouse mapping with modifiers does not work for modeless selection. 409 410 4113.7 Drag and drop *drag-n-drop* 412 413You can drag and drop one or more files into the Vim window, where they will 414be opened as if a |:drop| command was used. You can check if this is 415supported with the *drop_file* feature: `has('drop_file')`. 416 417If you hold down Shift while doing this, Vim changes to the first dropped 418file's directory. If you hold Ctrl Vim will always split a new window for the 419file. Otherwise it's only done if the current buffer has been changed. 420 421You can also drop a directory on Vim. This starts the explorer plugin for 422that directory (assuming it was enabled, otherwise you'll get an error 423message). Keep Shift pressed to change to the directory instead. 424 425If Vim happens to be editing a command line, the names of the dropped files 426and directories will be inserted at the cursor. This allows you to use these 427names with any Ex command. Special characters (space, tab, double quote and 428'|'; backslash on non-MS-Windows systems) will be escaped. 429 430============================================================================== 4314. Making GUI Selections *gui-selections* 432 433 *quotestar* 434You may make selections with the mouse (see |gui-mouse-select|), or by using 435Vim's Visual mode (see |v|). If 'a' is present in 'guioptions', then 436whenever a selection is started (Visual or Select mode), or when the selection 437is changed, Vim becomes the owner of the windowing system's primary selection 438(on MS-Windows the |gui-clipboard| is used; under X11, the |x11-selection| is 439used - you should read whichever of these is appropriate now). 440 441 *clipboard* 442There is a special register for storing this selection, it is the "* 443register. Nothing is put in here unless the information about what text is 444selected is about to change (e.g. with a left mouse click somewhere), or when 445another application wants to paste the selected text. Then the text is put 446in the "* register. For example, to cut a line and make it the current 447selection/put it on the clipboard: > 448 449 "*dd 450 451Similarly, when you want to paste a selection from another application, e.g., 452by clicking the middle mouse button, the selection is put in the "* register 453first, and then 'put' like any other register. For example, to put the 454selection (contents of the clipboard): > 455 456 "*p 457 458When using this register under X11, also see |x11-selection|. This also 459explains the related "+ register. 460 461Note that when pasting text from one Vim into another separate Vim, the type 462of selection (character, line, or block) will also be copied. For other 463applications the type is always character. However, if the text gets 464transferred via the |x11-cut-buffer|, the selection type is ALWAYS lost. 465 466When the "unnamed" string is included in the 'clipboard' option, the unnamed 467register is the same as the "* register. Thus you can yank to and paste the 468selection without prepending "* to commands. 469 470============================================================================== 4715. Menus *menus* 472 473For an introduction see |usr_42.txt| in the user manual. 474 475 4765.1 Using Menus *using-menus* 477 478Basically, menus can be used just like mappings. You can define your own 479menus, as many as you like. 480Long-time Vim users won't use menus much. But the power is in adding your own 481menus and menu items. They are most useful for things that you can't remember 482what the key sequence was. 483 484For creating menus in a different language, see |:menutrans|. 485If you don't want to use menus at all, see |'go-M'|. 486 487 *menu.vim* 488The default menus are read from the file "$VIMRUNTIME/menu.vim". See 489|$VIMRUNTIME| for where the path comes from. You can set up your own menus. 490Starting off with the default set is a good idea. You can add more items, or, 491if you don't like the defaults at all, start with removing all menus 492|:unmenu-all|. You can also avoid the default menus being loaded by adding 493this line to your .vimrc file (NOT your .gvimrc file!): > 494 :let did_install_default_menus = 1 495If you also want to avoid the Syntax menu: > 496 :let did_install_syntax_menu = 1 497The first item in the Syntax menu can be used to show all available filetypes 498in the menu (which can take a bit of time to load). If you want to have all 499filetypes already present at startup, add: > 500 :let do_syntax_sel_menu = 1 501 502The following menuitems show all available color schemes, keymaps and compiler 503settings: 504 Edit > Color Scheme ~ 505 Edit > Keymap ~ 506 Tools > Set Compiler ~ 507However, they can also take a bit of time to load, because they search all 508related files from the directories in 'runtimepath'. Therefore they are 509loaded lazily (by the |CursorHold| event), or you can also load them manually. 510If you want to have all these items already present at startup, add: > 511 :let do_no_lazyload_menus = 1 512 513Note that the menu.vim is sourced when `:syntax on` or `:filetype on` is 514executed or after your .vimrc file is sourced. This means that the 'encoding' 515option and the language of messages (`:language messages`) must be set before 516that (if you want to change them). 517 518 *console-menus* 519Although this documentation is in the GUI section, you can actually use menus 520in console mode too. You will have to load |menu.vim| explicitly then, it is 521not done by default. You can use the |:emenu| command and command-line 522completion with 'wildmenu' to access the menu entries almost like a real menu 523system. To do this, put these commands in your .vimrc file: > 524 :source $VIMRUNTIME/menu.vim 525 :set wildmenu 526 :set cpo-=< 527 :set wcm=<C-Z> 528 :map <F4> :emenu <C-Z> 529Pressing <F4> will start the menu. You can now use the cursor keys to select 530a menu entry. Hit <Enter> to execute it. Hit <Esc> if you want to cancel. 531This does require the |+menu| feature enabled at compile time. 532 533 *tear-off-menus* 534GTK+ 2 and Motif support Tear-off menus. These are sort of sticky menus or 535pop-up menus that are present all the time. If the resizing does not work 536correctly, this may be caused by using something like "Vim*geometry" in the 537defaults. Use "Vim.geometry" instead. 538 539As to GTK+ 3, tear-off menus have been deprecated since GTK+ 3.4. 540Accordingly, they are disabled if gvim is linked against GTK+ 3.4 or later. 541 542The Win32 GUI version emulates Motif's tear-off menus. Actually, a Motif user 543will spot the differences easily, but hopefully they're just as useful. You 544can also use the |:tearoff| command together with |hidden-menus| to create 545floating menus that do not appear on the main menu bar. 546 547 5485.2 Creating New Menus *creating-menus* 549 550 *:me* *:menu* *:noreme* *:noremenu* 551 *E330* *E327* *E331* *E336* *E333* 552 *E328* *E329* *E337* *E792* 553To create a new menu item, use the ":menu" commands. They are mostly like 554the ":map" set of commands (see |map-modes|), but the first argument is a menu 555item name, given as a path of menus and submenus with a '.' between them, 556e.g.: > 557 558 :menu File.Save :w<CR> 559 :inoremenu File.Save <C-O>:w<CR> 560 :menu Edit.Big\ Changes.Delete\ All\ Spaces :%s/[ ^I]//g<CR> 561 562This last one will create a new item in the menu bar called "Edit", holding 563the mouse button down on this will pop up a menu containing the item 564"Big Changes", which is a sub-menu containing the item "Delete All Spaces", 565which when selected, performs the operation. 566 567To create a menu for terminal mode, use |:tlmenu| instead of |:tmenu| unlike 568key mapping (|:tmap|). This is because |:tmenu| is already used for defining 569tooltips for menus. See |terminal-typing|. 570 571Special characters in a menu name: 572 573 *menu-shortcut* 574 & The next character is the shortcut key. Make sure each 575 shortcut key is only used once in a (sub)menu. If you want to 576 insert a literal "&" in the menu name use "&&". 577 *menu-text* 578 <Tab> Separates the menu name from right-aligned text. This can be 579 used to show the equivalent typed command. The text "<Tab>" 580 can be used here for convenience. If you are using a real 581 tab, don't forget to put a backslash before it! 582Example: > 583 584 :amenu &File.&Open<Tab>:e :browse e<CR> 585 586[typed literally] 587With the shortcut "F" (while keeping the <Alt> key pressed), and then "O", 588this menu can be used. The second part is shown as "Open :e". The ":e" 589is right aligned, and the "O" is underlined, to indicate it is the shortcut. 590 591 *:am* *:amenu* *:an* *:anoremenu* 592The ":amenu" command can be used to define menu entries for all modes at once, 593except for Terminal mode. To make the command work correctly, a character is 594automatically inserted for some modes: 595 mode inserted appended ~ 596 Normal nothing nothing 597 Visual <C-C> <C-\><C-G> 598 Insert <C-\><C-O> 599 Cmdline <C-C> <C-\><C-G> 600 Op-pending <C-C> <C-\><C-G> 601 602Appending CTRL-\ CTRL-G is for going back to insert mode when 'insertmode' is 603set. |CTRL-\_CTRL-G| 604 605Example: > 606 607 :amenu File.Next :next^M 608 609is equal to: > 610 611 :nmenu File.Next :next^M 612 :vmenu File.Next ^C:next^M^\^G 613 :imenu File.Next ^\^O:next^M 614 :cmenu File.Next ^C:next^M^\^G 615 :omenu File.Next ^C:next^M^\^G 616 617Careful: In Insert mode this only works for a SINGLE Normal mode command, 618because of the CTRL-O. If you have two or more commands, you will need to use 619the ":imenu" command. For inserting text in any mode, you can use the 620expression register: > 621 622 :amenu Insert.foobar "='foobar'<CR>P 623 624The special text <Cmd> begins a "command menu", it executes the command 625directly without changing modes. Where you might use ":...<CR>" you can 626instead use "<Cmd>...<CR>". See |<Cmd>| for more info. Example: > 627 anoremenu File.Next <Cmd>next<CR> 628 629Note that the '<' and 'k' flags in 'cpoptions' also apply here (when 630included they make the <> form and raw key codes not being recognized). 631 632Note that <Esc> in Cmdline mode executes the command, like in a mapping. This 633is Vi compatible. Use CTRL-C to quit Cmdline mode. 634 635 *:nme* *:nmenu* *:nnoreme* *:nnoremenu* *:nunme* *:nunmenu* 636Menu commands starting with "n" work in Normal mode. |mapmode-n| 637 638 *:ome* *:omenu* *:onoreme* *:onoremenu* *:ounme* *:ounmenu* 639Menu commands starting with "o" work in Operator-pending mode. |mapmode-o| 640 641 *:vme* *:vmenu* *:vnoreme* *:vnoremenu* *:vunme* *:vunmenu* 642Menu commands starting with "v" work in Visual mode. |mapmode-v| 643 644 *:xme* *:xmenu* *:xnoreme* *:xnoremenu* *:xunme* *:xunmenu* 645Menu commands starting with "x" work in Visual and Select mode. |mapmode-x| 646 647 *:sme* *:smenu* *:snoreme* *:snoremenu* *:sunme* *:sunmenu* 648Menu commands starting with "s" work in Select mode. |mapmode-s| 649 650 *:ime* *:imenu* *:inoreme* *:inoremenu* *:iunme* *:iunmenu* 651Menu commands starting with "i" work in Insert mode. |mapmode-i| 652 653 *:cme* *:cmenu* *:cnoreme* *:cnoremenu* *:cunme* *:cunmenu* 654Menu commands starting with "c" work in Cmdline mode. |mapmode-c| 655 656 *:tlm* *:tlmenu* *:tln* *:tlnoremenu* *:tlu* *:tlunmenu* 657Menu commands starting with "tl" work in Terminal mode. |mapmode-t| 658 659 *:menu-<silent>* *:menu-silent* 660To define a menu which will not be echoed on the command line, add 661"<silent>" as the first argument. Example: > 662 :menu <silent> Settings.Ignore\ case :set ic<CR> 663The ":set ic" will not be echoed when using this menu. Messages from the 664executed command are still given though. To shut them up too, add a ":silent" 665in the executed command: > 666 :menu <silent> Search.Header :exe ":silent normal /Header\r"<CR> 667"<silent>" may also appear just after "<special>" or "<script>". 668 669 *:menu-<special>* *:menu-special* 670Define a menu with <> notation for special keys, even though the "<" flag 671may appear in 'cpoptions'. This is useful if the side effect of setting 672'cpoptions' is not desired. Example: > 673 :menu <special> Search.Header /Header<CR> 674"<special>" must appear as the very first argument to the ":menu" command or 675just after "<silent>" or "<script>". 676 677 *:menu-<script>* *:menu-script* 678The "to" part of the menu will be inspected for mappings. If you don't want 679this, use the ":noremenu" command (or the similar one for a specific mode). 680If you do want to use script-local mappings, add "<script>" as the very first 681argument to the ":menu" command or just after "<silent>" or "<special>". 682 683 *menu-priority* 684You can give a priority to a menu. Menus with a higher priority go more to 685the right. The priority is given as a number before the ":menu" command. 686Example: > 687 :80menu Buffer.next :bn<CR> 688 689The default menus have these priorities: 690 File 10 691 Edit 20 692 Tools 40 693 Syntax 50 694 Buffers 60 695 Window 70 696 Help 9999 697 698When no or zero priority is given, 500 is used. 699The priority for the PopUp menu is not used. 700 701The Help menu will be placed on the far right side of the menu bar on systems 702which support this (Motif and GTK+). For GTK+ 2 and 3, this is not done 703anymore because right-aligning the Help menu is now discouraged UI design. 704 705You can use a priority higher than 9999, to make it go after the Help menu, 706but that is non-standard and is discouraged. The highest possible priority is 707about 32000. The lowest is 1. 708 709 *sub-menu-priority* 710The same mechanism can be used to position a sub-menu. The priority is then 711given as a dot-separated list of priorities, before the menu name: > 712 :menu 80.500 Buffer.next :bn<CR> 713Giving the sub-menu priority is only needed when the item is not to be put 714in a normal position. For example, to put a sub-menu before the other items: > 715 :menu 80.100 Buffer.first :brew<CR> 716Or to put a sub-menu after the other items, and further items with default 717priority will be put before it: > 718 :menu 80.900 Buffer.last :blast<CR> 719When a number is missing, the default value 500 will be used: > 720 :menu .900 myMenu.test :echo "text"<CR> 721The menu priority is only used when creating a new menu. When it already 722existed, e.g., in another mode, the priority will not change. Thus, the 723priority only needs to be given the first time a menu is used. 724An exception is the PopUp menu. There is a separate menu for each mode 725(Normal, Op-pending, Visual, Insert, Cmdline). The order in each of these 726menus can be different. This is different from menu-bar menus, which have 727the same order for all modes. 728NOTE: sub-menu priorities currently don't work for all versions of the GUI. 729 730 *menu-separator* *E332* 731Menu items can be separated by a special item that inserts some space between 732items. Depending on the system this is displayed as a line or a dotted line. 733These items must start with a '-' and end in a '-'. The part in between is 734used to give it a unique name. Priorities can be used as with normal items. 735Example: > 736 :menu Example.item1 :do something 737 :menu Example.-Sep- : 738 :menu Example.item2 :do something different 739Note that the separator also requires a rhs. It doesn't matter what it is, 740because the item will never be selected. Use a single colon to keep it 741simple. 742 743 *gui-toolbar* 744The toolbar is currently available in the Win32, Athena, Motif, GTK+ (X11), 745and Photon GUI. It should turn up in other GUIs in due course. The 746default toolbar is setup in menu.vim. 747The display of the toolbar is controlled by the 'guioptions' letter 'T'. You 748can thus have menu & toolbar together, or either on its own, or neither. 749The appearance is controlled by the 'toolbar' option. You can choose between 750an image, text or both. 751 752 *toolbar-icon* 753The toolbar is defined as a special menu called ToolBar, which only has one 754level. Vim interprets the items in this menu as follows: 7551) If an "icon=" argument was specified, the file with this name is used. 756 The file can either be specified with the full path or with the base name. 757 In the last case it is searched for in the "bitmaps" directory in 758 'runtimepath', like in point 3. Examples: > 759 :amenu icon=/usr/local/pixmaps/foo_icon.xpm ToolBar.Foo :echo "Foo"<CR> 760 :amenu icon=FooIcon ToolBar.Foo :echo "Foo"<CR> 761< Note that in the first case the extension is included, while in the second 762 case it is omitted. 763 If the file cannot be opened the next points are tried. 764 A space in the file name must be escaped with a backslash. 765 A menu priority must come _after_ the icon argument: > 766 :amenu icon=foo 1.42 ToolBar.Foo :echo "42!"<CR> 7672) An item called 'BuiltIn##', where ## is a number, is taken as number ## of 768 the built-in bitmaps available in Vim. Currently there are 31 numbered 769 from 0 to 30 which cover most common editing operations |builtin-tools|. > 770 :amenu ToolBar.BuiltIn22 :call SearchNext("back")<CR> 7713) An item with another name is first searched for in the directory 772 "bitmaps" in 'runtimepath'. If found, the bitmap file is used as the 773 toolbar button image. Note that the exact filename is OS-specific: For 774 example, under Win32 the command > 775 :amenu ToolBar.Hello :echo "hello"<CR> 776< would find the file 'hello.bmp'. Under GTK+/X11 it is 'Hello.xpm'. With 777 GTK+ 2 the files 'Hello.png', 'Hello.xpm' and 'Hello.bmp' are checked for 778 existence, and the first one found would be used. 779 For MS-Windows and GTK+ 2 the bitmap is scaled to fit the button. For 780 MS-Windows a size of 18 by 18 pixels works best. 781 For MS-Windows the bitmap should have 16 colors with the standard palette. 782 The light grey pixels will be changed to the Window frame color and the 783 dark grey pixels to the window shadow color. More colors might also work, 784 depending on your system. 7854) If the bitmap is still not found, Vim checks for a match against its list 786 of built-in names. Each built-in button image has a name. 787 So the command > 788 :amenu ToolBar.Open :e 789< will show the built-in "open a file" button image if no open.bmp exists. 790 All the built-in names can be seen used in menu.vim. 7915) If all else fails, a blank, but functioning, button is displayed. 792 793 *builtin-tools* 794nr Name Normal action ~ 79500 New open new window 79601 Open browse for file to open in current window 79702 Save write buffer to file 79803 Undo undo last change 79904 Redo redo last undone change 80005 Cut delete selected text to clipboard 80106 Copy copy selected text to clipboard 80207 Paste paste text from clipboard 80308 Print print current buffer 80409 Help open a buffer on Vim's builtin help 80510 Find start a search command 80611 SaveAll write all modified buffers to file 80712 SaveSesn write session file for current situation 80813 NewSesn write new session file 80914 LoadSesn load session file 81015 RunScript browse for file to run as a Vim script 81116 Replace prompt for substitute command 81217 WinClose close current window 81318 WinMax make current window use many lines 81419 WinMin make current window use few lines 81520 WinSplit split current window 81621 Shell start a shell 81722 FindPrev search again, backward 81823 FindNext search again, forward 81924 FindHelp prompt for word to search help for 82025 Make run make and jump to first error 82126 TagJump jump to tag under the cursor 82227 RunCtags build tags for files in current directory 82328 WinVSplit split current window vertically 82429 WinMaxWidth make current window use many columns 82530 WinMinWidth make current window use few columns 826 827 *hidden-menus* *win32-hidden-menus* 828In the Win32 and GTK+ GUI, starting a menu name with ']' excludes that menu 829from the main menu bar. You must then use the |:popup| or |:tearoff| command 830to display it. 831 832 *window-toolbar* *WinBar* 833Each window can have a local toolbar. This uses the first line of the window, 834thus reduces the space for the text by one line. The items in the toolbar 835must start with "WinBar". 836 837Only text can be used. When using Unicode, special characters can be used to 838make the items look like icons. 839 840If the items do not fit then the last ones cannot be used. The toolbar does 841not wrap. 842 843Note that Vim may be in any mode when executing these commands. The menu 844should be defined for Normal mode and will be executed without changing the 845current mode. Thus if the current window is in Visual mode and the menu 846command does not intentionally change the mode, Vim will remain in Visual 847mode. Best is to use `:nnoremenu` to avoid side effects. 848 849Example for debugger tools: > 850 nnoremenu 1.10 WinBar.Step :Step<CR> 851 nnoremenu 1.20 WinBar.Next :Next<CR> 852 nnoremenu 1.30 WinBar.Finish :Finish<CR> 853 nnoremenu 1.40 WinBar.Cont :Continue<CR> 854< 855The window toolbar uses the ToolbarLine and ToolbarButton highlight groups. 856 857When splitting the window the window toolbar is not copied to the new window. 858 859 *popup-menu* 860In the Win32, GTK+, Motif, Athena and Photon GUI, you can define the 861special menu "PopUp". This is the menu that is displayed when the right mouse 862button is pressed, if 'mousemodel' is set to popup or popup_setpos. 863Example: > 864 nnoremenu 1.40 PopUp.&Paste "+gP 865 menu PopUp 866 867 8685.3 Showing What Menus Are Mapped To *showing-menus* 869 870To see what an existing menu is mapped to, use just one argument after the 871menu commands (just like you would with the ":map" commands). If the menu 872specified is a submenu, then all menus under that hierarchy will be shown. 873If no argument is given after :menu at all, then ALL menu items are shown 874for the appropriate mode (e.g., Command-line mode for :cmenu). 875 876Special characters in the list, just before the rhs: 877* The menu was defined with "nore" to disallow remapping. 878& The menu was defined with "<script>" to allow remapping script-local 879 mappings only. 880s The menu was defined with "<silent>" to avoid showing what it is 881 mapped to when triggered. 882- The menu was disabled. 883 884Note that hitting <Tab> while entering a menu name after a menu command may 885be used to complete the name of the menu item. 886 887 8885.4 Executing Menus *execute-menus* 889 890 *:em* *:emenu* *E334* *E335* 891:[range]em[enu] {menu} Execute {menu} from the command line. 892 The default is to execute the Normal mode 893 menu. If a range is specified, it executes 894 the Visual mode menu. 895 If used from <c-o>, it executes the 896 insert-mode menu Eg: > 897 :emenu File.Exit 898 899:[range]em[enu] {mode} {menu} Like above, but execute the menu for {mode}: 900 'n': |:nmenu| Normal mode 901 'v': |:vmenu| Visual mode 902 's': |:smenu| Select mode 903 'o': |:omenu| Operator-pending mode 904 't': |:tlmenu| Terminal mode 905 'i': |:imenu| Insert mode 906 'c': |:cmenu| Cmdline mode 907 908 909If the console-mode vim has been compiled with WANT_MENU defined, you can 910use :emenu to access useful menu items you may have got used to from GUI 911mode. See 'wildmenu' for an option that works well with this. See 912|console-menus| for an example. 913 914When using a range, if the lines match with '<,'>, then the menu is executed 915using the last visual selection. 916 917 9185.5 Deleting Menus *delete-menus* 919 920 *:unme* *:unmenu* 921 *:aun* *:aunmenu* 922To delete a menu item or a whole submenu, use the unmenu commands, which are 923analogous to the unmap commands. Eg: > 924 :unmenu! Edit.Paste 925 926This will remove the Paste item from the Edit menu for Insert and 927Command-line modes. 928 929Note that hitting <Tab> while entering a menu name after an umenu command 930may be used to complete the name of the menu item for the appropriate mode. 931 932To remove all menus use: *:unmenu-all* > 933 :unmenu * " remove all menus in Normal and visual mode 934 :unmenu! * " remove all menus in Insert and Command-line mode 935 :aunmenu * " remove all menus in all modes, except for Terminal 936 " mode 937 :tlunmenu * " remove all menus in Terminal mode 938 939If you want to get rid of the menu bar: > 940 :set guioptions-=m 941 942 9435.6 Disabling Menus *disable-menus* 944 945 *:menu-disable* *:menu-enable* 946If you do not want to remove a menu, but disable it for a moment, this can be 947done by adding the "enable" or "disable" keyword to a ":menu" command. 948Examples: > 949 :menu disable &File.&Open\.\.\. 950 :amenu enable * 951 :amenu disable &Tools.* 952 953The command applies to the modes as used with all menu commands. Note that 954characters like "&" need to be included for translated names to be found. 955When the argument is "*", all menus are affected. Otherwise the given menu 956name and all existing submenus below it are affected. 957 958 9595.7 Examples for Menus *menu-examples* 960 961Here is an example on how to add menu items with menu's! You can add a menu 962item for the keyword under the cursor. The register "z" is used. > 963 964 :nmenu Words.Add\ Var wb"zye:menu! Words.<C-R>z <C-R>z<CR> 965 :nmenu Words.Remove\ Var wb"zye:unmenu! Words.<C-R>z<CR> 966 :vmenu Words.Add\ Var "zy:menu! Words.<C-R>z <C-R>z <CR> 967 :vmenu Words.Remove\ Var "zy:unmenu! Words.<C-R>z<CR> 968 :imenu Words.Add\ Var <Esc>wb"zye:menu! Words.<C-R>z <C-R>z<CR>a 969 :imenu Words.Remove\ Var <Esc>wb"zye:unmenu! Words.<C-R>z<CR>a 970 971(the rhs is in <> notation, you can copy/paste this text to try out the 972mappings, or put these lines in your gvimrc; "<C-R>" is CTRL-R, "<CR>" is 973the <CR> key. |<>|) 974 975 *tooltips* *menu-tips* 9765.8 Tooltips & Menu tips 977 978See section |42.4| in the user manual. 979 980 *:tmenu* *:tm* 981:tm[enu] {menupath} {rhs} Define a tip for a menu or tool. {only in 982 X11 and Win32 GUI} 983 984:tm[enu] [menupath] List menu tips. {only in X11 and Win32 GUI} 985 986 *:tunmenu* *:tu* 987:tu[nmenu] {menupath} Remove a tip for a menu or tool. 988 {only in X11 and Win32 GUI} 989 990Note: To create menus for terminal mode, use |:tlmenu| instead. 991 992When a tip is defined for a menu item, it appears in the command-line area 993when the mouse is over that item, much like a standard Windows menu hint in 994the status bar. (Except when Vim is in Command-line mode, when of course 995nothing is displayed.) 996When a tip is defined for a ToolBar item, it appears as a tooltip when the 997mouse pauses over that button, in the usual fashion. Use the |hl-Tooltip| 998highlight group to change its colors. 999 1000A "tip" can be defined for each menu item. For example, when defining a menu 1001item like this: > 1002 :amenu MyMenu.Hello :echo "Hello"<CR> 1003The tip is defined like this: > 1004 :tmenu MyMenu.Hello Displays a greeting. 1005And delete it with: > 1006 :tunmenu MyMenu.Hello 1007 1008Tooltips are currently only supported for the X11 and Win32 GUI. However, they 1009should appear for the other gui platforms in the not too distant future. 1010 1011The ":tmenu" command works just like other menu commands, it uses the same 1012arguments. ":tunmenu" deletes an existing menu tip, in the same way as the 1013other unmenu commands. 1014 1015If a menu item becomes invalid (i.e. its actions in all modes are deleted) Vim 1016deletes the menu tip (and the item) for you. This means that :aunmenu deletes 1017a menu item - you don't need to do a :tunmenu as well. 1018 1019 10205.9 Popup Menus 1021 1022In the Win32 and GTK+ GUI, you can cause a menu to popup at the cursor. 1023This behaves similarly to the PopUp menus except that any menu tree can 1024be popped up. 1025 1026This command is for backwards compatibility, using it is discouraged, because 1027it behaves in a strange way. 1028 1029 *:popup* *:popu* 1030:popu[p] {name} Popup the menu {name}. The menu named must 1031 have at least one subentry, but need not 1032 appear on the menu-bar (see |hidden-menus|). 1033 {only available for Win32 and GTK GUI or in 1034 the terminal} 1035 1036:popu[p]! {name} Like above, but use the position of the mouse 1037 pointer instead of the cursor. 1038 In the terminal this is the last known 1039 position, which is usually at the last click 1040 or release (mouse movement is irrelevant). 1041 1042Example: > 1043 :popup File 1044will make the "File" menu (if there is one) appear at the text cursor (mouse 1045pointer if ! was used). > 1046 1047 :amenu ]Toolbar.Make :make<CR> 1048 :popup ]Toolbar 1049This creates a popup menu that doesn't exist on the main menu-bar. 1050 1051Note that in the GUI the :popup command will return immediately, before a 1052selection has been made. In the terminal the commands waits for the user to 1053make a selection. 1054 1055Note that a menu that starts with ']' will not be displayed. 1056 1057============================================================================== 10586. Font 1059 1060This section describes font related options. 1061 1062GUIFONT *gui-font* 1063 1064'guifont' is the option that tells Vim what font to use. In its simplest form 1065the value is just one font name. It can also be a list of font names 1066separated with commas. The first valid font is used. When no valid font can 1067be found you will get an error message. 1068 1069On systems where 'guifontset' is supported (X11) and 'guifontset' is not 1070empty, then 'guifont' is not used. See |xfontset|. 1071 1072Note: As to the GTK GUIs, no error is given against any invalid names, and the 1073first element of the list is always picked up and made use of. This is 1074because, instead of identifying a given name with a font, the GTK GUIs use it 1075to construct a pattern and try to look up a font which best matches the 1076pattern among available fonts, and this way, the matching never fails. An 1077invalid name doesn't matter because a number of font properties other than 1078name will do to get the matching done. 1079 1080Spaces after a comma are ignored. To include a comma in a font name precede 1081it with a backslash. Setting an option requires an extra backslash before a 1082space and a backslash. See also |option-backslash|. For example: > 1083 :set guifont=Screen15,\ 7x13,font\\,with\\,commas 1084will make Vim try to use the font "Screen15" first, and if it fails it will 1085try to use "7x13" and then "font,with,commas" instead. 1086 1087If none of the fonts can be loaded, Vim will keep the current setting. If an 1088empty font list is given, Vim will try using other resource settings (for X, 1089it will use the Vim.font resource), and finally it will try some builtin 1090default which should always be there ("7x13" in the case of X). The font 1091names given should be "normal" fonts. Vim will try to find the related bold 1092and italic fonts. 1093 1094For Win32, GTK, Motif, Mac OS and Photon: > 1095 :set guifont=* 1096will bring up a font requester, where you can pick the font you want. 1097 1098The font name depends on the GUI used. See |setting-guifont| for a way to set 1099'guifont' for various systems. 1100 1101For the GTK+ 2 and 3 GUIs, the font name looks like this: > 1102 :set guifont=Andale\ Mono\ 11 1103That's all. XLFDs are not used. For Chinese this is reported to work well: > 1104 if has("gui_gtk2") 1105 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12 1106 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12 1107 endif 1108< 1109(Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI) 1110 1111For Mac OSX you can use something like this: > 1112 :set guifont=Monaco:h10 1113 1114Mono-spaced fonts *E236* 1115 1116Note that the fonts must be mono-spaced (all characters have the same width). 1117An exception is GTK: all fonts are accepted, but mono-spaced fonts look best. 1118 1119To preview a font on X11, you might be able to use the "xfontsel" program. 1120The "xlsfonts" program gives a list of all available fonts. 1121 1122For the Win32 GUI *E244* *E245* 1123- Takes these options in the font name (use a ':' to separate the options): 1124 hXX - height is XX (points, can be floating-point) 1125 wXX - width is XX (points, can be floating-point) 1126 WXX - weight is XX (see Note on Weights below) 1127 b - bold. This is equivalent to setting the weight to 700. 1128 i - italic 1129 u - underline 1130 s - strikeout 1131 cXX - character set XX. Valid charsets are: ANSI, ARABIC, BALTIC, 1132 CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK, HANGEUL, 1133 HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS, SYMBOL, THAI, 1134 TURKISH and VIETNAMESE. Normally you would use "cDEFAULT". 1135 qXX - quality XX. Valid quality names are: PROOF, DRAFT, ANTIALIASED, 1136 NONANTIALIASED, CLEARTYPE and DEFAULT. Normally you would use 1137 "qDEFAULT". 1138 Some quality values are not supported in legacy OSs. 1139- A '_' can be used in the place of a space, so you don't need to use 1140 backslashes to escape the spaces. 1141Examples: > 1142 :set guifont=courier_new:h12:w5:b:cRUSSIAN 1143 :set guifont=Andale_Mono:h7.5:w4.5 1144 1145See also |font-sizes|. 1146 1147Note on Weights: Fonts often come with a variety of weights. "Normal" weights 1148in Windows have a value of 400 and, left unspecified, this is the value that 1149will be used when attempting to find fonts. Windows will often match fonts 1150based on their weight with higher priority than the font name which means a 1151Book or Medium variant of a font might be used despite specifying a Light or 1152ExtraLight variant. If you are experiencing heavier weight substitution, then 1153explicitly setting a lower weight value may mitigate against this unwanted 1154substitution. 1155 1156 1157GUIFONTWIDE *gui-fontwide* 1158 1159When not empty, 'guifontwide' specifies a comma-separated list of fonts to be 1160used for double-width characters. The first font that can be loaded is used. 1161 1162Note: The size of these fonts must be exactly twice as wide as the one 1163specified with 'guifont' and the same height. If there is a mismatch then the 1164text will not be drawn correctly. 1165 1166All GUI versions but GTK+: 1167 1168'guifontwide' is only used when 'encoding' is set to "utf-8" and 'guifontset' 1169is empty or invalid. 1170When 'guifont' is set and a valid font is found in it and 'guifontwide' is 1171empty Vim will attempt to find a matching double-width font and set 1172'guifontwide' to it. 1173 1174GTK+ GUI only: *guifontwide_gtk* 1175 1176If set and valid, 'guifontwide' is always used for double width characters, 1177even if 'encoding' is not set to "utf-8". 1178Vim does not attempt to find an appropriate value for 'guifontwide' 1179automatically. If 'guifontwide' is empty Pango/Xft will choose the font for 1180characters not available in 'guifont'. Thus you do not need to set 1181'guifontwide' at all unless you want to override the choice made by Pango/Xft. 1182 1183Windows +multibyte only: *guifontwide_win_mbyte* 1184 1185If set and valid, 'guifontwide' is used for IME instead of 'guifont'. 1186 1187============================================================================== 11887. Extras *gui-extras* 1189 1190This section describes other features which are related to the GUI. 1191 1192- With the GUI, there is no wait for one second after hitting escape, because 1193 the key codes don't start with <Esc>. 1194 1195- Typing ^V followed by a special key in the GUI will insert "<Key>", since 1196 the internal string used is meaningless. Modifiers may also be held down to 1197 get "<Modifiers-Key>". 1198 1199- In the GUI, the modifiers SHIFT, CTRL, and ALT (or META) may be used within 1200 mappings of special keys and mouse events. 1201 E.g.: :map <M-LeftDrag> <LeftDrag> 1202 1203- In the GUI, several normal keys may have modifiers in mappings etc, these 1204 are <Space>, <Tab>, <NL>, <CR>, <Esc>. 1205 1206- To check in a Vim script if the GUI is being used, you can use something 1207 like this: > 1208 1209 if has("gui_running") 1210 echo "yes, we have a GUI" 1211 else 1212 echo "Boring old console" 1213 endif 1214< *setting-guifont* 1215- When you use the same vimrc file on various systems, you can use something 1216 like this to set options specifically for each type of GUI: > 1217 1218 if has("gui_running") 1219 if has("gui_gtk2") 1220 :set guifont=Luxi\ Mono\ 12 1221 elseif has("x11") 1222 " Also for GTK 1 1223 :set guifont=*-lucidatypewriter-medium-r-normal-*-*-180-*-*-m-*-* 1224 elseif has("gui_win32") 1225 :set guifont=Luxi_Mono:h12:cANSI 1226 endif 1227 endif 1228 1229A recommended Japanese font is MS Mincho. You can find info here: 1230http://www.lexikan.com/mincho.htm 1231 1232============================================================================== 12338. Shell Commands *gui-shell* 1234 1235For the X11 GUI the external commands are executed inside the gvim window. 1236See |gui-pty|. 1237 1238WARNING: Executing an external command from the X11 GUI will not always work. 1239"normal" commands like "ls", "grep" and "make" mostly work fine. 1240Commands that require an intelligent terminal like "less" and "ispell" won't 1241work. Some may even hang and need to be killed from another terminal. So be 1242careful! 1243 1244For the Win32 GUI the external commands are executed in a separate window. 1245See |gui-shell-win32|. 1246 1247 vim:tw=78:sw=4:ts=8:noet:ft=help:norl: 1248