]> Pileus Git - ~andy/gtk/blobdiff - README
Add GtkLinkButton to gallery
[~andy/gtk] / README
diff --git a/README b/README
index 6159a9f8ff40951a49179d3211d8d144e7786c82..7c0bd8dcb6e39ac82d0f61e2375d0bb7ba04f9d4 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
 General Information
 ===================
 
 General Information
 ===================
 
-This is GTK+ version 2.1.4. GTK+ is a multi-platform toolkit for
+This is GTK+ version 2.8.2. GTK+ is a multi-platform toolkit for
 creating graphical user interfaces. Offering a complete set of widgets,
 GTK+ is suitable for projects ranging from small one-off projects to
 complete application suites.
 creating graphical user interfaces. Offering a complete set of widgets,
 GTK+ is suitable for projects ranging from small one-off projects to
 complete application suites.
@@ -25,94 +25,89 @@ Installation
 
 See the file 'INSTALL'
 
 
 See the file 'INSTALL'
 
-GTK+-2.0.0 Specific Notes
-=========================
-
-* The default configuration of GTK+ has been stream-lined to reduce
-  confusion on the part of new users or users coming from other
-  environments.  Users used to older versions of GTK+ may want to make
-  some adjustments to the default configuration.
-
-   - Emacs keybindings such as Control-A and Control-E to move to the
-     ends of lines are not enabled by default in the editing widgets. To
-     turn on Emacs keybindings, add the line:
-
-      gtk-key-theme-name = "Emacs"
-   
-     To your ~/.gtkrc-2.0
-
-   - Editing of menu accelerators by pressing an accelerator over the
-     menu item is disabled by default. To enable, it, add:
-
-      gtk-can-change-accels = 1
-
-     to your ~/.gtkrc-2.0
-
-   - To improve useability for keyboard operation, GTK+ now selects the
-     contents of an entry when tabbing into it or when it is focused on
-     initial window map. To disable this behavior, add:
-
-      gtk-entry-select-on-focus = 0
-     to your ~/.gtkrc-2.0
+Release notes
+=============
+
+* GTK+ 2.6 supports clipboard persistency. To make use of this feature,
+  a clipboard manager following the specification at
+  http://www.freedesktop.org/wiki/Standards/clipboard-manager-spec
+  must be running. A sample implementation of such a clipboard manager
+  is available at 
+  http://people.imendio.com/andersca/archives/clipboard-manager-0.3.tar.gz
+  Applications can use the function gdk_display_supports_clipboard_persistence() 
+  to find out if clipboard persistence is available.
+
+* Notification on clipboard ownership changes via GdkOwnerChange events 
+  requires the XFIXES X extension. Applications can use the function
+  gdk_display_supports_selection_notification() to find out if ownerchip
+  change notification is available.
+
+* The icon theme code in GTK+ 2.6 follows the freedesktop.org icon theme 
+  specification. Setting the XDG_DATA_DIRS environtment variable may be 
+  necessary if your icons aren't installed in the default location 
+  /usr/share/icons.
+
+* The icon theme code in GTK+ 2.6 can make use of mmap()able cache files
+  to avoid a lot of disk searching overhead. GTK+ includes a utility named
+  gtk-update-icon-cache to generate these cache files. For further details,
+  see the gtk-update-icon-cache man page or the GTK+ documentation.
+
+* To reduce code size and improve efficiency, GTK+, when compiled 
+  with the GNU toolchain, has separate internal and external entry 
+  points for exported functions. The internal names, which begin with 
+  IA__, may be seen when debugging a GTK+ program.
+
+* The following functions have been deprecated in GTK+ 2.6:
+  gdk_pango_context_set_colormap
+  gtk_cell_renderer_editing_canceled
+
+* The new GtkFileChooser widget emphasizes simplicity and thus does 
+  not provide a navigation entry by default when opening files. 
+  Experienced command line users will likely want to make heavy use of
+  the location dialog brought up by the Control-L key shortcut.
 
 * The GTK+ libraries use an '_' prefix to indicate private symbols that
 
 * The GTK+ libraries use an '_' prefix to indicate private symbols that
