From 74fabedaff711c78a0ad576a00334b243789aed1 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 11 Jan 2002 22:39:03 +0000 Subject: [PATCH] Expand. * gdk/tmpl/general.sgml (gdk_set_program_class): Expand. * gtk/running.sgml: New file. * gtk/building.sgml: Document a few more configure options. * gtk/Makefile.am (content_files): Add running.sgml. * gtk/gtk-docs.sgml: Include running.sgml, sort H and V variants of widgets to be next to each other. --- docs/reference/gdk/tmpl/general.sgml | 4 +- docs/reference/gtk/Makefile.am | 1 + docs/reference/gtk/building.sgml | 103 +++++++- docs/reference/gtk/gtk-docs.sgml | 14 +- docs/reference/gtk/running.sgml | 352 +++++++++++++++++++++++++++ 5 files changed, 464 insertions(+), 10 deletions(-) create mode 100644 docs/reference/gtk/running.sgml diff --git a/docs/reference/gdk/tmpl/general.sgml b/docs/reference/gdk/tmpl/general.sgml index c4dbc3de2a..944e08eac3 100644 --- a/docs/reference/gdk/tmpl/general.sgml +++ b/docs/reference/gdk/tmpl/general.sgml @@ -126,7 +126,9 @@ with g_get_prgname()) with the first character converted to uppercase. -Sets the program class. +Sets the program class. The X11 backend uses the program class to set +the class name part of the WM_CLASS property on +toplevel windows; see the ICCCM. @program_class: a string. diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am index 9d3240ab83..61d40133f7 100644 --- a/docs/reference/gtk/Makefile.am +++ b/docs/reference/gtk/Makefile.am @@ -122,6 +122,7 @@ HTML_IMAGES = \ # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE) content_files = \ + running.sgml \ building.sgml \ changes-1.2.sgml \ changes-2.0.sgml \ diff --git a/docs/reference/gtk/building.sgml b/docs/reference/gtk/building.sgml index 4f47b2c030..8cb24d6d49 100644 --- a/docs/reference/gtk/building.sgml +++ b/docs/reference/gtk/building.sgml @@ -59,12 +59,34 @@ How to compile GTK+ itself --with-included-loaders==LOADER1,LOADER2,... + + --enable-debug=[no|minimum|yes] + + + --disable-shm + --enable-shm + + + --disable-xim + --enable-xim + + + --disable-xim-inst + --enable-xim-inst + + + --disable-xkb + --enable-xkb + --disable-gtk-doc --enable-gtk-doc + + --with-xinput=[no|gxi|xfree] + - --with-gdktarget=[x11|linux-fb] + --with-gdktarget=[x11|linux-fb|win32] --disable-shadowfb @@ -101,6 +123,72 @@ How to compile GTK+ itself + + <systemitem>--enable-debug</systemitem> + + + Turns on various amounts of debugging support. Setting this to 'no' + disables g_assert(), g_return_if_fail(), g_return_val_if_fail() and + all cast checks between different object types. Setting it to 'minimum' + disables only cast checks. Setting it to 'yes' enables + runtime debugging. + The default is 'minimum'. + Note that 'no' is fast, but dangerous as it tends to destabilize + even mostly bug-free software by changing the effect of many bugs + from simple warnings into fatal crashes. Thus + should not + be used for stable releases of gtk+. + + + + + <systemitem>--disable-shm</systemitem> and + <systemitem>--enable-shm</systemitem> + + + These options can be used to control whether GTK+ will use shared + memory to communicate with the X server when possible. + The default is yes. + + + + + <systemitem>--disable-xim</systemitem> and + <systemitem>--enable-xim</systemitem> + + + These options can be used to control whether GTK+ will + be compiled with support for XIM. + The default is yes. + + + + + <systemitem>--disable-xim-inst</systemitem> and + <systemitem>--enable-xim-inst</systemitem> + + + These options determine whether GTK+ will use the + XIM instantiate callback. + The default is yes, unless the host system is Solaris, + where XRegisterIMInstantiateCallback + seems to cause a segfault. + + + + + <systemitem>--disable-xkb</systemitem> and + <systemitem>--enable-xkb</systemitem> + + + By default the configure script will try + to auto-detect whether the XKB extension is supported by + the X libraries GTK+ is linked with. + These options can be used to explicitly control whether + GTK+ will support the XKB extension. + + + <systemitem>--disable-gtk-doc</systemitem> and <systemitem>--enable-gtk-doc</systemitem> @@ -119,12 +207,21 @@ How to compile GTK+ itself + + <systemitem>--with-xinput</systemitem> + + + + + + <systemitem>--with-gdktarget</systemitem> - Toggles between the x11 and linux-fb backends for GDK. - The default is x11. + Toggles between the supported backends for GDK. + The default is x11, unless the platform is Windows, in which + case the default is win32. diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml index a0c4101508..4d02cae7b0 100644 --- a/docs/reference/gtk/gtk-docs.sgml +++ b/docs/reference/gtk/gtk-docs.sgml @@ -149,6 +149,7 @@ + @@ -245,6 +246,7 @@ that is, GUI components such as #GtkButton or #GtkTextView. >k-Building; >k-Compiling; + >k-Running; >k-Windows; >k-Framebuffer; >k-Changes-1-2; @@ -318,8 +320,8 @@ that is, GUI components such as #GtkButton or #GtkTextView. Numeric/Text Data Entry &GtkEntry; &GtkHScale; - &GtkSpinButton; &GtkVScale; + &GtkSpinButton; @@ -383,15 +385,15 @@ that is, GUI components such as #GtkButton or #GtkTextView. &GtkAlignment; &GtkAspectFrame; &GtkHBox; + &GtkVBox; &GtkHButtonBox; + &GtkVButtonBox; &GtkFixed; &GtkHPaned; + &GtkVPaned; &GtkLayout; &GtkNotebook; &GtkTable; - &GtkVButtonBox; - &GtkVBox; - &GtkVPaned; @@ -404,8 +406,8 @@ that is, GUI components such as #GtkButton or #GtkTextView. Scrolling &GtkHScrollbar; - &GtkScrolledWindow; &GtkVScrollbar; + &GtkScrolledWindow; @@ -452,8 +454,8 @@ that is, GUI components such as #GtkButton or #GtkTextView. Special-purpose features &GtkCurve; &GtkGammaCurve; - &GtkHRuler; &GtkRuler; + &GtkHRuler; &GtkVRuler; diff --git a/docs/reference/gtk/running.sgml b/docs/reference/gtk/running.sgml new file mode 100644 index 0000000000..5cdf669b59 --- /dev/null +++ b/docs/reference/gtk/running.sgml @@ -0,0 +1,352 @@ + + +Running GTK+ Applications +3 +GTK Library + + + +Running GTK+ Applications + +How to run and debug your GTK+ application + + + + +Running and debugging GTK+ Applications + + +Common commandline options + + +All GTK+ applications support a number of standard commandline +options. These are removed from argv by +gtk_init(). Modules may parse and remove further options. + + + +<systemitem>--gtk-module <replaceable>module</replaceable></systemitem> + + +A list of modules to load in addition to those specified in the +GTK_MODULES environment variable. + + + + +<systemitem>--g-fatal-warnings</systemitem> + + +Make GTK+ abort on all warnings. + + + + +<systemitem>--gtk-debug <replaceable>options</replaceable></systemitem> + + +A list of debug options +to turn on in addition to those specified in the GTK_DEBUG +environment variable. +This option is only available if GTK+ has been configured with +. + + + + +<systemitem>--gtk-no-debug <replaceable>options</replaceable></systemitem> + + +A list of debug options +to turn off. +This option is only available if GTK+ has been configured with +. + + + + +The following options are really used by GDK, not by GTK+, but we +list them here for completeness nevertheless. + + + +<systemitem>--class <replaceable>class</replaceable></systemitem> + + +Sets the program class; see gdk_set_program_class(). + + + + +<systemitem>--name <replaceable>name</replaceable></systemitem> + + +Sets the program name. + + + + +<systemitem>--gdk-debug <replaceable>options</replaceable></systemitem> + + +A list of debug options +to turn on in addition to those +specified in the GDK_DEBUG environment variable. +This option is only available if GTK+ has been configured with +. + + + + +<systemitem>--gdk-no-debug <replaceable>options</replaceable></systemitem> + + +A list of debug options +to turn off. +This option is only available if GTK+ has been configured with +. + + + + +<systemitem>--display <replaceable>display</replaceable></systemitem> + + +The name of the X display to open instead of the one specified +in the DISPLAY. +This option is only available if GTK+ has been configured with +. + + + + +<systemitem>--sync</systemitem> + + +Makes all X requests synchronously. This is a useful option for +debugging, but it will slow down the performance considerably. +This option is only available if GTK+ has been configured with +. + + + + +<systemitem>--gxid-host <replaceable>host</replaceable></systemitem> + + +The host to contact the gxid daemon on; overwrites +the GXID_HOST environment variable. +This option is only available if GTK+ has been configured with +. + + + + +<systemitem>--gxid-port <replaceable>port</replaceable></systemitem> + + +The port for the connection to gxid; overwrites +the GXID_PORT environment variable. +This option is only available if GTK+ has been configured with +. + + + + + + +Environment variables + + +GTK+ inspects a number of environment variables in addition to standard +variables like LANG, PATH, HOME +or DISPLAY; mostly to determine paths to look for certain files. + + + + <envar>GTK_DEBUG</envar> + + + If GTK+ has been configured with , + this variable can be set to a list of debug options, which cause GTK+ + to print out different types of debugging information. + + + misc + Miscellaneous information + + + text + Information about text widget internals + + + tree + Information about tree widget internals + + + updates + Visual feedback about window updates + + + The special value all can be used to turn on all debug options. + + + + + <envar>GTK_MODULES</envar> + + + A list of modules to load. + + + + + <envar>GTK_MODULE_PATH</envar> + + + A list of directories to search for modules before the default module + directory, which is <libdir>/gtk-2.0/modules. + (If GTK_EXE_PREFIX is defined, <libdir> is + $GTK_EXE_PREFIX/lib. Otherwise it is the libdir + specified when GTK+ was configured, usually + /usr/local/lib.) + For each directory in the list, GTK+ actually looks first in + a subdirectory named after the version number of GTK+, then in the + directory itself and finally in the system-specific library path. + + + + + <envar>GTK_IM_MODULE</envar> + + + Specifies an IM module to use in preference to the one determined + from the locale. + + + + + <envar>GTK_IM_MODULE_PATH</envar> + + + Specifies the path where GTK+ looks for IM modules. This environment + variable overwrites the im_module_path specified in the + RC files, which in turn overwrites the default + value $lt;libdir$gt;/gtk-2.0/immodules/<version> + (where <version> is the GTK+ version, and <libdir> is as + explained above). + + + + + <envar>GTK_IM_MODULE_FILE</envar> + + + Specifies the file listing the IM modules to load. This environment + variable overwrites the im_module_file specified in + the RC files, which in turn overwrites the default value + <sysconfdir>/gtk-2.0/gtk.immodules + (<sysconfdir> is the sysconfdir specified when GTK+ was configured, + usually /usr/local/etc.) + + + + + <envar>GTK_RC_FILES</envar> + + + Specifies a list of RC files to parse instead of the default ones; + see Resource Files. + + + + <envar>GTK_EXE_PREFIX</envar> + + + If set, GTK+ uses $GTK_EXE_PREFIX/lib instead of + the libdir configured when GTK+ was compiled. + + + + + <envar>GTK_DATA_PREFIX</envar> + + + If set, makes GTK+ use $GTK_DATA_PREFIX + instead of the prefix configured when GTK+ was compiled. + + + + +The following environment variables are used by GdkPixbuf, GDK or +Pango, not by GTK+ itself, but we list them here for completeness +nevertheless. + + + + <envar>GDK_PIXBUF_MODULEDIR</envar> + + + Specifies the directory to look for GdkPixbuf loader modules. + By default, GdkPixbuf looks for its loaders in + <libdir>/gtk-2.0/<version>/loaders. + + + + + <envar>GDK_DEBUG</envar> + + + If GTK+ has been configured with , + this variable can be set to a list of debug options, which cause GDK + to print out different types of debugging information. + + + misc + Miscellaneous information + + + events + Show all events received by GDK + + + dnd + Information about drag-and-drop + + + xim + Information about XIM support + + + The special value all can be used to turn on all debug options. + + + + + <envar>GXID_HOST</envar> and <envar>GXID_PORT</envar> + + + The host and port to contact the gxid daemon on. + gxid is only necessary on X servers which + don't support using the pointer and extension devices at once, and is + only built if GTK+ is configured with . + The XFree86 X servers don't have this + restriction. + + + + + <envar>GDK_USE_XFT</envar> + + + If this variable is set to 1, GTK+ will use the Pango Xft backend instead + of the X backend when possible (i.e. when the X server supports the XRender + extension and Pango has been built with Xft support). + + + + + + + +