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