Mercurial > vim
annotate runtime/doc/gui_w32.txt @ 2579:1c00ea3641a8 v7.3.005
updated for version 7.3.005
Problem: Crash when using undotree(). (Christian Brabandt)
Solution: Increase the list reference count. Add a test for undotree()
(Lech Lorens)
author | Bram Moolenaar <bram@vim.org> |
---|---|
date | Tue, 14 Sep 2010 12:47:37 +0200 |
parents | 073ff46fe397 |
children | 85c5a72551e2 |
rev | line source |
---|---|
2572
ee53a39d5896
Last changes for the 7.3 release!
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1 *gui_w32.txt* For Vim version 7.3. Last change: 2007 Aug 30 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 Vim's Win32 Graphical User Interface *gui-w32* *win32-gui* | |
8 | |
9 1. Starting the GUI |gui-w32-start| | |
10 2. Vim as default editor |vim-default-editor| | |
11 3. Using the clipboard |gui-clipboard| | |
12 4. Shell Commands |gui-shell-win32| | |
13 5. Special colors |win32-colors| | |
14 6. Windows dialogs & browsers |gui-w32-dialogs| | |
15 7. Command line arguments |gui-w32-cmdargs| | |
16 8. Various |gui-w32-various| | |
17 | |
18 Other relevant documentation: | |
19 |gui.txt| For generic items of the GUI. | |
20 |os_win32.txt| For Win32 specific items. | |
21 | |
22 {Vi does not have a Windows GUI} | |
23 | |
24 ============================================================================== | |
25 1. Starting the GUI *gui-w32-start* | |
26 | |
27 The Win32 GUI version of Vim will always start the GUI, no matter how you | |
28 start it or what it's called. | |
29 | |
30 The GUI will always run in the Windows subsystem. Mostly shells automatically | |
31 return with a command prompt after starting gvim. If not, you should use the | |
32 "start" command: > | |
33 start gvim [options] file .. | |
34 | |
35 Note: All fonts (bold, italic) must be of the same size!!! If you don't do | |
36 this, text will disappear or mess up the display. Vim does not check the font | |
37 sizes. It's the size in screen pixels that must be the same. Note that some | |
38 fonts that have the same point size don't have the same pixel size! | |
39 Additionally, the positioning of the fonts must be the same (ascent and | |
40 descent). | |
41 | |
42 The Win32 GUI has an extra menu item: "Edit/Select Font". It brings up the | |
43 standard Windows font selector. | |
44 | |
45 Setting the menu height doesn't work for the Win32 GUI. | |
46 | |
47 *gui-win32-maximized* | |
48 If you want Vim to start with a maximized window, add this command to your | |
49 vimrc or gvimrc file: > | |
50 au GUIEnter * simalt ~x | |
51 < | |
52 *gui-w32s* | |
53 There is a specific version of gvim.exe that runs under the Win32s subsystem | |
54 of Windows 3.1 or 3.11. See |win32s|. | |
55 | |
1376 | 56 |
57 Using Vim as a plugin *gui-w32-windowid* | |
58 | |
59 When gvim starts up normally, it creates its own top level window. If you | |
60 pass Vim the command-line option |--windowid| with a decimal or hexadecimal | |
61 value, Vim will create a window that is a child of the window with the given | |
62 ID. This enables Vim to act as a plugin in another application. This really | |
63 is a programmer's interface, and is of no use without a supporting application | |
64 to spawn Vim correctly. | |
65 | |
7 | 66 ============================================================================== |
67 2. Vim as default editor *vim-default-editor* | |
68 | |
69 To set Vim as the default editor for a file type: | |
70 1. Start a Windows Explorer | |
236 | 71 2. Choose View/Options -> File Types |
7 | 72 3. Select the path to gvim for every file type that you want to use it for. |
73 (you can also use three spaces in the file type field, for files without an | |
74 extension). | |
75 In the "open" action, use: > | |
76 gvim "%1" | |
77 < The quotes are required for using file names with embedded spaces. | |
78 You can also use this: > | |
79 gvim "%L" | |
80 < This should avoid short (8.3 character) file names in some situations. But | |
81 I'm not sure if this works everywhere. | |
82 | |
83 When you open a file in Vim by double clicking it, Vim changes to that | |
84 file's directory. | |
85 | |
86 If you want Vim to start full-screen, use this for the Open action: > | |
87 gvim -c "simalt ~x" "%1" | |
88 | |
89 Another method, which also works when you put Vim in another directory (e.g., | |
90 when you have got a new version): | |
91 1. select a file you want to use Vim with | |
92 2. <Shift-F10> | |
93 3. select "Open With..." menu entry | |
94 4. click "Other..." | |
95 5. browse to the (new) location of Vim and click "Open" | |
96 6. make "Always Use this program..." checked | |
97 7. <OK> | |
98 | |
99 *send-to-menu* *sendto* | |
100 You can also install Vim in the "Send To" menu: | |
101 1. Start a Windows Explorer | |
102 2. Navigate to your sendto directory: | |
103 Windows 95: %windir%\sendto (e.g. "c:\windows\sendto") | |
104 Windows NT: %windir%\profiles\%user%\sendto (e.g. | |
105 "c:\winnt\profiles\mattha\sendto"). | |
106 3. Right-click in the file pane and select New->Shortcut | |
107 4. Follow the shortcut wizard, using the full path to VIM/GVIM. | |
108 | |
109 When you 'send a file to Vim', Vim changes to that file's directory. Note, | |
110 however, that any long directory names will appear in their short (MS-DOS) | |
111 form. This is a limitation of the Windows "Send To" mechanism. | |
112 | |
113 *notepad* | |
114 You could replace notepad.exe with gvim.exe, but that has a few side effects. | |
115 Some programs rely on notepad arguments, which are not recognized by Vim. For | |
116 example "notepad -p" is used by some applications to print a file. It's | |
117 better to leave notepad where it is and use another way to start Vim. | |
118 | |
119 *win32-popup-menu* | |
120 A more drastic approach is to install an "Edit with Vim" entry in the popup | |
121 menu for the right mouse button. With this you can edit any file with Vim. | |
122 | |
123 This can co-exist with the file associations mentioned above. The difference | |
124 is that the file associations will make starting Vim the default action. With | |
125 the "Edit with Vim" menu entry you can keep the existing file association for | |
126 double clicking on the file, and edit the file with Vim when you want. For | |
127 example, you can associate "*.mak" with your make program. You can execute | |
128 the makefile by double clicking it and use the "Edit with Vim" entry to edit | |
129 the makefile. | |
130 | |
131 You can select any files and right-click to see a menu option called "Edit | |
1668 | 132 with gvim". Choosing this menu option will invoke gvim with the file you have |
7 | 133 selected. If you select multiple files, you will find two gvim-related menu |
134 options: | |
135 "Edit with multiple gvims" -- one gvim for each file in the selection | |
136 "Edit with single gvim" -- one gvim for all the files in the selection | |
137 And if there already is a gvim running: | |
138 "Edit with existing gvim" -- edit the file with the running gvim | |
139 | |
140 *install-registry* | |
141 You can add the "Edit with Vim" menu entry in an easy way by using the | |
142 "install.exe" program. It will add several registry entries for you. | |
143 | |
144 You can also do this by hand. This is complicated! Use the install.exe if | |
145 you can. | |
146 | |
147 1. Start the registry editor with "regedit". | |
148 2. Add these keys: | |
149 key value name value ~ | |
150 HKEY_CLASSES_ROOT\CLSID\{51EEE242-AD87-11d3-9C1E-0090278BBD99} | |
151 {default} Vim Shell Extension | |
152 HKEY_CLASSES_ROOT\CLSID\{51EEE242-AD87-11d3-9C1E-0090278BBD99}\InProcServer32 | |
153 {default} {path}\gvimext.dll | |
154 ThreadingModel Apartment | |
155 HKEY_CLASSES_ROOT\*\shellex\ContextMenuHandlers\gvim | |
156 {default} {51EEE242-AD87-11d3-9C1E-0090278BBD99} | |
157 HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Shell Extensions\Approved | |
158 {51EEE242-AD87-11d3-9C1E-0090278BBD99} | |
159 Vim Shell Extension | |
160 HKEY_LOCAL_MACHINE\Software\Vim\Gvim | |
161 path {path}\gvim.exe | |
162 HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall\vim 5.6 | |
163 DisplayName Vim 5.6: Edit with Vim popup menu entry | |
164 UninstallString {path}\uninstal.exe | |
165 | |
166 Replace {path} with the path that leads to the executable. | |
167 Don't type {default}, this is the value for the key itself. | |
168 | |
169 To remove "Edit with Vim" from the popup menu, just remove the registry | |
170 entries mentioned above. The "uninstal.exe" program can do this for you. You | |
171 can also use the entry in the Windows standard "Add/Remove Programs" list. | |
172 | |
173 If you notice that this entry overrules other file type associations, set | |
174 those associations again by hand (using Windows Explorer, see above). This | |
175 only seems to happen on some Windows NT versions (Windows bug?). Procedure: | |
176 1. Find the name of the file type. This can be done by starting the registry | |
177 editor, and searching for the extension in \\HKEY_CLASSES_ROOT | |
178 2. In a Windows Explorer, use View/Options/File Types. Search for the file | |
179 type in the list and click "Edit". In the actions list, you can select on | |
180 to be used as the default (normally the "open" action) and click on the | |
181 "Set Default" button. | |
182 | |
183 | |
184 Vim in the "Open With..." context menu *win32-open-with-menu* | |
185 | |
186 If you use the Vim install program you have the choice to add Vim to the "Open | |
187 With..." menu. This means you can use Vim to edit many files. Not every file | |
188 (for unclear reasons...), thus the "Edit with Vim" menu entry is still useful. | |
189 | |
190 One reason to add this is to be able to edit HTML files directly from Internet | |
191 Explorer. To enable this use the "Tools" menu, "Internet Options..." entry. | |
192 In the dialog select the "Programs" tab and select Vim in the "HTML editor" | |
193 choice. If it's not there than installing didn't work properly. | |
194 | |
195 Doing this manually can be done with this script: | |
196 | |
197 ---------------------------------------------------------- | |
198 REGEDIT4 | |
199 | |
200 [HKEY_CLASSES_ROOT\Applications\gvim.exe] | |
201 | |
202 [HKEY_CLASSES_ROOT\Applications\gvim.exe\shell] | |
203 | |
204 [HKEY_CLASSES_ROOT\Applications\gvim.exe\shell\edit] | |
205 | |
206 [HKEY_CLASSES_ROOT\Applications\gvim.exe\shell\edit\command] | |
207 @="c:\\vim\\vim62\\gvim.exe \"%1\"" | |
208 | |
209 [HKEY_CLASSES_ROOT\.htm\OpenWithList\gvim.exe] | |
210 | |
211 [HKEY_CLASSES_ROOT\*\OpenWithList\gvim.exe] | |
212 | |
213 ---------------------------------------------------------- | |
214 | |
215 Change the "c:\\vim\\vim62" bit to where gvim.exe is actually located. | |
216 | |
217 To uninstall this run the Vim uninstall program or manually delete the | |
218 registry entries with "regedit". | |
219 | |
220 ============================================================================== | |
221 3. Using the clipboard *gui-clipboard* | |
222 | |
223 Windows has a clipboard, where you can copy text to, and paste text from. Vim | |
224 supports this in several ways. For other systems see |gui-selections|. | |
225 | |
226 The "* register reflects the contents of the clipboard. |quotestar| | |
227 | |
228 When the "unnamed" string is included in the 'clipboard' option, the unnamed | |
229 register is the same. Thus you can yank to and paste from the clipboard | |
230 without prepending "* to commands. | |
231 | |
232 The 'a' flag in 'guioptions' is not included by default. This means that text | |
233 is only put on the clipboard when an operation is performed on it. Just | |
234 Visually selecting text doesn't put it on the clipboard. When the 'a' flag is | |
235 included, the text is copied to the clipboard even when it is not operated | |
236 upon. | |
237 | |
238 *mswin.vim* | |
239 To use the standard MS-Windows way of CTRL-X, CTRL-C and CTRL-V, use the | |
240 $VIMRUNTIME/mswin.vim script. You could add this line to your _vimrc file: > | |
241 source $VIMRUNTIME/mswin.vim | |
242 | |
243 Since CTRL-C is used to copy the text to the clipboard, it can't be used to | |
244 cancel an operation. Use CTRL-Break for that. | |
245 | |
1121 | 246 CTRL-Z is used for undo. This means you can't suspend Vim with this key, use |
247 |:suspend| instead (if it's supported at all). | |
81 | 248 |
167 | 249 *CTRL-V-alternative* *CTRL-Q* |
7 | 250 Since CTRL-V is used to paste, you can't use it to start a blockwise Visual |
251 selection. You can use CTRL-Q instead. You can also use CTRL-Q in Insert | |
252 mode and Command-line mode to get the old meaning of CTRL-V. But CTRL-Q | |
253 doesn't work for terminals when it's used for control flow. | |
254 | |
255 NOTE: The clipboard support still has a number of bugs. See |todo|. | |
256 | |
257 ============================================================================== | |
258 4. Shell Commands *gui-shell-win32* | |
259 | |
260 Vim uses another window for external commands, to make it possible to run any | |
261 command. The external command gets its own environment for running, just like | |
262 it was started from a DOS prompt. | |
263 | |
264 *win32-vimrun* | |
265 Executing an external command is done indirectly by the "vimrun" command. The | |
266 "vimrun.exe" must be in the path for this to work. Or it must be in the same | |
267 directory as the Vim executable. If "vimrun" cannot be found, the command is | |
268 executed directly, but then the DOS window closes immediately after the | |
269 external command has finished. | |
270 WARNING: If you close this window with the "X" button, and confirm the | |
271 question if you really want to kill the application, Vim may be killed too! | |
272 (This does not apply to commands run asynchronously with ":!start".) | |
273 | |
274 In Windows 95, the window in which the commands are executed is always 25x80 | |
275 characters, to be as DOS compatible as possible (this matters!). The default | |
236 | 276 system font is used. On NT, the window will be the default you have set up for |
277 "Console" in Control Panel. On Win32s, the properties of the DOS box are | |
7 | 278 determined by _default.pif in the windows directory. |
279 | |
280 *msdos-mode* | |
281 If you get a dialog that says "This program is set to run in MS-DOS mode..." | |
282 when you run an external program, you can solve this by changing the | |
283 properties of the associated shortcut: | |
284 - Use a Windows Explorer to find the command.com that is used. It can be | |
285 c:\command.com, c:\dos\command.com, c:\windows\command.com, etc. | |
286 - With the right mouse button, select properties of this command.com. | |
287 - In the Program tab select "Advanced". | |
288 - Unselect "MS-DOS mode". | |
289 - Click "OK" twice. | |
290 | |
291 *win32-!start* | |
292 Normally, Vim waits for a command to complete before continuing (this makes | |
293 sense for most shell commands which produce output for Vim to use). If you | |
294 want Vim to start a program and return immediately, you can use the following | |
295 syntax on W95 & NT: > | |
296 :!start {command} | |
236 | 297 On Win32s, you will have to go to another window instead. Don't forget that |
7 | 298 you must tell Windows 3.1x to keep executing a DOS command in the background |
299 while you switch back to Vim. | |
300 | |
301 ============================================================================== | |
302 5. Special colors *win32-colors* | |
303 | |
304 On Win32, the normal DOS colors can be used. See |dos-colors|. | |
305 | |
306 Additionally the system configured colors can also be used. These are known | |
307 by the names Sys_XXX, where XXX is the appropriate system color name, from the | |
308 following list (see the Win32 documentation for full descriptions). Case is | |
236 | 309 ignored. Note: On Win32s not all of these colors are supported. |
7 | 310 |
311 Sys_3DDKShadow Sys_3DFace Sys_BTNFace | |
312 Sys_3DHilight Sys_3DHighlight Sys_BTNHilight | |
313 Sys_BTNHighlight Sys_3DLight Sys_3DShadow | |
314 Sys_BTNShadow Sys_ActiveBorder Sys_ActiveCaption | |
315 Sys_AppWorkspace Sys_Background Sys_Desktop | |
316 Sys_BTNText Sys_CaptionText Sys_GrayText | |
317 Sys_Highlight Sys_HighlightText Sys_InactiveBorder | |
318 Sys_InactiveCaption Sys_InactiveCaptionText Sys_InfoBK | |
319 Sys_InfoText Sys_Menu Sys_MenuText | |
320 Sys_ScrollBar Sys_Window Sys_WindowFrame | |
321 Sys_WindowText | |
322 | |
323 Probably the most useful values are | |
324 Sys_Window Normal window background | |
325 Sys_WindowText Normal window text | |
326 Sys_Highlight Highlighted background | |
327 Sys_HighlightText Highlighted text | |
328 | |
329 These extra colors are also available: | |
330 Gray, Grey, LightYellow, SeaGreen, Orange, Purple, SlateBlue, Violet, | |
331 | |
332 *rgb.txt* | |
333 Additionally, colors defined by a "rgb.txt" file can be used. This file is | |
334 well known from X11. A few lines from it: > | |
335 | |
336 255 218 185 peach puff | |
337 205 133 63 peru | |
338 255 181 197 pink | |
339 | |
340 This shows the layout of the file: First the R, G and B value as a decimal | |
341 number, followed by the name of the color. The four fields are separated by | |
342 spaces. | |
343 | |
344 You can get an rgb.txt file from any X11 distribution. It is located in a | |
345 directory like "/usr/X11R6/lib/X11/". For Vim it must be located in the | |
346 $VIMRUNTIME directory. Thus the file can be found with "$VIMRUNTIME/rgb.txt". | |
347 | |
348 ============================================================================== | |
349 *gui-w32-dialogs* *dialog* | |
350 6. Windows dialogs & browsers | |
351 | |
352 The Win32 GUI can use familiar Windows components for some operations, as well | |
353 as the traditional interface shared with the console version. | |
354 | |
355 | |
356 6.1 Dialogs | |
357 | |
358 The dialogs displayed by the "confirm" family (i.e. the 'confirm' option, | |
359 |:confirm| command and |confirm()| function) are GUI-based rather than the | |
360 console-based ones used by other versions. The 'c' flag in 'guioptions' | |
361 changes this. | |
362 | |
363 | |
364 6.2 File Browsers | |
365 | |
366 When prepending ":browse" before file editing commands, a file requester is | |
367 used to allow you to select an existing file. See |:browse|. | |
368 | |
369 | |
370 6.3 Tearoff Menus | |
371 | |
372 The Win32 GUI emulates Motif's tear-off menus. At the top of each menu you | |
373 will see a small graphic "rip here" sign. Selecting it will cause a floating | |
374 window to be created with the same menu entries on it. The floating menu can | |
375 then be accessed just as if it was the original (including sub-menus), but | |
376 without having to go to the menu bar each time. | |
377 This is most useful if you find yourself using a command buried in a sub-menu | |
378 over and over again. | |
379 The tearoff menus can be positioned where you like, and always stay just above | |
236 | 380 the Main Vim window. You can get rid of them by closing them as usual; they |
7 | 381 also of course close when you exit Vim. |
382 | |
383 *:tearoff* *:te* | |
384 :te[aroff] {name} Tear-off the menu {name}. The menu named must have at | |
385 least one subentry, but need not appear on the | |
386 menu-bar (see |win32-hidden-menus|). | |
387 | |
388 Example: > | |
389 :tearoff File | |
390 will make the "File" menu (if there is one) appear as a tearoff menu. > | |
391 | |
392 :amenu ]Toolbar.Make :make<CR> | |
393 :tearoff ]Toolbar | |
394 This creates a floating menu that doesn't exist on the main menu-bar. | |
395 | |
396 Note that a menu that starts with ']' will not be displayed. | |
397 | |
398 ============================================================================== | |
399 7. Command line arguments *gui-w32-cmdargs* | |
400 | |
401 Analysis of a command line into parameters is not standardised in MS Windows. | |
402 Gvim has to provide logic to analyse a command line. This logic is likely to | |
403 be different from the default logic provided by a compilation system used to | |
404 build vim. The differences relate to unusual double quote (") usage. | |
405 The arguments "C:\My Music\freude.txt" and "+/Sch\"iller" are handled in the | |
406 same way. The argument "+/Sch""iller" may be handled different by gvim and | |
407 vim, depending what it was compiled with. | |
408 | |
409 The rules are: | |
410 a) A parameter is a sequence of graphic characters. | |
411 b) Parameters are separated by white space. | |
412 c) A parameter can be enclosed in double quotes to include white space. | |
413 d) A sequence of zero or more backslashes (\) and a double quote (") | |
236 | 414 is special. The effective number of backslashes is halved, rounded |
7 | 415 down. An even number of backslashes reverses the acceptability of |
416 spaces and tabs, an odd number of backslashes produces a literal | |
417 double quote. | |
418 | |
419 So: | |
420 " is a special double quote | |
421 \" is a literal double quote | |
422 \\" is a literal backslash and a special double quote | |
423 \\\" is a literal backslash and a literal double quote | |
424 \\\\" is 2 literal backslashes and a special double quote | |
425 \\\\\" is 2 literal backslashes and a literal double quote | |
426 etc. | |
427 | |
428 Example: > | |
429 gvim "C:\My Music\freude" +"set ignorecase" +/"\"foo\\" +\"bar\\\" | |
430 | |
431 opens "C:\My Music\freude" and executes the line mode commands: > | |
432 set ignorecase; /"foo\ and /bar\" | |
433 | |
434 ============================================================================== | |
435 8. Various *gui-w32-various* | |
436 | |
437 *gui-w32-printing* | |
438 The "File/Print" menu prints the text with syntax highlighting, see | |
439 |:hardcopy|. If you just want to print the raw text and have a default | |
440 printer installed this should also work: > | |
441 :w >>prn | |
442 | |
236 | 443 Vim supports a number of standard MS Windows features. Some of these are |
7 | 444 detailed elsewhere: see |'mouse'|, |win32-hidden-menus|. |
445 | |
446 *drag-n-drop-win32* | |
447 You can drag and drop one or more files into the Vim window, where they will | |
448 be opened as normal. See |drag-n-drop|. | |
449 | |
450 *:simalt* *:si* | |
451 :sim[alt] {key} simulate pressing {key} while holding Alt pressed. | |
452 {not in Vi} {only for Win32 versions} | |
453 | |
454 Normally, Vim takes control of all Alt-<Key> combinations, to increase the | |
236 | 455 number of possible mappings. This clashes with the standard use of Alt as the |
7 | 456 key for accessing menus. |
457 The quick way of getting standard behavior is to set the 'winaltkeys' option | |
458 to "yes". This however prevents you from mapping Alt keys at all. | |
459 Another way is to set 'winaltkeys' to "menu". Menu shortcut keys are then | |
460 handled by windows, other ALT keys can be mapped. This doesn't allow a | |
461 dependency on the current state though. | |
462 To get round this, the :simalt command allows Vim (when 'winaltkeys' is not | |
236 | 463 "yes") to fake a Windows-style Alt keypress. You can use this to map Alt key |
7 | 464 combinations (or anything else for that matter) to produce standard Windows |
236 | 465 actions. Here are some examples: > |
7 | 466 |
467 :map <M-f> :simalt f<CR> | |
468 This makes Alt-F pop down the 'File' menu (with the stock Menu.vim) by | |
469 simulating the keystrokes Alt, F. > | |
470 :map <M-Space> :simalt ~<CR> | |
236 | 471 This maps Alt-Space to pop down the system menu for the Vim window. Note that |
7 | 472 ~ is used by simalt to represent the <Space> character. > |
473 :map <C-n> :simalt ~n<CR> | |
236 | 474 Maps Control-N to produce the keys Alt-Space followed by N. This minimizes the |
7 | 475 Vim window via the system menu. |
476 | |
1121 | 477 Note that the key changes depending on the language you are using. |
478 | |
7 | 479 *intellimouse-wheel-problems* |
480 When using the Intellimouse mouse wheel causes Vim to stop accepting input, go | |
481 to: | |
482 ControlPanel - Mouse - Wheel - UniversalScrolling - Exceptions | |
483 | |
484 And add gvim to the list of applications. This problem only appears to happen | |
485 with the Intellimouse driver 2.2 and when "Universal Scrolling" is turned on. | |
486 | |
487 vim:tw=78:sw=4:ts=8:ft=help:norl: |