diff --git a/runtime/doc/gui_x11.txt b/runtime/doc/gui_x11.txt index c657790..9d659ad 100644 --- a/runtime/doc/gui_x11.txt +++ b/runtime/doc/gui_x11.txt @@ -421,6 +421,10 @@ These are the different looks: GNOME is compiled with if it was found by configure and the --enable-gnome-check argument was used. +Note: Avoid use of --enable-gnome-check with GTK+ 3 GUI build. As the +functionality mentioned above is consolidated in GTK+ 3, doing that doesn't +make sense but may result in an executable different from your expectation. + GNOME session support *gui-gnome-session* *gnome-session* @@ -457,20 +461,38 @@ continues on Yzis: https://github.com/chrizel/Yzis. ============================================================================== 8. Compiling *gui-x11-compiling* -If using X11, Vim's Makefile will by default first try to find the necessary -GTK+ files on your system. If the GTK+ files cannot be found, then the Motif -files will be searched for. Finally, if this fails, the Athena files will be -searched for. If all three fail, the GUI will be disabled. +If using X11, Vim's configure will by default first try to find the necessary +GTK+ files on your system. When both GTK+ 2 and GTK+ 3 are available, GTK+ 2 +will be chosen unless --enable-gui=gtk3 is passed explicitly to configure. + +If the GTK+ files cannot be found, then the Motif files will be searched for. +Finally, if this fails, the Athena files will be searched for. If all three +fail, the GUI will be disabled. + +For GTK+, Vim's configuration process uses pkg-config(1) to check if the +GTK+ required for a specified build is properly installed and usable. + +Accordingly, it is a good idea to make sure before running configure that +your system has a working pkg-config together with the .pc file of the +required GTK+. For that, say, run the following on the command line to see if +your pkg-config works with your GTK+ 2: > + + $ pkgconfig --modversion gtk+-2.0 -For GTK+, Vim's configuration process requires that GTK+ be properly -installed. That is, the shell script 'gtk-config' must be in your PATH, and -you can already successful compile, build, and execute a GTK+ program. The -reason for this is that the compiler flags (CFLAGS) and link flags (LDFLAGS) -are obtained through the 'gtk-config' shell script. +Replace gtk+-2.0 with gtk+-3.0 for GTK+ 3. If you get the correct version +number of your GTK+, you can proceed; if not, you probably need to do some +system administration chores to set up pkg-config and GTK+ correctly. -If you want to build with GTK+ 2 support pass the --enable-gtk2-check argument -to ./configure. Optionally, support for GNOME 2 will be compiled if the ---enable-gnome-check option is also given. +The GTK+ 2 GUI is built by default. Therefore, you usually don't need to pass +any options such as --enable-gui=gtk2 to configure and build that. + +Optionally, the GTK+ 2 GUI can consolidate the GNOME 2 support. This support +is enabled by passing --enable-gnome-check to configure. + +If you want to build the GTK+ 3 GUI, you have to pass --enable-gui=gtk3 +explicitly to configure, and avoid passing --enable-gnome-check to that, as +the functionality of the GNOME 2 support has already been consolidated in +GTK+ 3. Otherwise, if you are using Motif or Athena, when you have the Motif or Athena files in a directory where configure doesn't look, edit the Makefile to enter @@ -478,18 +500,14 @@ the names of the directories. Search for "GUI_INC_LOC" for an example to set the Motif directories, "CONF_OPT_X" for Athena. *gui-x11-gtk* -At the time of this writing, GTK+ version 1.0.6 and 1.2 are outdated. It -is suggested that you use GTK 2. The GTK 1 support will most likely be -dropped soon. - -For the GTK+ 2 GUI, using the latest release of the GTK+ 2.0 or GTK+ 2.2 -series is recommended. - -Lastly, although GTK+ has supposedly been ported to the Win32 platform, this -has not been tested with Vim and is also unsupported. Also, it's unlikely to -even compile since GTK+ GUI uses parts of the generic X11 code. This might -change in distant future; particularly because getting rid of the X11 centric -code parts is also required for GTK+ framebuffer support. +Currently, Vim supports both GTK+ 2 and GTK+ 3. + +The GTK+ 2 GUI requires GTK+ 2.2 or later. + +Although the GTK+ 3 GUI is written in such a way that the source code can be +compiled against all versions of the 3.x series, we recommend GTK+ 3.10 or +later because of its substantial implementation changes in redraw done at +that version. *gui-x11-motif* For Motif, you need at least Motif version 1.2 and/or X11R5. Motif 2.0 and diff --git a/runtime/doc/version8.txt b/runtime/doc/version8.txt index 1be8b83..0d98c2b 100644 --- a/runtime/doc/version8.txt +++ b/runtime/doc/version8.txt @@ -141,8 +141,25 @@ This adds the 'renderoptions' option to allow for switching on DirectX GTK+ 3 support ~ -GTK+ 2 is getting old, GTK+ 3 is here. Support has been added and it already -works quite well, mostly just like GTK+ 2. +At long last we made the support available (You are supposed to execute +|:smile| for yourself right now due to functional limitations of the help +system). + +The new GUI works just like GTK+ 2 except for hardly noticeable technical +differences between them. + +To build the GTK+ 3 GUI, pass --enable-gui=gtk3 explicitly to configure, or +equivalently, set the environment variable CONF_OPT_GUI to that (See +src/Makefile); otherwise, the build defaults to that of GTK+ 2. See +|gui-x11-compiling| for other details. + +In particular, you should not use --enable-gnome-check with GTK+ 3 build. See +|GNOME| for the reason. + +For runtime settings, a new |feature-list| item, gui_gtk3, is available. + +Refer to |GTK3| or |GTK| for further details, or |gui_x11.txt| for general +information about the Vim GUIs for X11. Vim script enhancements *new-vim-script-8* diff --git a/src/Makefile b/src/Makefile index 690e08a..80dd190 100644 --- a/src/Makefile +++ b/src/Makefile @@ -336,8 +336,15 @@ CClink = $(CC) # Uncomment one of these lines if you have that GUI but don't want to use it. # The automatic check will use another one that can be found. # Gnome is disabled by default, it may cause trouble. +# +# Currently, priority is given to GTK+ 2 build over that of GTK+ 3. Hence the +# combination of --disable-gtk2-check and --enable-gtk3-check confuses the +# build system for now. Accordingly, avoid use of it. To enable GTK+ 3 +# build while that of GTK+ 2 is disabled, use --enable-gui=gtk3 instead (See +# another CONF_OPT_GUI list succeeding to the next one). #CONF_OPT_GUI = --disable-gtk2-check #CONF_OPT_GUI = --enable-gnome2-check +#CONF_OPT_GUI = --disable-gtk3-check #CONF_OPT_GUI = --disable-motif-check #CONF_OPT_GUI = --disable-athena-check #CONF_OPT_GUI = --disable-nextaw-check @@ -348,18 +355,24 @@ CClink = $(CC) # # GTK versions that are known not to work 100% are rejected. # Use "--disable-gtktest" to accept them anyway. -# Only GTK 2 is supported, for GTK 1 use Vim 7.2. +# For GTK 1 use Vim 7.2. # # GNOME means GTK with Gnome support. If using GTK and --enable-gnome-check # is used then GNOME will automatically be used if it is found. If you have # GNOME, but do not want to use it (e.g., want a GTK-only version), then use # --enable-gui=gtk or leave out --enable-gnome-check. # +# GNOME makes sense only for GTK+ 2. Avoid use of --enable-gnome-check with +# GTK+ 3 build, as the functionality of GNOME is already incooperated into +# GTK+ 3. +# # If the selected GUI isn't found, the GUI is disabled automatically #CONF_OPT_GUI = --enable-gui=gtk2 #CONF_OPT_GUI = --enable-gui=gtk2 --disable-gtktest #CONF_OPT_GUI = --enable-gui=gnome2 #CONF_OPT_GUI = --enable-gui=gnome2 --disable-gtktest +#CONF_OPT_GUI = --enable-gui=gtk3 +#CONF_OPT_GUI = --enable-gui=gtk3 --disable-gtktest #CONF_OPT_GUI = --enable-gui=motif #CONF_OPT_GUI = --enable-gui=motif --with-motif-lib="-static -lXm -shared" #CONF_OPT_GUI = --enable-gui=athena