Mercurial > vim
annotate runtime/doc/gui_x11.txt @ 13937:cd513458728c
Updated runtime files
commit https://github.com/vim/vim/commit/eb3dc87f01391bb075d97aef3d00f91b4e08a25c
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun May 13 22:34:24 2018 +0200
Updated runtime files
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Sun, 13 May 2018 22:45:06 +0200 |
parents | e751b5c9dff3 |
children | 1174611ad715 |
rev | line source |
---|---|
13857 | 1 *gui_x11.txt* For Vim version 8.0. Last change: 2018 May 06 |
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". | |
13857 | 56 |
57 When there are running jobs Vim will not fork, because the processes would no | |
58 longer be child processes. | |
3082 | 59 *E851* *E852* |
60 When starting the GUI fails Vim will try to continue running in the terminal. | |
7 | 61 |
62 If you want the GUI to run in the foreground always, include the 'f' | |
63 flag in 'guioptions'. |-f|. | |
64 | |
65 ============================================================================== | |
66 2. GUI Resources *gui-resources* *.Xdefaults* | |
67 | |
11 | 68 If using the Motif or Athena version of the GUI (not for the KDE, GTK+ or Win32 |
7 | 69 version), a number of X resources are available. You should use Vim's class |
70 "Vim" when setting these. They are as follows: | |
71 | |
72 Resource name Meaning ~ | |
73 | |
74 reverseVideo Boolean: should reverse video be used? | |
75 background Color of background. | |
76 foreground Color of normal text. | |
77 scrollBackground Color of trough portion of scrollbars. | |
78 scrollForeground Color of slider and arrow portions of scrollbars. | |
79 menuBackground Color of menu backgrounds. | |
80 menuForeground Color of menu foregrounds. | |
81 tooltipForeground Color of tooltip and balloon foreground. | |
82 tooltipBackground Color of tooltip and balloon background. | |
83 | |
84 font Name of font used for normal text. | |
85 boldFont Name of font used for bold text. | |
86 italicFont Name of font used for italic text. | |
87 boldItalicFont Name of font used for bold, italic text. | |
88 menuFont Name of font used for the menus, used when compiled | |
89 without the |+xfontset| feature | |
90 menuFontSet Name of fontset used for the menus, used when compiled | |
91 with the |+xfontset| feature | |
92 tooltipFont Name of the font used for the tooltip and balloons. | |
93 When compiled with the |+xfontset| feature this is a | |
94 fontset name. | |
95 | |
96 geometry Initial geometry to use for gvim's window (default | |
97 is same size as terminal that started it). | |
98 scrollbarWidth Thickness of scrollbars. | |
99 borderWidth Thickness of border around text area. | |
100 menuHeight Height of the menu bar (only for Athena). | |
101 | |
102 A special font for italic, bold, and italic-bold text will only be used if | |
103 the user has specified one via a resource. No attempt is made to guess what | |
104 fonts should be used for these based on the normal text font. | |
105 | |
106 Note that the colors can also be set with the ":highlight" command, using the | |
107 "Normal", "Menu", "Tooltip", and "Scrollbar" groups. Example: > | |
108 :highlight Menu guibg=lightblue | |
109 :highlight Tooltip guibg=yellow | |
110 :highlight Scrollbar guibg=lightblue guifg=blue | |
111 :highlight Normal guibg=grey90 | |
112 < | |
113 *font-sizes* | |
114 Note: All fonts (except for the menu and tooltip) must be of the same size!!! | |
115 If you don't do this, text will disappear or mess up the display. Vim does | |
116 not check the font sizes. It's the size in screen pixels that must be the | |
117 same. Note that some fonts that have the same point size don't have the same | |
118 pixel size! Additionally, the positioning of the fonts must be the same | |
119 (ascent and descent). You can check this with "xlsfonts -l {fontname}". | |
120 | |
236 | 121 If any of these things are also set with Vim commands, e.g. with |
7 | 122 ":set guifont=Screen15", then this will override the X resources (currently |
123 'guifont' is the only option that is supported). | |
124 | |
125 Here is an example of what you might put in your ~/.Xdefaults file: > | |
126 | |
127 Vim*useSchemes: all | |
128 Vim*sgiMode: true | |
129 Vim*useEnhancedFSB: true | |
130 Vim.foreground: Black | |
131 Vim.background: Wheat | |
132 Vim*fontList: 7x13 | |
133 | |
134 The first three of these are standard resources on Silicon Graphics machines | |
135 which make Motif applications look even better, highly recommended! | |
136 | |
137 The "Vim*fontList" is to set the menu font for Motif. Example: > | |
138 Vim*menuBar*fontList: -*-courier-medium-r-*-*-10-*-*-*-*-*-*-* | |
139 With Athena: > | |
140 Vim*menuBar*SmeBSB*font: -*-courier-medium-r-*-*-10-*-*-*-*-*-*-* | |
141 Vim*menuBar*MenuButton*font: -*-courier-medium-r-*-*-10-*-*-*-*-*-*-* | |
142 | |
143 NOTE: A more portable, and indeed more correct, way to specify the menu font | |
144 in either Motif or Athena is through the resource: > | |
145 Vim.menuFont: -*-courier-medium-r-*-*-10-*-*-*-*-*-*-* | |
146 Or, when compiled with the |+xfontset| feature: > | |
147 Vim.menuFontSet: -*-courier-medium-r-*-*-10-*-*-*-*-*-*-* | |
148 | |
149 Don't use "Vim*geometry" in the defaults. This will break the menus. Use | |
150 "Vim.geometry" instead. | |
151 | |
152 If you get an error message "Cannot allocate colormap entry for "gray60", | |
153 try adding this to your Vim resources (change the colors to your liking): > | |
154 | |
155 Vim*scrollBackground: Black | |
156 Vim*scrollForeground: Blue | |
157 | |
158 The resources can also be set with arguments to Vim: | |
159 | |
160 argument meaning ~ | |
161 *-gui* | |
162 -display {display} Run vim on {display} *-display* | |
163 -iconic Start vim iconified *-iconic* | |
164 -background {color} Use {color} for the background *-background* | |
165 -bg {color} idem *-bg* | |
166 -foreground {color} Use {color} for normal text *-foreground* | |
167 -fg {color} idem *-fg* | |
168 -ul {color} idem *-ul* | |
169 -font {font} Use {font} for normal text *-font* | |
170 -fn {font} idem *-fn* | |
171 -boldfont {font} Use {font} for bold text *-boldfont* | |
172 -italicfont {font} Use {font} for italic text *-italicfont* | |
173 -menufont {font} Use {font} for menu items *-menufont* | |
174 -menufontset {fontset} Use {fontset} for menu items *-menufontset* | |
175 -mf {font} idem *-mf* | |
176 -geometry {geom} Use {geom} for initial geometry *-geometry* | |
177 -geom {geom} idem, see |-geometry-example| *-geom* | |
178 -borderwidth {width} Use a border width of {width} *-borderwidth* | |
179 -bw {width} idem *-bw* | |
180 *-scrollbarwidth* | |
181 -scrollbarwidth {width} Use a scrollbar width of {width} | |
182 -sw {width} idem *-sw* | |
183 -menuheight {height} Use a menu bar height of {height} *-menuheight* | |
184 -mh {height} idem *-mh* | |
185 NOTE: On Motif the value is ignored, the menu height | |
186 is computed to fit the menus. | |
187 -reverse Use reverse video *-reverse* | |
188 -rv idem *-rv* | |
189 +reverse Don't use reverse video *-+reverse* | |
190 +rv idem *-+rv* | |
191 -xrm {resource} Set the specified resource *-xrm* | |
192 | |
193 Note about reverse video: Vim checks that the result is actually a light text | |
194 on a dark background. The reason is that some X11 versions swap the colors, | |
195 and some don't. These two examples will both give yellow text on a blue | |
196 background: | |
197 gvim -fg Yellow -bg Blue -reverse | |
198 gvim -bg Yellow -fg Blue -reverse | |
199 | |
200 *-geometry-example* | |
201 An example for the geometry argument: > | |
202 gvim -geometry 80x63+8+100 | |
203 This creates a window with 80 columns and 63 lines at position 8 pixels from | |
204 the left and 100 pixels from the top of the screen. | |
205 | |
206 ============================================================================== | |
207 3. Shell Commands *gui-pty* | |
208 | |
209 WARNING: Executing an external command from the GUI will not always work. | |
210 "normal" commands like "ls", "grep" and "make" mostly work fine. Commands | |
211 that require an intelligent terminal like "less" and "ispell" won't work. | |
212 Some may even hang and need to be killed from another terminal. So be | |
213 careful! | |
214 | |
215 There are two ways to do the I/O with a shell command: Pipes and a pseudo-tty. | |
216 The default is to use a pseudo-tty. This should work best on most systems. | |
217 | |
218 Unfortunately, the implementation of the pseudo-tty is different on every Unix | |
219 system. And some systems require root permission. To avoid running into | |
220 problems with a pseudo-tty when you least expect it, test it when not editing | |
221 a file. Be prepared to "kill" the started command or Vim. Commands like | |
222 ":r !cat" may hang! | |
223 | |
224 If using a pseudo-tty does not work for you, reset the 'guipty' option: > | |
225 | |
226 :set noguipty | |
227 | |
228 Using a pipe should work on any Unix system, but there are disadvantages: | |
229 - Some shell commands will notice that a pipe is being used and behave | |
230 differently. E.g., ":!ls" will list the files in one column. | |
231 - The ":sh" command won't show a prompt, although it will sort of work. | |
232 - When using ":make" it's not possible to interrupt with a CTRL-C. | |
233 | |
234 Typeahead while the external command is running is often lost. This happens | |
235 both with a pipe and a pseudo-tty. This is a known problem, but it seems it | |
236 can't be fixed (or at least, it's very difficult). | |
237 | |
238 *gui-pty-erase* | |
239 When your erase character is wrong for an external command, you should fix | |
240 this in your "~/.cshrc" file, or whatever file your shell uses for | |
241 initializations. For example, when you want to use backspace to delete | |
242 characters, but hitting backspaces produces "^H" instead, try adding this to | |
243 your "~/.cshrc": > | |
244 stty erase ^H | |
245 The ^H is a real CTRL-H, type it as CTRL-V CTRL-H. | |
246 | |
247 ============================================================================== | |
248 4. Various *gui-x11-various* | |
249 | |
250 *gui-x11-printing* | |
251 The "File/Print" menu simply sends the current buffer to "lpr". No options or | |
252 whatever. If you want something else, you can define your own print command. | |
253 For example: > | |
254 | |
255 :10amenu File.Print :w !lpr -Php3 | |
256 :10vmenu File.Print :w !lpr -Php3 | |
257 < | |
258 *X11-icon* | |
259 Vim uses a black&white icon by default when compiled with Motif or Athena. A | |
260 colored Vim icon is included as $VIMRUNTIME/vim32x32.xpm. For GTK+, this is | |
261 the builtin icon used. Unfortunately, how you should install it depends on | |
262 your window manager. When you use this, remove the 'i' flag from | |
263 'guioptions', to remove the black&white icon: > | |
264 :set guioptions-=i | |
265 | |
266 If you use one of the fvwm* family of window managers simply add this line to | |
267 your .fvwm2rc configuration file: > | |
268 | |
269 Style "vim" Icon vim32x32.xpm | |
270 | |
271 Make sure the icon file's location is consistent with the window manager's | |
272 ImagePath statement. Either modify the ImagePath from within your .fvwm2rc or | |
273 drop the icon into one the pre-defined directories: > | |
274 | |
275 ImagePath /usr/X11R6/include/X11/pixmaps:/usr/X11R6/include/X11/bitmaps | |
276 | |
277 Note: older versions of fvwm use "IconPath" instead of "ImagePath". | |
278 | |
279 For CDE "dtwm" (a derivative of Motif) add this line in the .Xdefaults: > | |
280 Dtwm*Vim*iconImage: /usr/local/share/vim/vim32x32.xpm | |
281 | |
282 For "mwm" (Motif window manager) the line would be: > | |
283 Mwm*Vim*iconImage: /usr/local/share/vim/vim32x32.xpm | |
284 | |
285 | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
286 Mouse Pointers Available in X11 ~ |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
287 *X11_mouse_shapes* |
7 | 288 By using the |'mouseshape'| option, the mouse pointer can be automatically |
289 changed whenever Vim enters one of its various modes (e.g., Insert or | |
290 Command). Currently, the available pointers are: | |
291 | |
292 arrow an arrow pointing northwest | |
293 beam a I-like vertical bar | |
294 size an arrow pointing up and down | |
295 busy a wristwatch | |
296 blank an invisible pointer | |
297 crosshair a thin "+" sign | |
298 hand1 a dark hand pointing northeast | |
299 hand2 a light hand pointing northwest | |
300 pencil a pencil pointing southeast | |
301 question question_arrow | |
302 right_arrow an arrow pointing northeast | |
303 up_arrow an arrow pointing upwards | |
304 | |
305 Additionally, any of the mouse pointers that are built into X11 may be | |
306 used by specifying an integer from the X11/cursorfont.h include file. | |
307 | |
308 If a name is used that exists on other systems, but not in X11, the default | |
309 "arrow" pointer is used. | |
310 | |
311 ============================================================================== | |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
312 5. GTK version *gui-gtk* *GTK+* *GTK* *GTK3* |
7 | 313 |
314 The GTK version of the GUI works a little bit different. | |
315 | |
316 GTK does _not_ use the traditional X resource settings. Thus items in your | |
317 ~/.Xdefaults or app-defaults files are not used. | |
318 Many of the traditional X command line arguments are not supported. (e.g., | |
319 stuff like -bg, -fg, etc). The ones that are supported are: | |
320 | |
321 command line argument resource name meaning ~ | |
322 -fn or -font .font font name for the text | |
323 -geom or -geometry .geometry size of the gvim window | |
324 -rv or -reverse *reverseVideo white text on black background | |
325 -display display to be used | |
326 -fg -foreground {color} foreground color | |
327 -bg -background {color} background color | |
328 | |
329 To set the font, see |'guifont'|. For GTK, there's also a menu option that | |
330 does this. | |
331 | |
332 Additionally, there are these command line arguments, which are handled by GTK | |
333 internally. Look in the GTK documentation for how they are used: | |
334 --sync | |
335 --gdk-debug | |
336 --gdk-no-debug | |
337 --no-xshm (not in GTK+ 2) | |
338 --xim-preedit (not in GTK+ 2) | |
339 --xim-status (not in GTK+ 2) | |
340 --gtk-debug | |
341 --gtk-no-debug | |
342 --g-fatal-warnings | |
343 --gtk-module | |
344 --display (GTK+ counterpart of -display; works the same way.) | |
345 --screen (The screen number; for GTK+ 2.2 multihead support.) | |
346 | |
347 These arguments are ignored when the |+netbeans_intg| feature is used: | |
348 -xrm | |
349 -mf | |
350 | |
351 As for colors, Vim's color settings (for syntax highlighting) is still | |
352 done the traditional Vim way. See |:highlight| for more help. | |
353 | |
354 If you want to set the colors of remaining gui components (e.g., the | |
355 menubar, scrollbar, whatever), those are GTK specific settings and you | |
356 need to set those up in some sort of gtkrc file. You'll have to refer | |
357 to the GTK documentation, however little there is, on how to do this. | |
358 See http://developer.gnome.org/doc/API/2.0/gtk/gtk-Resource-Files.html | |
359 for more information. | |
360 | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
361 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
362 Tooltip Colors ~ |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
363 *gtk-tooltip-colors* |
7 | 364 Example, which sets the tooltip colors to black on light-yellow: > |
365 | |
366 style "tooltips" | |
367 { | |
368 bg[NORMAL] = "#ffffcc" | |
369 fg[NORMAL] = "#000000" | |
370 } | |
371 | |
372 widget "gtk-tooltips*" style "tooltips" | |
373 | |
374 Write this in the file ~/.gtkrc and it will be used by GTK+. For GTK+ 2 | |
375 you might have to use the file ~/.gtkrc-2.0 instead, depending on your | |
376 distribution. | |
377 | |
8218
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
378 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
|
379 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
|
380 $HOME/.config/gtk-3.0/gtk.css): |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
381 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
382 For GTK+ 3 < 3.20: > |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
383 |
8218
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
384 .tooltip { |
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
385 background-color: #ffffcc; |
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
386 color: #000000; |
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
387 } |
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
388 < |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
389 For GTK+ 3 >= 3.20: > |
8218
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
390 |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
391 tooltip { |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
392 background-color: #ffffcc; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
393 text-shadow: none; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
394 } |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
395 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
396 tooltip label { |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
397 color: #2e3436; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
398 } |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
399 < |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
400 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
401 A Quick Look at GTK+ CSS ~ |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
402 *gtk-css* |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
403 The contents of this subsection apply to GTK+ 3.20 or later which provides |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
404 stable support for GTK+ CSS: |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
405 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
406 https://developer.gnome.org/gtk3/stable/theming.html |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
407 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
408 GTK+ uses CSS for styling and layout of widgets. In this subsection, we'll |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
409 have a quick look at GTK+ CSS through simple, illustrative examples. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
410 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
411 Example 1. Empty Space Adjustment ~ |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
412 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
413 By default, the toolbar and the tabline of the GTK+ 3 GUI are somewhat larger |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
414 than those of the GTK+ 2 GUI. Some people may want to make them look similar |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
415 to the GTK+ 2 GUI in size. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
416 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
417 To do that, we'll try reducing empty space around icons and labels that looks |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
418 apparently superfluous. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
419 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
420 Add the following lines to $XDG_HOME_DIR/gtk-3.0/gtk.css (usually, |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
421 $HOME/.config/gtk-3.0/gtk.css): > |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
422 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
423 toolbar button { |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
424 margin-top: -2px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
425 margin-right: 0px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
426 margin-bottom: -2px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
427 margin-left: 0px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
428 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
429 padding-top: 0px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
430 padding-right: 0px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
431 padding-bottom: 0px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
432 padding-left: 0px |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
433 } |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
434 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
435 notebook tab { |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
436 margin-top: -1px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
437 margin-right: 3px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
438 margin-bottom: -1px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
439 margin-left: 3px; |
7 | 440 |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
441 padding-top: 0px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
442 padding-right: 0px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
443 padding-bottom: 0px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
444 padding-left: 0px |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
445 } |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
446 < |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
447 Since it's a CSS, they can be rewritten using shorthand: > |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
448 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
449 toolbar button { |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
450 margin: -2px 0px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
451 padding: 0px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
452 } |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
453 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
454 notebook tab { |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
455 margin: -1px 3px; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
456 padding: 0px |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
457 } |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
458 < |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
459 Note: You might want to use 'toolbariconsize' to adjust the icon size, too. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
460 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
461 Note: Depending on the icon theme and/or the font in use, some extra tweaks |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
462 may be needed for a satisfactory result. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
463 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
464 Note: In addition to margin and padding, you can use border. For details, |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
465 refer to the box model of CSS, e.g., |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
466 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
467 https://www.w3schools.com/css/css_boxmodel.asp |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
468 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
469 Example 2. More Than Just Colors ~ |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
470 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
471 GTK+ CSS supports gradients as well: > |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
472 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
473 tooltip { |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
474 background-image: -gtk-gradient(linear, |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
475 0 0, 0 1, |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
476 color-stop(0, #344752), |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
477 color-stop(0.5, #546772), |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
478 color-stop(1, #243742)); |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
479 } |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
480 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
481 tooltip label { |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
482 color: #f3f3f3; |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
483 } |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
484 < |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
485 Gradients can be used to make a GUI element visually distinguishable from |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
486 others without relying on high contrast. Accordingly, effective use of them is |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
487 a useful technique to give a theme a sense of unity in color and luminance. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
488 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
489 Note: Theming can be difficult since it must make every application look |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
490 equally good; making a single application more charming often gets others |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
491 unexpectedly less attractive or even deteriorates their usability. Keep this |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
492 in mind always when you try improving a theme. |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
493 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
494 |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
495 Using Vim as a GTK+ plugin ~ |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
496 *gui-gtk-socketid* |
7 | 497 When the GTK+ version of Vim starts up normally, it creates its own top level |
498 window (technically, a 'GtkWindow'). GTK+ provides an embedding facility with | |
499 its GtkSocket and GtkPlug widgets. If one GTK+ application creates a | |
500 GtkSocket widget in one of its windows, an entirely different GTK+ application | |
501 may embed itself into the first application by creating a top-level GtkPlug | |
502 widget using the socket's ID. | |
503 | |
504 If you pass Vim the command-line option '--socketid' with a decimal or | |
505 hexadecimal value, Vim will create a GtkPlug widget using that value instead | |
506 of the normal GtkWindow. This enables Vim to act as a GTK+ plugin. | |
507 | |
508 This really is a programmer's interface, and is of no use without a supporting | |
509 application to spawn the Vim correctly. For more details on GTK+ sockets, see | |
510 http://www.gtk.org/api/ | |
511 | |
512 Note that this feature requires the latest GTK version. GTK 1.2.10 still has | |
513 a small problem. The socket feature has not yet been tested with GTK+ 2 -- | |
514 feel free to volunteer. | |
515 | |
516 ============================================================================== | |
517 6. GNOME version *gui-gnome* *Gnome* *GNOME* | |
518 | |
519 The GNOME GUI works just like the GTK+ version. See |GTK+| above for how it | |
520 works. It looks a bit different though, and implements one important feature | |
521 that's not available in the plain GTK+ GUI: Interaction with the session | |
522 manager. |gui-gnome-session| | |
523 | |
524 These are the different looks: | |
525 - Uses GNOME dialogs (GNOME 1 only). The GNOME 2 GUI uses the same nice | |
526 dialogs as the GTK+ 2 version. | |
527 - Uses the GNOME dock, so that the toolbar and menubar can be moved to | |
528 different locations other than the top (e.g., the toolbar can be placed on | |
529 the left, right, top, or bottom). The placement of the menubar and | |
530 toolbar is only saved in the GNOME 2 version. | |
531 - That means the menubar and toolbar handles are back! Yeah! And the | |
532 resizing grid still works too. | |
533 | |
1121 | 534 GNOME is compiled with if it was found by configure and the |
535 --enable-gnome-check argument was used. | |
536 | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
537 Note: Avoid use of --enable-gnome-check with GTK+ 3 GUI build. The |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
538 functionality mentioned above is consolidated in GTK+ 3. |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
539 |
7 | 540 |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
541 GNOME session support ~ |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
542 *gui-gnome-session* *gnome-session* |
7 | 543 On logout, Vim shows the well-known exit confirmation dialog if any buffers |
544 are modified. Clicking [Cancel] will stop the logout process. Otherwise the | |
545 current session is stored to disk by using the |:mksession| command, and | |
546 restored the next time you log in. | |
547 | |
548 The GNOME session support should also work with the KDE session manager. | |
549 If you are experiencing any problems please report them as bugs. | |
550 | |
551 Note: The automatic session save works entirely transparent, in order to | |
552 avoid conflicts with your own session files, scripts and autocommands. That | |
553 means in detail: | |
554 - The session file is stored to a separate directory (usually $HOME/.gnome2). | |
555 - 'sessionoptions' is ignored, and a hardcoded set of appropriate flags is | |
556 used instead: > | |
1621 | 557 blank,curdir,folds,globals,help,options,tabpages,winsize |
7 | 558 - The internal variable |v:this_session| is not changed when storing the |
559 session. Also, it is restored to its old value when logging in again. | |
560 | |
561 The position and size of the GUI window is not saved by Vim since doing so | |
562 is the window manager's job. But if compiled with GTK+ 2 support, Vim helps | |
563 the WM to identify the window by restoring the window role (using the |--role| | |
564 command line argument). | |
565 | |
566 ============================================================================== | |
12 | 567 7. KDE version *gui-kde* *kde* *KDE* *KVim* |
1121 | 568 *gui-x11-kde* |
574 | 569 There is no KDE version of Vim. There has been some work on a port using the |
570 Qt toolkit, but it never worked properly and it has been abandoned. Work | |
5697 | 571 continues on Yzis: https://github.com/chrizel/Yzis. |
11 | 572 |
573 ============================================================================== | |
574 8. Compiling *gui-x11-compiling* | |
7 | 575 |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
576 If using X11, Vim's configure will by default first try to find the necessary |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
577 GTK+ files on your system. When both GTK+ 2 and GTK+ 3 are available, GTK+ 2 |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
578 will be chosen unless --enable-gui=gtk3 is passed explicitly to configure. |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
579 |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
580 If the GTK+ files cannot be found, then the Motif files will be searched for. |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
581 Finally, if this fails, the Athena files will be searched for. If all three |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
582 fail, the GUI will be disabled. |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
583 |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
584 For GTK+, Vim's configuration process uses pkg-config(1) to check if the |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
585 GTK+ required for a specified build is properly installed and usable. |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
586 Accordingly, it is a good idea to make sure before running configure that |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
587 your system has a working pkg-config together with the .pc file of the |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
588 required GTK+. For that, say, run the following on the command line to see if |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
589 your pkg-config works with your GTK+ 2: > |
7 | 590 |
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
591 $ pkg-config --modversion gtk+-2.0 |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
592 |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
593 Replace gtk+-2.0 with gtk+-3.0 for GTK+ 3. If you get the correct version |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
594 number of your GTK+, you can proceed; if not, you probably need to do some |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
595 system administration chores to set up pkg-config and GTK+ correctly. |
7 | 596 |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
597 The GTK+ 2 GUI is built by default. Therefore, you usually don't need to pass |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
598 any options such as --enable-gui=gtk2 to configure and build that. |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
599 |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
600 Optionally, the GTK+ 2 GUI can consolidate the GNOME 2 support. This support |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
601 is enabled by passing --enable-gnome-check to configure. |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
602 |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
603 If you want to build the GTK+ 3 GUI, you have to pass --enable-gui=gtk3 |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
604 explicitly to configure, and avoid passing --enable-gnome-check to that, as |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
605 the functionality of the GNOME 2 support has already been consolidated in |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
606 GTK+ 3. |
7 | 607 |
608 Otherwise, if you are using Motif or Athena, when you have the Motif or Athena | |
609 files in a directory where configure doesn't look, edit the Makefile to enter | |
610 the names of the directories. Search for "GUI_INC_LOC" for an example to set | |
611 the Motif directories, "CONF_OPT_X" for Athena. | |
612 | |
613 *gui-x11-gtk* | |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
614 Currently, Vim supports both GTK+ 2 and GTK+ 3. |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
615 |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
616 The GTK+ 2 GUI requires GTK+ 2.2 or later. |
7 | 617 |
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
618 Although the GTK+ 3 GUI is written in such a way that the source code can be |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
619 compiled against all versions of the 3.x series, we recommend GTK+ 3.10 or |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
620 later because of its substantial implementation changes in redraw done at |
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
621 that version. |
7 | 622 |
623 *gui-x11-motif* | |
624 For Motif, you need at least Motif version 1.2 and/or X11R5. Motif 2.0 and | |
625 X11R6 are OK. Motif 1.1 and X11R4 might work, no guarantee (there may be a | |
626 few problems, but you might make it compile and run with a bit of work, please | |
627 send me the patches if you do). The newest releases of LessTif have been | |
628 reported to work fine too. | |
629 | |
630 *gui-x11-athena* | |
631 The Athena version uses the Xaw widget set by default. If you have the 3D | |
632 version, you might want to link with Xaw3d instead. This will make the | |
633 menus look a bit better. Edit the Makefile and look for "XAW_LIB". The | |
634 scrollbars will remain the same, because Vim has its own, which are already | |
635 3D (in fact, they look more like Motif). | |
636 | |
637 *gui-x11-neXtaw* | |
638 The neXtaw version is mostly like Athena, but uses different widgets. | |
639 | |
640 *gui-x11-misc* | |
641 In general, do not try to mix files from different GTK+, Motif, Athena and X11 | |
642 versions. This will cause problems. For example, using header files for | |
643 X11R5 with a library for X11R6 probably doesn't work (although the linking | |
644 won't give an error message, Vim will crash later). | |
645 | |
646 ============================================================================== | |
11 | 647 9. X11 selection mechanism *x11-selection* |
7 | 648 |
649 If using X11, in either the GUI or an xterm with an X11-aware Vim, then Vim | |
650 provides varied access to the X11 selection and clipboard. These are accessed | |
651 by using the two selection registers "* and "+. | |
652 | |
653 X11 provides two basic types of global store, selections and cut-buffers, | |
654 which differ in one important aspect: selections are "owned" by an | |
655 application, and disappear when that application (e.g., Vim) exits, thus | |
656 losing the data, whereas cut-buffers, are stored within the X-server itself | |
657 and remain until written over or the X-server exits (e.g., upon logging out). | |
658 | |
659 The contents of selections are held by the originating application (e.g., upon | |
660 a copy), and only passed on to another application when that other application | |
661 asks for them (e.g., upon a paste). | |
662 | |
663 The contents of cut-buffers are immediately written to, and are then | |
664 accessible directly from the X-server, without contacting the originating | |
665 application. | |
666 | |
667 *quoteplus* *quote+* | |
668 There are three documented X selections: PRIMARY (which is expected to | |
669 represent the current visual selection - as in Vim's Visual mode), SECONDARY | |
670 (which is ill-defined) and CLIPBOARD (which is expected to be used for | |
671 cut, copy and paste operations). | |
672 | |
673 Of these three, Vim uses PRIMARY when reading and writing the "* register | |
674 (hence when the X11 selections are available, Vim sets a default value for | |
675 |'clipboard'| of "autoselect"), and CLIPBOARD when reading and writing the "+ | |
676 register. Vim does not access the SECONDARY selection. | |
677 | |
678 Examples: (assuming the default option values) | |
11914 | 679 - Select a URL in Visual mode in Vim. Go to your browser and click the |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
680 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
|
681 inserted (hopefully!). Note: in Firefox you can set the |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
682 middlemouse.contentLoadURL preference to true in about:config, then the |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
683 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
|
684 in the window. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
685 - Select some text in your browser by dragging with the mouse. Go to Vim and |
7 | 686 press the middle mouse button: The selected text is inserted. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
687 - 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
|
688 a textfield by dragging with the mouse. Now use the right mouse button and |
7 | 689 select "Paste" from the popup menu. The selected text is overwritten by the |
690 text from Vim. | |
691 Note that the text in the "+ register remains available when making a Visual | |
692 selection, which makes other text available in the "* register. That allows | |
693 overwriting selected text. | |
694 *x11-cut-buffer* | |
695 There are, by default, 8 cut-buffers: CUT_BUFFER0 to CUT_BUFFER7. Vim only | |
696 uses CUT_BUFFER0, which is the one that xterm uses by default. | |
697 | |
698 Whenever Vim is about to become unavailable (either via exiting or becoming | |
699 suspended), and thus unable to respond to another application's selection | |
700 request, it writes the contents of any owned selection to CUT_BUFFER0. If the | |
701 "+ CLIPBOARD selection is owned by Vim, then this is written in preference, | |
702 otherwise if the "* PRIMARY selection is owned by Vim, then that is written. | |
703 | |
704 Similarly, when Vim tries to paste from "* or "+ (either explicitly, or, in | |
705 the case of the "* register, when the middle mouse button is clicked), if the | |
706 requested X selection is empty or unavailable, Vim reverts to reading the | |
707 current value of the CUT_BUFFER0. | |
708 | |
709 Note that when text is copied to CUT_BUFFER0 in this way, the type of | |
710 selection (character, line or block) is always lost, even if it is a Vim which | |
711 later pastes it. | |
712 | |
713 Xterm, by default, always writes visible selections to both PRIMARY and | |
714 CUT_BUFFER0. When it pastes, it uses PRIMARY if this is available, or else | |
715 falls back upon CUT_BUFFER0. For this reason, when cutting and pasting | |
716 between Vim and an xterm, you should use the "* register. Xterm doesn't use | |
717 CLIPBOARD, thus the "+ doesn't work with xterm. | |
718 | |
719 Most newer applications will provide their current selection via PRIMARY ("*) | |
720 and use CLIPBOARD ("+) for cut/copy/paste operations. You thus have access to | |
721 both by choosing to use either of the "* or "+ registers. | |
722 | |
723 | |
724 vim:tw=78:sw=4:ts=8:ft=help:norl: |