Mercurial > vim
annotate runtime/doc/gui_x11.txt @ 9744:6f5387822253 v7.4.2147
commit https://github.com/vim/vim/commit/abb71fbd399772d467aaa7b34b958b0f975c7e65
Author: Bram Moolenaar <Bram@vim.org>
Date: Tue Aug 2 22:51:42 2016 +0200
patch 7.4.2147
Problem: test_alot fails.
Solution: Close window.
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Tue, 02 Aug 2016 23:00:06 +0200 |
| parents | 47f17f66da3d |
| children | 03fa8a51e9dc |
| rev | line source |
|---|---|
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
1 *gui_x11.txt* For Vim version 7.4. Last change: 2016 Apr 08 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 5 | |
| 6 | |
| 7 Vim's Graphical User Interface *gui-x11* *GUI-X11* | |
| 8 *Athena* *Motif* | |
| 9 1. Starting the X11 GUI |gui-x11-start| | |
| 10 2. GUI Resources |gui-resources| | |
| 11 3. Shell Commands |gui-pty| | |
| 12 4. Various |gui-x11-various| | |
| 13 5. GTK version |gui-gtk| | |
| 14 6. GNOME version |gui-gnome| | |
| 856 | 15 7. KDE version |gui-kde| |
| 11 | 16 8. Compiling |gui-x11-compiling| |
| 17 9. X11 selection mechanism |x11-selection| | |
| 7 | 18 |
| 19 Other relevant documentation: | |
| 20 |gui.txt| For generic items of the GUI. | |
| 21 | |
| 22 {Vi does not have any of these commands} | |
| 23 | |
| 24 ============================================================================== | |
| 25 1. Starting the X11 GUI *gui-x11-start* *E665* | |
| 26 | |
| 27 Then you can run the GUI version of Vim in either of these ways: | |
| 28 gvim [options] [files...] | |
| 29 vim -g [options] [files...] | |
| 30 | |
| 31 So if you call the executable "gvim", or make "gvim" a link to the executable, | |
| 32 then the GUI version will automatically be used. Additional characters may be | |
| 33 added after "gvim", for example "gvim-5". | |
| 34 | |
| 35 You may also start up the GUI from within the terminal version by using one of | |
| 36 these commands: | |
| 37 :gui [++opt] [+cmd] [-f|-b] [files...] *:gu* *:gui* | |
| 38 :gvim [++opt] [+cmd] [-f|-b] [files...] *:gv* *:gvim* | |
| 39 The "-f" option runs Vim in the foreground. | |
| 40 The "-b" option runs Vim in the background (this is the default). | |
| 41 Also see |++opt| and |+cmd|. | |
| 42 | |
| 43 *gui-fork* | |
| 44 When the GUI is started, it does a fork() and exits the current process. | |
| 45 When gvim was started from a shell this makes the shell accept further | |
| 46 commands. If you don't want this (e.g. when using gvim for a mail program | |
| 47 that waits for gvim to exit), start gvim with "gvim -f", "vim -gf" or use | |
| 48 ":gui -f". Don't use "vim -fg", because "-fg" specifies the foreground | |
| 49 color. | |
| 50 | |
| 51 When using "gvim -f" and then ":gui", Vim will run in the foreground. The | |
| 52 "-f" argument will be remembered. To force running Vim in the background use | |
| 53 ":gui -b". | |
| 54 | |
| 55 "gvim --nofork" does the same as "gvim -f". | |
| 3082 | 56 *E851* *E852* |
| 57 When starting the GUI fails Vim will try to continue running in the terminal. | |
| 7 | 58 |
| 59 If you want the GUI to run in the foreground always, include the 'f' | |
| 60 flag in 'guioptions'. |-f|. | |
| 61 | |
| 62 ============================================================================== | |
| 63 2. GUI Resources *gui-resources* *.Xdefaults* | |
| 64 | |
| 11 | 65 If using the Motif or Athena version of the GUI (not for the KDE, GTK+ or Win32 |
| 7 | 66 version), a number of X resources are available. You should use Vim's class |
| 67 "Vim" when setting these. They are as follows: | |
| 68 | |
| 69 Resource name Meaning ~ | |
| 70 | |
| 71 reverseVideo Boolean: should reverse video be used? | |
| 72 background Color of background. | |
| 73 foreground Color of normal text. | |
| 74 scrollBackground Color of trough portion of scrollbars. | |
| 75 scrollForeground Color of slider and arrow portions of scrollbars. | |
| 76 menuBackground Color of menu backgrounds. | |
| 77 menuForeground Color of menu foregrounds. | |
| 78 tooltipForeground Color of tooltip and balloon foreground. | |
| 79 tooltipBackground Color of tooltip and balloon background. | |
| 80 | |
| 81 font Name of font used for normal text. | |
| 82 boldFont Name of font used for bold text. | |
| 83 italicFont Name of font used for italic text. | |
| 84 boldItalicFont Name of font used for bold, italic text. | |
| 85 menuFont Name of font used for the menus, used when compiled | |
| 86 without the |+xfontset| feature | |
| 87 menuFontSet Name of fontset used for the menus, used when compiled | |
| 88 with the |+xfontset| feature | |
| 89 tooltipFont Name of the font used for the tooltip and balloons. | |
| 90 When compiled with the |+xfontset| feature this is a | |
| 91 fontset name. | |
| 92 | |
| 93 geometry Initial geometry to use for gvim's window (default | |
| 94 is same size as terminal that started it). | |
| 95 scrollbarWidth Thickness of scrollbars. | |
| 96 borderWidth Thickness of border around text area. | |
| 97 menuHeight Height of the menu bar (only for Athena). | |
| 98 | |
| 99 A special font for italic, bold, and italic-bold text will only be used if | |
| 100 the user has specified one via a resource. No attempt is made to guess what | |
| 101 fonts should be used for these based on the normal text font. | |
| 102 | |
| 103 Note that the colors can also be set with the ":highlight" command, using the | |
| 104 "Normal", "Menu", "Tooltip", and "Scrollbar" groups. Example: > | |
| 105 :highlight Menu guibg=lightblue | |
| 106 :highlight Tooltip guibg=yellow | |
| 107 :highlight Scrollbar guibg=lightblue guifg=blue | |
| 108 :highlight Normal guibg=grey90 | |
| 109 < | |
| 110 *font-sizes* | |
| 111 Note: All fonts (except for the menu and tooltip) must be of the same size!!! | |
| 112 If you don't do this, text will disappear or mess up the display. Vim does | |
| 113 not check the font sizes. It's the size in screen pixels that must be the | |
| 114 same. Note that some fonts that have the same point size don't have the same | |
| 115 pixel size! Additionally, the positioning of the fonts must be the same | |
| 116 (ascent and descent). You can check this with "xlsfonts -l {fontname}". | |
| 117 | |
| 236 | 118 If any of these things are also set with Vim commands, e.g. with |
| 7 | 119 ":set guifont=Screen15", then this will override the X resources (currently |
| 120 'guifont' is the only option that is supported). | |
| 121 | |
| 122 Here is an example of what you might put in your ~/.Xdefaults file: > | |
| 123 | |
| 124 Vim*useSchemes: all | |
| 125 Vim*sgiMode: true | |
| 126 Vim*useEnhancedFSB: true | |
| 127 Vim.foreground: Black | |
| 128 Vim.background: Wheat | |
| 129 Vim*fontList: 7x13 | |
| 130 | |
| 131 The first three of these are standard resources on Silicon Graphics machines | |
| 132 which make Motif applications look even better, highly recommended! | |
| 133 | |
| 134 The "Vim*fontList" is to set the menu font for Motif. Example: > | |
| 135 Vim*menuBar*fontList: -*-courier-medium-r-*-*-10-*-*-*-*-*-*-* | |
| 136 With Athena: > | |
| 137 Vim*menuBar*SmeBSB*font: -*-courier-medium-r-*-*-10-*-*-*-*-*-*-* | |
| 138 Vim*menuBar*MenuButton*font: -*-courier-medium-r-*-*-10-*-*-*-*-*-*-* | |
| 139 | |
| 140 NOTE: A more portable, and indeed more correct, way to specify the menu font | |
| 141 in either Motif or Athena is through the resource: > | |
| 142 Vim.menuFont: -*-courier-medium-r-*-*-10-*-*-*-*-*-*-* | |
| 143 Or, when compiled with the |+xfontset| feature: > | |
| 144 Vim.menuFontSet: -*-courier-medium-r-*-*-10-*-*-*-*-*-*-* | |
| 145 | |
| 146 Don't use "Vim*geometry" in the defaults. This will break the menus. Use | |
| 147 "Vim.geometry" instead. | |
| 148 | |
| 149 If you get an error message "Cannot allocate colormap entry for "gray60", | |
| 150 try adding this to your Vim resources (change the colors to your liking): > | |
| 151 | |
| 152 Vim*scrollBackground: Black | |
| 153 Vim*scrollForeground: Blue | |
| 154 | |
| 155 The resources can also be set with arguments to Vim: | |
| 156 | |
| 157 argument meaning ~ | |
| 158 *-gui* | |
| 159 -display {display} Run vim on {display} *-display* | |
| 160 -iconic Start vim iconified *-iconic* | |
| 161 -background {color} Use {color} for the background *-background* | |
| 162 -bg {color} idem *-bg* | |
| 163 -foreground {color} Use {color} for normal text *-foreground* | |
| 164 -fg {color} idem *-fg* | |
| 165 -ul {color} idem *-ul* | |
| 166 -font {font} Use {font} for normal text *-font* | |
| 167 -fn {font} idem *-fn* | |
| 168 -boldfont {font} Use {font} for bold text *-boldfont* | |
| 169 -italicfont {font} Use {font} for italic text *-italicfont* | |
| 170 -menufont {font} Use {font} for menu items *-menufont* | |
| 171 -menufontset {fontset} Use {fontset} for menu items *-menufontset* | |
| 172 -mf {font} idem *-mf* | |
| 173 -geometry {geom} Use {geom} for initial geometry *-geometry* | |
| 174 -geom {geom} idem, see |-geometry-example| *-geom* | |
| 175 -borderwidth {width} Use a border width of {width} *-borderwidth* | |
| 176 -bw {width} idem *-bw* | |
| 177 *-scrollbarwidth* | |
| 178 -scrollbarwidth {width} Use a scrollbar width of {width} | |
| 179 -sw {width} idem *-sw* | |
| 180 -menuheight {height} Use a menu bar height of {height} *-menuheight* | |
| 181 -mh {height} idem *-mh* | |
| 182 NOTE: On Motif the value is ignored, the menu height | |
| 183 is computed to fit the menus. | |
| 184 -reverse Use reverse video *-reverse* | |
| 185 -rv idem *-rv* | |
| 186 +reverse Don't use reverse video *-+reverse* | |
| 187 +rv idem *-+rv* | |
| 188 -xrm {resource} Set the specified resource *-xrm* | |
| 189 | |
| 190 Note about reverse video: Vim checks that the result is actually a light text | |
| 191 on a dark background. The reason is that some X11 versions swap the colors, | |
| 192 and some don't. These two examples will both give yellow text on a blue | |
| 193 background: | |
| 194 gvim -fg Yellow -bg Blue -reverse | |
| 195 gvim -bg Yellow -fg Blue -reverse | |
| 196 | |
| 197 *-geometry-example* | |
| 198 An example for the geometry argument: > | |
| 199 gvim -geometry 80x63+8+100 | |
| 200 This creates a window with 80 columns and 63 lines at position 8 pixels from | |
| 201 the left and 100 pixels from the top of the screen. | |
| 202 | |
| 203 ============================================================================== | |
| 204 3. Shell Commands *gui-pty* | |
| 205 | |
| 206 WARNING: Executing an external command from the GUI will not always work. | |
| 207 "normal" commands like "ls", "grep" and "make" mostly work fine. Commands | |
| 208 that require an intelligent terminal like "less" and "ispell" won't work. | |
| 209 Some may even hang and need to be killed from another terminal. So be | |
| 210 careful! | |
| 211 | |
| 212 There are two ways to do the I/O with a shell command: Pipes and a pseudo-tty. | |
| 213 The default is to use a pseudo-tty. This should work best on most systems. | |
| 214 | |
| 215 Unfortunately, the implementation of the pseudo-tty is different on every Unix | |
| 216 system. And some systems require root permission. To avoid running into | |
| 217 problems with a pseudo-tty when you least expect it, test it when not editing | |
| 218 a file. Be prepared to "kill" the started command or Vim. Commands like | |
| 219 ":r !cat" may hang! | |
| 220 | |
| 221 If using a pseudo-tty does not work for you, reset the 'guipty' option: > | |
| 222 | |
| 223 :set noguipty | |
| 224 | |
| 225 Using a pipe should work on any Unix system, but there are disadvantages: | |
| 226 - Some shell commands will notice that a pipe is being used and behave | |
| 227 differently. E.g., ":!ls" will list the files in one column. | |
| 228 - The ":sh" command won't show a prompt, although it will sort of work. | |
| 229 - When using ":make" it's not possible to interrupt with a CTRL-C. | |
| 230 | |
| 231 Typeahead while the external command is running is often lost. This happens | |
| 232 both with a pipe and a pseudo-tty. This is a known problem, but it seems it | |
| 233 can't be fixed (or at least, it's very difficult). | |
| 234 | |
| 235 *gui-pty-erase* | |
| 236 When your erase character is wrong for an external command, you should fix | |
| 237 this in your "~/.cshrc" file, or whatever file your shell uses for | |
| 238 initializations. For example, when you want to use backspace to delete | |
| 239 characters, but hitting backspaces produces "^H" instead, try adding this to | |
| 240 your "~/.cshrc": > | |
| 241 stty erase ^H | |
| 242 The ^H is a real CTRL-H, type it as CTRL-V CTRL-H. | |
| 243 | |
| 244 ============================================================================== | |
| 245 4. Various *gui-x11-various* | |
| 246 | |
| 247 *gui-x11-printing* | |
| 248 The "File/Print" menu simply sends the current buffer to "lpr". No options or | |
| 249 whatever. If you want something else, you can define your own print command. | |
| 250 For example: > | |
| 251 | |
| 252 :10amenu File.Print :w !lpr -Php3 | |
| 253 :10vmenu File.Print :w !lpr -Php3 | |
| 254 < | |
| 255 *X11-icon* | |
| 256 Vim uses a black&white icon by default when compiled with Motif or Athena. A | |
| 257 colored Vim icon is included as $VIMRUNTIME/vim32x32.xpm. For GTK+, this is | |
| 258 the builtin icon used. Unfortunately, how you should install it depends on | |
| 259 your window manager. When you use this, remove the 'i' flag from | |
| 260 'guioptions', to remove the black&white icon: > | |
| 261 :set guioptions-=i | |
| 262 | |
| 263 If you use one of the fvwm* family of window managers simply add this line to | |
| 264 your .fvwm2rc configuration file: > | |
| 265 | |
| 266 Style "vim" Icon vim32x32.xpm | |
| 267 | |
| 268 Make sure the icon file's location is consistent with the window manager's | |
| 269 ImagePath statement. Either modify the ImagePath from within your .fvwm2rc or | |
| 270 drop the icon into one the pre-defined directories: > | |
| 271 | |
| 272 ImagePath /usr/X11R6/include/X11/pixmaps:/usr/X11R6/include/X11/bitmaps | |
| 273 | |
| 274 Note: older versions of fvwm use "IconPath" instead of "ImagePath". | |
| 275 | |
| 276 For CDE "dtwm" (a derivative of Motif) add this line in the .Xdefaults: > | |
| 277 Dtwm*Vim*iconImage: /usr/local/share/vim/vim32x32.xpm | |
| 278 | |
| 279 For "mwm" (Motif window manager) the line would be: > | |
| 280 Mwm*Vim*iconImage: /usr/local/share/vim/vim32x32.xpm | |
| 281 | |
| 282 Mouse Pointers Available in X11 *X11_mouse_shapes* | |
| 283 | |
| 284 By using the |'mouseshape'| option, the mouse pointer can be automatically | |
| 285 changed whenever Vim enters one of its various modes (e.g., Insert or | |
| 286 Command). Currently, the available pointers are: | |
| 287 | |
| 288 arrow an arrow pointing northwest | |
| 289 beam a I-like vertical bar | |
| 290 size an arrow pointing up and down | |
| 291 busy a wristwatch | |
| 292 blank an invisible pointer | |
| 293 crosshair a thin "+" sign | |
| 294 hand1 a dark hand pointing northeast | |
| 295 hand2 a light hand pointing northwest | |
| 296 pencil a pencil pointing southeast | |
| 297 question question_arrow | |
| 298 right_arrow an arrow pointing northeast | |
| 299 up_arrow an arrow pointing upwards | |
| 300 | |
| 301 Additionally, any of the mouse pointers that are built into X11 may be | |
| 302 used by specifying an integer from the X11/cursorfont.h include file. | |
| 303 | |
| 304 If a name is used that exists on other systems, but not in X11, the default | |
| 305 "arrow" pointer is used. | |
| 306 | |
| 307 ============================================================================== | |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
308 5. GTK version *gui-gtk* *GTK+* *GTK* *GTK3* |
| 7 | 309 |
| 310 The GTK version of the GUI works a little bit different. | |
| 311 | |
| 312 GTK does _not_ use the traditional X resource settings. Thus items in your | |
| 313 ~/.Xdefaults or app-defaults files are not used. | |
| 314 Many of the traditional X command line arguments are not supported. (e.g., | |
| 315 stuff like -bg, -fg, etc). The ones that are supported are: | |
| 316 | |
| 317 command line argument resource name meaning ~ | |
| 318 -fn or -font .font font name for the text | |
| 319 -geom or -geometry .geometry size of the gvim window | |
| 320 -rv or -reverse *reverseVideo white text on black background | |
| 321 -display display to be used | |
| 322 -fg -foreground {color} foreground color | |
| 323 -bg -background {color} background color | |
| 324 | |
| 325 To set the font, see |'guifont'|. For GTK, there's also a menu option that | |
| 326 does this. | |
| 327 | |
| 328 Additionally, there are these command line arguments, which are handled by GTK | |
| 329 internally. Look in the GTK documentation for how they are used: | |
| 330 --sync | |
| 331 --gdk-debug | |
| 332 --gdk-no-debug | |
| 333 --no-xshm (not in GTK+ 2) | |
| 334 --xim-preedit (not in GTK+ 2) | |
| 335 --xim-status (not in GTK+ 2) | |
| 336 --gtk-debug | |
| 337 --gtk-no-debug | |
| 338 --g-fatal-warnings | |
| 339 --gtk-module | |
| 340 --display (GTK+ counterpart of -display; works the same way.) | |
| 341 --screen (The screen number; for GTK+ 2.2 multihead support.) | |
| 342 | |
| 343 These arguments are ignored when the |+netbeans_intg| feature is used: | |
| 344 -xrm | |
| 345 -mf | |
| 346 | |
| 347 As for colors, Vim's color settings (for syntax highlighting) is still | |
| 348 done the traditional Vim way. See |:highlight| for more help. | |
| 349 | |
| 350 If you want to set the colors of remaining gui components (e.g., the | |
| 351 menubar, scrollbar, whatever), those are GTK specific settings and you | |
| 352 need to set those up in some sort of gtkrc file. You'll have to refer | |
| 353 to the GTK documentation, however little there is, on how to do this. | |
| 354 See http://developer.gnome.org/doc/API/2.0/gtk/gtk-Resource-Files.html | |
| 355 for more information. | |
| 356 | |
| 357 *gtk-tooltip-colors* | |
| 358 Example, which sets the tooltip colors to black on light-yellow: > | |
| 359 | |
| 360 style "tooltips" | |
| 361 { | |
| 362 bg[NORMAL] = "#ffffcc" | |
| 363 fg[NORMAL] = "#000000" | |
| 364 } | |
| 365 | |
| 366 widget "gtk-tooltips*" style "tooltips" | |
| 367 | |
| 368 Write this in the file ~/.gtkrc and it will be used by GTK+. For GTK+ 2 | |
| 369 you might have to use the file ~/.gtkrc-2.0 instead, depending on your | |
| 370 distribution. | |
| 371 | |
|
8218
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
372 For GTK+ 3, an effect similar to the above can be obtained by adding the |
|
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
373 following snippet of CSS code to $XDG_HOME_DIR/gtk-3.0/gtk.css (usually, |
|
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
374 $HOME/.config/gtk-3.0/gtk.css): |
|
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
375 > |
|
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
376 .tooltip { |
|
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
377 background-color: #ffffcc; |
|
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
378 color: #000000; |
|
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
379 } |
|
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
380 < |
|
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
381 |
| 7 | 382 Using Vim as a GTK+ plugin *gui-gtk-socketid* |
| 383 | |
| 384 When the GTK+ version of Vim starts up normally, it creates its own top level | |
| 385 window (technically, a 'GtkWindow'). GTK+ provides an embedding facility with | |
| 386 its GtkSocket and GtkPlug widgets. If one GTK+ application creates a | |
| 387 GtkSocket widget in one of its windows, an entirely different GTK+ application | |
| 388 may embed itself into the first application by creating a top-level GtkPlug | |
| 389 widget using the socket's ID. | |
| 390 | |
| 391 If you pass Vim the command-line option '--socketid' with a decimal or | |
| 392 hexadecimal value, Vim will create a GtkPlug widget using that value instead | |
| 393 of the normal GtkWindow. This enables Vim to act as a GTK+ plugin. | |
| 394 | |
| 395 This really is a programmer's interface, and is of no use without a supporting | |
| 396 application to spawn the Vim correctly. For more details on GTK+ sockets, see | |
| 397 http://www.gtk.org/api/ | |
| 398 | |
| 399 Note that this feature requires the latest GTK version. GTK 1.2.10 still has | |
| 400 a small problem. The socket feature has not yet been tested with GTK+ 2 -- | |
| 401 feel free to volunteer. | |
| 402 | |
| 403 ============================================================================== | |
| 404 6. GNOME version *gui-gnome* *Gnome* *GNOME* | |
| 405 | |
| 406 The GNOME GUI works just like the GTK+ version. See |GTK+| above for how it | |
| 407 works. It looks a bit different though, and implements one important feature | |
| 408 that's not available in the plain GTK+ GUI: Interaction with the session | |
| 409 manager. |gui-gnome-session| | |
| 410 | |
| 411 These are the different looks: | |
| 412 - Uses GNOME dialogs (GNOME 1 only). The GNOME 2 GUI uses the same nice | |
| 413 dialogs as the GTK+ 2 version. | |
| 414 - Uses the GNOME dock, so that the toolbar and menubar can be moved to | |
| 415 different locations other than the top (e.g., the toolbar can be placed on | |
| 416 the left, right, top, or bottom). The placement of the menubar and | |
| 417 toolbar is only saved in the GNOME 2 version. | |
| 418 - That means the menubar and toolbar handles are back! Yeah! And the | |
| 419 resizing grid still works too. | |
| 420 | |
| 1121 | 421 GNOME is compiled with if it was found by configure and the |
| 422 --enable-gnome-check argument was used. | |
| 423 | |
| 7 | 424 |
| 425 GNOME session support *gui-gnome-session* *gnome-session* | |
| 426 | |
| 427 On logout, Vim shows the well-known exit confirmation dialog if any buffers | |
| 428 are modified. Clicking [Cancel] will stop the logout process. Otherwise the | |
| 429 current session is stored to disk by using the |:mksession| command, and | |
| 430 restored the next time you log in. | |
| 431 | |
| 432 The GNOME session support should also work with the KDE session manager. | |
| 433 If you are experiencing any problems please report them as bugs. | |
| 434 | |
| 435 Note: The automatic session save works entirely transparent, in order to | |
| 436 avoid conflicts with your own session files, scripts and autocommands. That | |
| 437 means in detail: | |
| 438 - The session file is stored to a separate directory (usually $HOME/.gnome2). | |
| 439 - 'sessionoptions' is ignored, and a hardcoded set of appropriate flags is | |
| 440 used instead: > | |
| 1621 | 441 blank,curdir,folds,globals,help,options,tabpages,winsize |
| 7 | 442 - The internal variable |v:this_session| is not changed when storing the |
| 443 session. Also, it is restored to its old value when logging in again. | |
| 444 | |
| 445 The position and size of the GUI window is not saved by Vim since doing so | |
| 446 is the window manager's job. But if compiled with GTK+ 2 support, Vim helps | |
| 447 the WM to identify the window by restoring the window role (using the |--role| | |
| 448 command line argument). | |
| 449 | |
| 450 ============================================================================== | |
| 12 | 451 7. KDE version *gui-kde* *kde* *KDE* *KVim* |
| 1121 | 452 *gui-x11-kde* |
| 574 | 453 There is no KDE version of Vim. There has been some work on a port using the |
| 454 Qt toolkit, but it never worked properly and it has been abandoned. Work | |
| 5697 | 455 continues on Yzis: https://github.com/chrizel/Yzis. |
| 11 | 456 |
| 457 ============================================================================== | |
| 458 8. Compiling *gui-x11-compiling* | |
| 7 | 459 |
| 460 If using X11, Vim's Makefile will by default first try to find the necessary | |
| 461 GTK+ files on your system. If the GTK+ files cannot be found, then the Motif | |
| 462 files will be searched for. Finally, if this fails, the Athena files will be | |
| 463 searched for. If all three fail, the GUI will be disabled. | |
| 464 | |
| 465 For GTK+, Vim's configuration process requires that GTK+ be properly | |
| 466 installed. That is, the shell script 'gtk-config' must be in your PATH, and | |
| 467 you can already successful compile, build, and execute a GTK+ program. The | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
468 reason for this is that the compiler flags (CFLAGS) and link flags (LDFLAGS) |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
469 are obtained through the 'gtk-config' shell script. |
| 7 | 470 |
| 471 If you want to build with GTK+ 2 support pass the --enable-gtk2-check argument | |
| 472 to ./configure. Optionally, support for GNOME 2 will be compiled if the | |
| 2262 | 473 --enable-gnome-check option is also given. |
| 7 | 474 |
| 475 Otherwise, if you are using Motif or Athena, when you have the Motif or Athena | |
| 476 files in a directory where configure doesn't look, edit the Makefile to enter | |
| 477 the names of the directories. Search for "GUI_INC_LOC" for an example to set | |
| 478 the Motif directories, "CONF_OPT_X" for Athena. | |
| 479 | |
| 480 *gui-x11-gtk* | |
| 2262 | 481 At the time of this writing, GTK+ version 1.0.6 and 1.2 are outdated. It |
| 482 is suggested that you use GTK 2. The GTK 1 support will most likely be | |
| 483 dropped soon. | |
| 7 | 484 |
| 2262 | 485 For the GTK+ 2 GUI, using the latest release of the GTK+ 2.0 or GTK+ 2.2 |
| 486 series is recommended. | |
| 7 | 487 |
| 488 Lastly, although GTK+ has supposedly been ported to the Win32 platform, this | |
| 489 has not been tested with Vim and is also unsupported. Also, it's unlikely to | |
| 490 even compile since GTK+ GUI uses parts of the generic X11 code. This might | |
| 491 change in distant future; particularly because getting rid of the X11 centric | |
| 492 code parts is also required for GTK+ framebuffer support. | |
| 493 | |
| 494 *gui-x11-motif* | |
| 495 For Motif, you need at least Motif version 1.2 and/or X11R5. Motif 2.0 and | |
| 496 X11R6 are OK. Motif 1.1 and X11R4 might work, no guarantee (there may be a | |
| 497 few problems, but you might make it compile and run with a bit of work, please | |
| 498 send me the patches if you do). The newest releases of LessTif have been | |
| 499 reported to work fine too. | |
| 500 | |
| 501 *gui-x11-athena* | |
| 502 The Athena version uses the Xaw widget set by default. If you have the 3D | |
| 503 version, you might want to link with Xaw3d instead. This will make the | |
| 504 menus look a bit better. Edit the Makefile and look for "XAW_LIB". The | |
| 505 scrollbars will remain the same, because Vim has its own, which are already | |
| 506 3D (in fact, they look more like Motif). | |
| 507 | |
| 508 *gui-x11-neXtaw* | |
| 509 The neXtaw version is mostly like Athena, but uses different widgets. | |
| 510 | |
| 511 *gui-x11-misc* | |
| 512 In general, do not try to mix files from different GTK+, Motif, Athena and X11 | |
| 513 versions. This will cause problems. For example, using header files for | |
| 514 X11R5 with a library for X11R6 probably doesn't work (although the linking | |
| 515 won't give an error message, Vim will crash later). | |
| 516 | |
| 517 ============================================================================== | |
| 11 | 518 9. X11 selection mechanism *x11-selection* |
| 7 | 519 |
| 520 If using X11, in either the GUI or an xterm with an X11-aware Vim, then Vim | |
| 521 provides varied access to the X11 selection and clipboard. These are accessed | |
| 522 by using the two selection registers "* and "+. | |
| 523 | |
| 524 X11 provides two basic types of global store, selections and cut-buffers, | |
| 525 which differ in one important aspect: selections are "owned" by an | |
| 526 application, and disappear when that application (e.g., Vim) exits, thus | |
| 527 losing the data, whereas cut-buffers, are stored within the X-server itself | |
| 528 and remain until written over or the X-server exits (e.g., upon logging out). | |
| 529 | |
| 530 The contents of selections are held by the originating application (e.g., upon | |
| 531 a copy), and only passed on to another application when that other application | |
| 532 asks for them (e.g., upon a paste). | |
| 533 | |
| 534 The contents of cut-buffers are immediately written to, and are then | |
| 535 accessible directly from the X-server, without contacting the originating | |
| 536 application. | |
| 537 | |
| 538 *quoteplus* *quote+* | |
| 539 There are three documented X selections: PRIMARY (which is expected to | |
| 540 represent the current visual selection - as in Vim's Visual mode), SECONDARY | |
| 541 (which is ill-defined) and CLIPBOARD (which is expected to be used for | |
| 542 cut, copy and paste operations). | |
| 543 | |
| 544 Of these three, Vim uses PRIMARY when reading and writing the "* register | |
| 545 (hence when the X11 selections are available, Vim sets a default value for | |
| 546 |'clipboard'| of "autoselect"), and CLIPBOARD when reading and writing the "+ | |
| 547 register. Vim does not access the SECONDARY selection. | |
| 548 | |
| 549 Examples: (assuming the default option values) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
550 - Select an URL in Visual mode in Vim. Go to your browser and click the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
551 middle mouse button in the URL text field. The selected text will be |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
552 inserted (hopefully!). Note: in Firefox you can set the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
553 middlemouse.contentLoadURL preference to true in about:config, then the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
554 selected URL will be used when pressing middle mouse button in most places |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
555 in the window. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
556 - Select some text in your browser by dragging with the mouse. Go to Vim and |
| 7 | 557 press the middle mouse button: The selected text is inserted. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
558 - Select some text in Vim and do "+y. Go to your browser, select some text in |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
559 a textfield by dragging with the mouse. Now use the right mouse button and |
| 7 | 560 select "Paste" from the popup menu. The selected text is overwritten by the |
| 561 text from Vim. | |
| 562 Note that the text in the "+ register remains available when making a Visual | |
| 563 selection, which makes other text available in the "* register. That allows | |
| 564 overwriting selected text. | |
| 565 *x11-cut-buffer* | |
| 566 There are, by default, 8 cut-buffers: CUT_BUFFER0 to CUT_BUFFER7. Vim only | |
| 567 uses CUT_BUFFER0, which is the one that xterm uses by default. | |
| 568 | |
| 569 Whenever Vim is about to become unavailable (either via exiting or becoming | |
| 570 suspended), and thus unable to respond to another application's selection | |
| 571 request, it writes the contents of any owned selection to CUT_BUFFER0. If the | |
| 572 "+ CLIPBOARD selection is owned by Vim, then this is written in preference, | |
| 573 otherwise if the "* PRIMARY selection is owned by Vim, then that is written. | |
| 574 | |
| 575 Similarly, when Vim tries to paste from "* or "+ (either explicitly, or, in | |
| 576 the case of the "* register, when the middle mouse button is clicked), if the | |
| 577 requested X selection is empty or unavailable, Vim reverts to reading the | |
| 578 current value of the CUT_BUFFER0. | |
| 579 | |
| 580 Note that when text is copied to CUT_BUFFER0 in this way, the type of | |
| 581 selection (character, line or block) is always lost, even if it is a Vim which | |
| 582 later pastes it. | |
| 583 | |
| 584 Xterm, by default, always writes visible selections to both PRIMARY and | |
| 585 CUT_BUFFER0. When it pastes, it uses PRIMARY if this is available, or else | |
| 586 falls back upon CUT_BUFFER0. For this reason, when cutting and pasting | |
| 587 between Vim and an xterm, you should use the "* register. Xterm doesn't use | |
| 588 CLIPBOARD, thus the "+ doesn't work with xterm. | |
| 589 | |
| 590 Most newer applications will provide their current selection via PRIMARY ("*) | |
| 591 and use CLIPBOARD ("+) for cut/copy/paste operations. You thus have access to | |
| 592 both by choosing to use either of the "* or "+ registers. | |
| 593 | |
| 594 | |
| 595 vim:tw=78:sw=4:ts=8:ft=help:norl: |