]> Pileus Git - ~andy/gtk/blob - README.in
Add a note about range arrow sensitivity.
[~andy/gtk] / README.in
1 General Information
2 ===================
3
4 This is GTK+ version @GTK_VERSION@. GTK+ is a multi-platform toolkit for
5 creating graphical user interfaces. Offering a complete set of widgets,
6 GTK+ is suitable for projects ranging from small one-off projects to
7 complete application suites.
8
9 GTK+ is free software and part of the GNU Project. However, the
10 licensing terms for GTK+, the GNU LGPL, allow it to be used by all
11 developers, including those developing proprietary software, without any
12 license fees or royalties.
13
14 The official ftp site is:
15   ftp://ftp.gtk.org/pub/gtk
16
17 The official web site is:
18   http://www.gtk.org/
19
20 Information about mailing lists can be found at
21   http://www.gtk.org/mailinglists.html
22
23 Installation
24 ============
25
26 See the file 'INSTALL'
27
28 Release notes for 2.10
29 ======================
30
31 * The hexadecimal Unicode input feature has been reworked. It no longer
32   blocks the use of the sixteen Ctrl-Shift-<hex digit> key sequences. Now
33   it only uses Ctrl-Shift-u.
34
35 * A memory leak in GtkStyle handling has been fixed. This may expose bugs
36   in third-party widgets which forget to call gtk_style_attach() in their
37   realize functions.
38
39 * Range widgets like GtkScrollbar now render their arrows insensitive
40   when the slider is at the end. Applications which react to arrow
41   clicks even if the slider is at the end may want to use the new
42   gtk_range_set_[upper/lower]_stepper_sensitivity() functions to
43   prevent the arrows from being rendered insensitive.
44
45 Release notes
46 =============
47
48 * GTK+ 2.6 supports clipboard persistency. To make use of this feature,
49   a clipboard manager following the specification at
50   http://www.freedesktop.org/wiki/Standards/clipboard-manager-spec
51   must be running. A sample implementation of such a clipboard manager
52   is available at 
53   http://people.imendio.com/andersca/archives/clipboard-manager-0.3.tar.gz
54   Applications can use the function gdk_display_supports_clipboard_persistence() 
55   to find out if clipboard persistence is available.
56
57 * Notification on clipboard ownership changes via GdkOwnerChange events 
58   requires the XFIXES X extension. Applications can use the function
59   gdk_display_supports_selection_notification() to find out if ownerchip
60   change notification is available.
61
62 * The icon theme code in GTK+ 2.6 follows the freedesktop.org icon theme 
63   specification. Setting the XDG_DATA_DIRS environtment variable may be 
64   necessary if your icons aren't installed in the default location 
65   /usr/share/icons.
66
67 * The icon theme code in GTK+ 2.6 can make use of mmap()able cache files
68   to avoid a lot of disk searching overhead. GTK+ includes a utility named
69   gtk-update-icon-cache to generate these cache files. For further details,
70   see the gtk-update-icon-cache man page or the GTK+ documentation.
71
72 * To reduce code size and improve efficiency, GTK+, when compiled 
73   with the GNU toolchain, has separate internal and external entry 
74   points for exported functions. The internal names, which begin with 
75   IA__, may be seen when debugging a GTK+ program.
76
77 * The following functions have been deprecated in GTK+ 2.6:
78   gdk_pango_context_set_colormap
79   gtk_cell_renderer_editing_canceled
80
81 * The new GtkFileChooser widget emphasizes simplicity and thus does 
82   not provide a navigation entry by default when opening files. 
83   Experienced command line users will likely want to make heavy use of
84   the location dialog brought up by the Control-L key shortcut.
85
86 * The GTK+ libraries use an '_' prefix to indicate private symbols that
87   must not be used by applications. On some platforms, symbols beginning 
88   with prefixes such as _gtk, _gdk, and _pango will be exported
89   from the library, on others not. In no case can applications
90   use these private symbols. In addition to that, GTK+ 2.6 makes several
91   symbols private which were not in any installed header files and
92   were never intended to be exported.
93
94 * The gdk_pixbuf_xlib library included in the contrib/ directory 
95   and the framebuffer GDK backend included in the gdk/linux-fb directory
96   of GTK+ are provided on an as-is basis and have not been tested at all. 
97   No guarantees about the degree of workingness or about future
98   compatibility are provided.
99
100 * On Unix, the assumption of GLib and GTK+ by default is that filenames on 
101   the filesystem are encoded in UTF-8 rather than the encoding of the locale;
102   the GTK+ developers consider that having filenames whose interpretation
103   depends on the current locale is fundamentally a bad idea.
104
105   If you have filenames encoded in the encoding of your locale, then you 
106   may want to set the G_FILENAME_ENCODING environment variable:
107   
108    G_FILENAME_ENCODING=@locale
109    export G_FILENAME_ENCODING
110
111   (Earlier versions of GLib 2.x required a different environment variable
112   setting; G_BROKEN_FILENAMES=1 to achieve the same effect; this 
113   is still supported, but G_FILENAME_ENCODING is preferred.)
114   Best integration of GTK+ 2.6 with the environment is achieved by 
115   using a UTF-8 locale.
116
117   On Windows, filenames passed to GTK+ should always be in UTF-8, as
118   in GLib 2.6. This is different than in previous versions of GTK+
119   where the system codepage was used. As in GLib, for DLL ABI
120   stability, applications built against previous versions of GTK+ will
121   use entry points providing the old semantics.
122
123   When compiling against GTK+ 2.6, applications intended to be
124   portable to Windows must take the UTF-8 file name encoding into
125   consideration, and use the gstdio wrappers to access files whose 
126   names have been constructed from strings returned from GTK+ or GLib.
127
128 How to report bugs
129 ==================
130
131 Bugs should be reported to the GNOME bug tracking system.
132 (http://bugzilla.gnome.org, product gtk+.) You will need to create an
133 account for yourself.
134   
135 In the bug report please include:
136   
137 * Information about your system. For instance:
138
139    - What operating system and version
140    - What version of X
141    - For Linux, what version of the C library
142
143   And anything else you think is relevant.
144
145 * How to reproduce the bug. 
146
147   If you can reproduce it with one of the tests or demos built with GTK+, 
148   such as demos/gtk-demo/gtk-demo, that would be most convenient. Otherwise, 
149   please include a short test program that exhibits the behavior. As a 
150   last resort, you can also provide a pointer to a larger piece of software 
151   that can be downloaded.
152
153 * If the bug was a crash, the exact text that was printed out when the
154   crash occured.
155
156 * Further information such as stack traces may be useful, but is not
157   necessary. If you do send a stack trace, and the error is an X error,
158   it will be more useful if the stacktrace is produced running the test
159   program with the --sync command line option.
160
161 Patches
162 =======
163
164 Patches should also be submitted to bugzilla.gnome.org. If the patch
165 fixes an existing bug, add the patch as an attachment to that bug
166 report.
167
168 Otherwise, enter a new bug report that describes the patch, and attach
169 the patch to that bug report.
170
171 Bug reports containing patches should include the PATCH keyword in their
172 keyword fields. If the patch adds to or changes the GTK+ programming
173 interface, the API keyword should also be included.
174   
175 Patches should be in unified diff form. (The -u option to GNU diff.)