From 7e7eaf315b25417252304d7fc53faeaaf3945e67 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 9 Feb 2011 00:21:37 -0500 Subject: [PATCH] Documentation tweaks --- docs/reference/gtk/building.sgml | 21 +++++++++--- docs/reference/gtk/gtk-docs.sgml | 10 ++++-- .../reference/gtk/gtk-query-immodules-3.0.xml | 15 +++++---- docs/reference/gtk/gtk-update-icon-cache.xml | 32 ++++++++++--------- docs/reference/gtk/question_index.sgml | 10 +++--- docs/reference/gtk/running.sgml | 4 +-- 6 files changed, 56 insertions(+), 36 deletions(-) diff --git a/docs/reference/gtk/building.sgml b/docs/reference/gtk/building.sgml index 70802e53c9..9e60e927be 100644 --- a/docs/reference/gtk/building.sgml +++ b/docs/reference/gtk/building.sgml @@ -172,7 +172,7 @@ How to compile GTK+ itself such as high level data types, Unicode manipulation, and an object and type system to C programs. It is available from the GTK+ - FTP site. + FTP site. @@ -180,7 +180,7 @@ How to compile GTK+ itself Pango is a library for internationalized text handling. It is available from the GTK+ FTP - site.. + site. @@ -189,7 +189,7 @@ How to compile GTK+ itself interfaces allowing accessibility technologies such as screen readers to interact with a graphical user interface. It is available from the GTK+ FTP site. + url="ftp://ftp.gtk.org/pub/atk/">GTK+ FTP site. @@ -309,49 +309,60 @@ How to compile GTK+ itself configure - + --disable-modules --enable-modules + --with-included-immodules=MODULE1,MODULE2,... + --enable-debug=[no/minimum/yes] + --disable-Bsymbolic --enable-Bsymbolic + --disable-xkb --enable-xkb + --disable-xinerama --enable-xinerama + --disable-gtk-doc --enable-gtk-doc + --disable-cups --enable-cups + --disable-papi --enable-papi + --enable-xinput --disable-xinput + --enable-packagekit --disable-packagekit + --enable-x11-backend --disable-x11-backend @@ -360,9 +371,11 @@ How to compile GTK+ itself --enable-quartz-backend --disable-quartz-backend + --enable-introspection=[no/auto/yes] + --enable-gtk2-dependency --disable-gtk2-dependency diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml index 0274da7a8f..2deabd9232 100644 --- a/docs/reference/gtk/gtk-docs.sgml +++ b/docs/reference/gtk/gtk-docs.sgml @@ -10,9 +10,13 @@ GTK+ 3 Reference Manual - This document is for GTK+ 3 library; the latest version can be found online at - http://library.gnome.org/devel/gtk/unstable/. - If you're looking for the older GTK+ 2 series of libraries, they can be found under their version numbers; for example, 2.22 is available at http://library.gnome.org/devel/gtk/2.22/. + This document is for the GTK+ 3 library, version &version;. + The latest version can be found online at + http://library.gnome.org/devel/gtk/unstable/. + If you are looking for the older GTK+ 2 series of libraries, + they can be found under their version numbers; for example, + 2.22 is available at + http://library.gnome.org/devel/gtk/2.22/. diff --git a/docs/reference/gtk/gtk-query-immodules-3.0.xml b/docs/reference/gtk/gtk-query-immodules-3.0.xml index c9e541b6d2..97af84df11 100644 --- a/docs/reference/gtk/gtk-query-immodules-3.0.xml +++ b/docs/reference/gtk/gtk-query-immodules-3.0.xml @@ -5,13 +5,14 @@ -gtk-query-immodules-3.0 -1 + gtk-query-immodules-3.0 + 1 + User Commands -gtk-query-immodules-3.0 -Input method module registration utility + gtk-query-immodules-3.0 + Input method module registration utility @@ -38,8 +39,8 @@ may be absolute or relative paths. Normally, the output of gtk-query-immodules-3.0 is written -to libdirgtk-3.0/3.0.0/immodules.cache, where GTK+ looks for it by default. If it is written to some other -location, the environment variable GTK_IM_MODULE_FILE +to libdir/gtk-3.0/3.0.0/immodules.cache, where GTK+ looks for it by default. If it is written to some other +location, the environment variable GTK_IM_MODULE_FILE can be set to point GTK+ at the file. @@ -56,7 +57,7 @@ can be set to point GTK+ at the file. Environment -The environment variable GTK_PATH +The environment variable GTK_PATH can be used to prepend directories to the input method module path. diff --git a/docs/reference/gtk/gtk-update-icon-cache.xml b/docs/reference/gtk/gtk-update-icon-cache.xml index 2a5bc27fbf..d6f3ac850f 100644 --- a/docs/reference/gtk/gtk-update-icon-cache.xml +++ b/docs/reference/gtk/gtk-update-icon-cache.xml @@ -5,13 +5,14 @@ -gtk-update-icon-cache -1 + gtk-update-icon-cache + 1 + User Commands -gtk-update-icon-cache -Icon theme caching utility + gtk-update-icon-cache + Icon theme caching utility @@ -20,28 +21,29 @@ --force --ignore-theme-index --index-only ---sourcename +--source NAME --quiet --validate -iconpath +PATH Description - gtk-update-icon-cache creates mmap()able cache + gtk-update-icon-cache creates mmapable cache files for icon themes. - It expects to be given the path to a icon theme directory containing an - index.theme, e.g. /usr/share/icons/hicolor, - and writes a icon-theme.cache containing cached - information about the icons in the directory tree below the given directory. + It expects to be given the PATH to a icon theme + directory containing an index.theme, e.g. + /usr/share/icons/hicolor, and writes a + icon-theme.cache containing cached information about + the icons in the directory tree below the given directory. GTK+ can use the cache files created by gtk-update-icon-cache to avoid a lot of system call and disk seek overhead when the application - starts. Since the format of the cache files allows them to be mmap()ed + starts. Since the format of the cache files allows them to be mmaped shared between multiple applications, the overall memory consumption is reduced as well. @@ -59,8 +61,8 @@ --ignore-theme-index -t - Don't check for the existence of 'index.theme' in the icon - theme directory. Without this option, gtk-update-icon-cache + Don't check for the existence of index.theme + in the icon theme directory. Without this option, gtk-update-icon-cache refuses to create an icon cache in a directory which does not appear to be the toplevel directory of an icon theme. @@ -77,7 +79,7 @@ --source -c Output a C header file declaring a constant - name with the contents of the icon + NAME with the contents of the icon cache. diff --git a/docs/reference/gtk/question_index.sgml b/docs/reference/gtk/question_index.sgml index b633a48f4d..24f6b99413 100644 --- a/docs/reference/gtk/question_index.sgml +++ b/docs/reference/gtk/question_index.sgml @@ -35,11 +35,11 @@ How do I get started with GTK+? -The GTK+ website offers a -tutorial and a -FAQ. More documentation ranging -from whitepapers to online books can be found at the -GNOME developer's site. +The GTK+ website offers some +tutorials and other +documentation (most of it about GTK+ 2.x, but mostly still applicable). +More documentation ranging from whitepapers to online books can be found at +the GNOME developer's site. After studying these materials you should be well prepared to come back to this reference manual for details. diff --git a/docs/reference/gtk/running.sgml b/docs/reference/gtk/running.sgml index b2b894601b..40a70d7ac0 100644 --- a/docs/reference/gtk/running.sgml +++ b/docs/reference/gtk/running.sgml @@ -205,7 +205,7 @@ additional environment variables. - + <envar>GTK_PATH</envar> @@ -265,7 +265,7 @@ additional environment variables. - + <envar>GTK_IM_MODULE_FILE</envar>