-  must not be used by applications. The intention was not to export
-  symbols beginning with prefixes such as _gtk, _gdk, and _pango from
-  the libraries at all, but due to a bug in libtool, they are actually
-  exported at the moment on some platforms (including Linux). 
-  Applications that use these private symbols _will_ break when
-  this bug is fixed.
-
-* The Xft library that GTK+ uses to display anti-aliased fonts will
-  undergo a major version revision in the next few months. To deal with
-  this, by default, GTK+ and Pango are built so that applications will
-  not have explicit dependencies on version 1 on Xft. To make sure that
-  your application will be binary compatible with future versions of
-  GTK+:
-
-    - Do not configure Pango or GTK+ with the --enable-static or
-      --enable-explicit otions, since they will cause dependencies on
-      Xft version 1.
-
-    - Do not use Xft directly in your applicatons.
-
-* There is a bug in the Xft library in XFree86-4.1 and possibly previous
-  versions that causes random crashes when using the Pango Xft
-  backend. If you want to use Xft fonts, you should upgrade to
-  XFree86-4.2.
-
-* Xft support is not on by default. To turn it on set the environment
-  variable GDK_USE_XFT to '1'
-
-   GDK_USE_XFT=1
-   export GDK_USE_XFT
-
-* The gdk_pixbuf_xlib library included in the contrib/ directory of GTK+
-  is provided on a as-is basis and has not been tested at all. No
-  guarantees about the degree of workingness or about future
+  must not be used by applications. On some platforms, symbols beginning 
+  with prefixes such as _gtk, _gdk, and _pango will be exported
+  from the library, on others not. In no case can applications
+  use these private symbols. In addition to that, GTK+ 2.6 makes several
+  symbols private which were not in any installed header files and
+  were never intended to be exported.
+
+* The gdk_pixbuf_xlib library included in the contrib/ directory 
+  and the framebuffer GDK backend included in the gdk/linux-fb directory
+  of GTK+ are provided on an as-is basis and have not been tested at all. 
+  No guarantees about the degree of workingness or about future
   compatibility are provided.
 
   compatibility are provided.
 
-* There are known problems with some of the image loaders in the
-  gdk-pixbuf library included in GTK+ where corrupted images can cause
-  crashes and conceivably worse problems. Until these problems are fixed
-  (we hope to have this done for 2.0.1), gdk-pixbuf should not be used
-  to load untrusted data.
-
-* The assumption of GLib and GTK+ by default is that filenames on the
-  filesystem are encoded in UTF-8 rather than the encoding of the locale;
-  The GTK+ developers consider that having filenames whose interpretation
+* On Unix, the assumption of GLib and GTK+ by default is that filenames on 
+  the filesystem are encoded in UTF-8 rather than the encoding of the locale;
+  the GTK+ developers consider that having filenames whose interpretation
   depends on the current locale is fundamentally a bad idea.
 
   depends on the current locale is fundamentally a bad idea.
 
-  If you have filenames encoded in the encoding of your locale, then
-  you may want to set the G_BROKEN_FILENAMES environment variable:
+  If you have filenames encoded in the encoding of your locale, then you 
+  may want to set the G_FILENAME_ENCODING environment variable:
   
   
-   G_BROKEN_FILENAMES=1
-   export G_BROKEN_FILENAMES
+   G_FILENAME_ENCODING=@locale
+   export G_FILENAME_ENCODING
 
 
-  Best integration of GTK+-2.0 with the environment is achieved by 
+  (Earlier versions of GLib 2.x required a different environment variable
+  setting; G_BROKEN_FILENAMES=1 to achieve the same effect; this 
+  is still supported, but G_FILENAME_ENCODING is preferred.)
+  Best integration of GTK+ 2.6 with the environment is achieved by 
   using a UTF-8 locale.
 
   using a UTF-8 locale.
 
+  On Windows, filenames passed to GTK+ should always be in UTF-8, as
+  in GLib 2.6. This is different than in previous versions of GTK+
+  where the system codepage was used. As in GLib, for DLL ABI
+  stability, applications built against previous versions of GTK+ will
+  use entry points providing the old semantics.
+
+  When compiling against GTK+ 2.6, applications intended to be
+  portable to Windows must take the UTF-8 file name encoding into
+  consideration, and use the gstdio wrappers to access files whose 
+  names have been constructed from strings returned from GTK+ or GLib.
+
 How to report bugs
 ==================
 
 How to report bugs
 ==================
 
@@ -132,10 +127,10 @@ In the bug report please include:
 
 * How to reproduce the bug. 
 
 
 * How to reproduce the bug. 
 
-  If you can reproduce it with the testgtk program that is built in the
-  gtk/ subdirectory, that will be most convenient.  Otherwise, please
-  include a short test program that exhibits the behavior.  As a last
-  resort, you can also provide a pointer to a larger piece of software
+  If you can reproduce it with one of the tests or demos built with GTK+, 
+  such as demos/gtk-demo/gtk-demo, that would be most convenient. Otherwise, 
+  please include a short test program that exhibits the behavior. As a 
+  last resort, you can also provide a pointer to a larger piece of software 
   that can be downloaded.
 
 * If the bug was a crash, the exact text that was printed out when the
   that can be downloaded.
 
 * If the bug was a crash, the exact text that was printed out when the
@@ -157,7 +152,7 @@ Otherwise, enter a new bug report that describes the patch, and attach
 the patch to that bug report.
 
 Bug reports containing patches should include the PATCH keyword in their
 the patch to that bug report.
 
 Bug reports containing patches should include the PATCH keyword in their
-keyword fields. If the patch adds to or changes the GTK programming
+keyword fields. If the patch adds to or changes the GTK+ programming
 interface, the API keyword should also be included.
   
 Patches should be in unified diff form. (The -u option to GNU diff.)
 interface, the API keyword should also be included.
   
 Patches should be in unified diff form. (The -u option to GNU diff.)