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