]> Pileus Git - ~andy/gtk/blob - README
Added <public> documentation to the struct, as suggested by Owen Taylor.
[~andy/gtk] / README
1 General Information
2 ===================
3
4 This is GTK+ version 2.3.1. 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
29 =============
30
31 * As compared to GTK+-1.2, the default configuration of GTK+-2 has been 
32   stream-lined to reduce confusion on the part of new users or users 
33   coming from other environments.  Users used to older versions of 
34   GTK+ may want to make some adjustments to the default configuration.
35
36    - Emacs keybindings such as Control-A and Control-E to move to the
37      ends of lines are not enabled by default in the editing widgets. To
38      turn on Emacs keybindings, add the line:
39
40       gtk-key-theme-name = "Emacs"
41    
42      To your ~/.gtkrc-2.0
43
44    - Editing of menu accelerators by pressing an accelerator over the
45      menu item is disabled by default. To enable, it, add:
46
47       gtk-can-change-accels = 1
48
49      to your ~/.gtkrc-2.0
50
51    - To improve useability for keyboard operation, GTK+ now selects the
52      contents of an entry when tabbing into it or when it is focused on
53      initial window map. To disable this behavior, add:
54
55       gtk-entry-select-on-focus = 0
56  
57      to your ~/.gtkrc-2.0
58
59 * The GTK+ libraries use an '_' prefix to indicate private symbols that
60   must not be used by applications. On some platforms, symbols beginning 
61   with prefixes such as _gtk, _gdk, and _pango will be exported
62   from the library, on others not. In no case can applications
63   use these private symbols.
64
65 * GTK+-2.3 now requires version 2 of Xft; old fashioned core X
66   fonts are no longer supported.
67
68 * There is a bug in the Xft library in XFree86-4.1 and possibly previous
69   versions that causes random crashes when using the Pango Xft
70   backend. If you want to use Xft fonts, you should upgrade to
71   at least XFree86-4.2.
72
73 * The gdk_pixbuf_xlib library included in the contrib/ directory of GTK+
74   is provided on a as-is basis and has not been tested at all. No
75   guarantees about the degree of workingness or about future
76   compatibility are provided.
77
78 * While efforts have been made to make gdk-pixbuf robust against
79   invalid images, using gdk-pixbuf to load untrusted data 
80   is not recommended, due to the likelyhood that there are
81   additional problems where an invalid image could cause
82   gdk-pixbuf to crash or worse.
83
84 * The assumption of GLib and GTK+ by default is that filenames on the
85   filesystem are encoded in UTF-8 rather than the encoding of the locale;
86   The GTK+ developers consider that having filenames whose interpretation
87   depends on the current locale is fundamentally a bad idea.
88
89   If you have filenames encoded in the encoding of your locale, then
90   you may want to set the G_BROKEN_FILENAMES environment variable:
91   
92    G_BROKEN_FILENAMES=1
93    export G_BROKEN_FILENAMES
94
95   Best integration of GTK+-2.2 with the environment is achieved by 
96   using a UTF-8 locale.
97
98 How to report bugs
99 ==================
100
101 Bugs should be reported to the GNOME bug tracking system.
102 (http://bugzilla.gnome.org, product gtk+.) You will need to create an
103 account for yourself.
104   
105 In the bug report please include:
106   
107 * Information about your system. For instance:
108
109    - What operating system and version
110    - What version of X
111    - For Linux, what version of the C library
112
113   And anything else you think is relevant.
114
115 * How to reproduce the bug. 
116
117   If you can reproduce it with the testgtk program that is built in the
118   gtk/ subdirectory, that will be most convenient.  Otherwise, please
119   include a short test program that exhibits the behavior.  As a last
120   resort, you can also provide a pointer to a larger piece of software
121   that can be downloaded.
122
123 * If the bug was a crash, the exact text that was printed out when the
124   crash occured.
125
126 * Further information such as stack traces may be useful, but is not
127   necessary. If you do send a stack trace, and the error is an X error,
128   it will be more useful if the stacktrace is produced running the test
129   program with the --sync command line option.
130
131 Patches
132 =======
133
134 Patches should also be submitted to bugzilla.gnome.org. If the patch
135 fixes an existing bug, add the patch as an attachment to that bug
136 report.
137
138 Otherwise, enter a new bug report that describes the patch, and attach
139 the patch to that bug report.
140
141 Bug reports containing patches should include the PATCH keyword in their
142 keyword fields. If the patch adds to or changes the GTK programming
143 interface, the API keyword should also be included.
144   
145 Patches should be in unified diff form. (The -u option to GNU diff.)