Pileus Git - ~andy/gtk/blob - docs/reference/gtk/running.sgml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
   4 ]>
   5 <refentry id="gtk-running">
   6 <refmeta>
   7 <refentrytitle>Running GTK+ Applications</refentrytitle>
   8 <manvolnum>3</manvolnum>
   9 <refmiscinfo>GTK Library</refmiscinfo>
  10 </refmeta>
  11
  12 <refnamediv>
  13 <refname>Running GTK+ Applications</refname>
  14 <refpurpose>
  15 How to run and debug your GTK+ application
  16 </refpurpose>
  17 </refnamediv>
  18
  19 <refsect1>
  20 <title>Running and debugging GTK+ Applications</title>
  21
  22 <refsect2>
  23 <title>Common commandline options</title>
  24
  25 <para>
  26 All GTK+ applications support a number of standard commandline
  27 options. These are removed from <literal>argv</literal> by gtk_init().
  28 Modules may parse and remove further options. The
  29 <link linkend="x11-cmdline">X11</link> and
  30 <link linkend="win32-cmdline">Windows</link> GDK backends parse
  31 some additional commandline options.
  32 </para>
  33
  34 <formalpara>
  35 <title><systemitem>--gtk-module <replaceable>module</replaceable></systemitem></title>
  36
  37 <para>
  38 A list of modules to load in addition to those specified in the
  39 <envar>GTK_MODULES</envar> environment variable and the
  40 <literal>gtk-modules</literal> setting.
  41 </para>
  42 </formalpara>
  43
  44 <formalpara>
  45 <title><systemitem>--g-fatal-warnings</systemitem></title>
  46
  47 <para>
  48 Make GTK+ abort on all warnings. This is useful to stop on the first
  49 warning in a debugger, if your application is printing multiple
  50 warnings.  It's almost always best to start debugging with the first
  51 warning that occurs.
  52 </para>
  53 </formalpara>
  54
  55 <formalpara>
  56 <title><systemitem>--gtk-debug <replaceable>options</replaceable></systemitem></title>
  57
  58 <para>
  59 A list of <link linkend="GTK-Debug-Options">debug options</link>
  60 to turn on in addition to those specified in the <envar>GTK_DEBUG</envar>
  61 environment variable. This option is only available if GTK+ has been
  62 configured with <option>--enable-debug=yes</option>.
  63 </para>
  64 </formalpara>
  65
  66 <formalpara>
  67 <title><systemitem>--gtk-no-debug <replaceable>options</replaceable></systemitem></title>
  68
  69 <para>
  70 A list of <link linkend="GTK-Debug-Options">debug options</link>
  71 to turn off. This option is only available if GTK+ has been configured with
  72 <option>--enable-debug=yes</option>.
  73 </para>
  74 </formalpara>
  75
  76 <para>
  77 The following options are really used by GDK, not by GTK+, but we
  78 list them here for completeness nevertheless.
  79 </para>
  80
  81 <formalpara>
  82 <title><systemitem>--class <replaceable>class</replaceable></systemitem></title>
  83
  84 <para>
  85 Sets the program class; see gdk_set_program_class().
  86 </para>
  87 </formalpara>
  88
  89 <formalpara>
  90 <title><systemitem>--name <replaceable>name</replaceable></systemitem></title>
  91
  92 <para>
  93 Sets the program name.
  94 </para>
  95 </formalpara>
  96
  97 <formalpara>
  98 <title><systemitem>--gdk-debug <replaceable>options</replaceable></systemitem></title>
  99
 100 <para>
 101 A list of <link linkend="GDK-Debug-Options">debug options</link>
 102 to turn on in addition to those specified in the <envar>GDK_DEBUG</envar>
 103 environment variable. This option is only available if GTK+ has been
 104 configured with <option>--enable-debug=yes</option>.
 105 </para>
 106 </formalpara>
 107
 108 <formalpara>
 109 <title><systemitem>--gdk-no-debug <replaceable>options</replaceable></systemitem></title>
 110
 111 <para>
 112 A list of <link linkend="GDK-Debug-Options">debug options</link>
 113 to turn off. This option is only available if GTK+ has been configured with
 114 <option>--enable-debug=yes</option>.
 115 </para>
 116 </formalpara>
 117
 118 </refsect2>
 119
 120 <refsect2>
 121 <title>Environment variables</title>
 122
 123 <para>
 124 GTK+ inspects a number of environment variables in addition to standard
 125 variables like <envar>LANG</envar>, <envar>PATH</envar>, <envar>HOME</envar>
 126 or <envar>DISPLAY</envar>; mostly to determine paths to look for certain
 127 files. The <link linkend="x11-envar">X11</link>,
 128 <link linkend="win32-envar">Windows</link> and
 129 <link linkend="fb-envar">Framebuffer</link> GDK backends use some
 130 additional environment variables.
 131 </para>
 132
 133 <formalpara id="GTK-Debug-Options">
 134   <title><envar>GTK_DEBUG</envar></title>
 135
 136   <para>
 137   If GTK+ has been configured with <option>--enable-debug=yes</option>,
 138   this variable can be set to a list of debug options, which cause GTK+
 139   to print out different types of debugging information.
 140   <variablelist>
 141     <varlistentry>
 142       <term>misc</term>
 143       <listitem><para>Miscellaneous information</para></listitem>
 144     </varlistentry>
 145     <varlistentry>
 146       <term>plugsocket</term>
 147       <listitem><para>Cross-process embedding</para></listitem>
 148     </varlistentry>
 149     <varlistentry>
 150       <term>text</term>
 151       <listitem><para>Text widget internals</para></listitem>
 152     </varlistentry>
 153     <varlistentry>
 154       <term>tree</term>
 155       <listitem><para>Tree widget internals</para></listitem>
 156     </varlistentry>
 157     <varlistentry>
 158       <term>updates</term>
 159       <listitem><para>Visual feedback about window updates</para></listitem>
 160     </varlistentry>
 161     <varlistentry>
 162       <term>keybindings</term>
 163       <listitem><para>Keybindings</para></listitem>
 164     </varlistentry>
 165     <varlistentry>
 166       <term>multihead</term>
 167       <listitem><para>Working on multiple displays</para></listitem>
 168     </varlistentry>
 169     <varlistentry>
 170       <term>modules</term>
 171       <listitem><para>Loading of modules</para></listitem>
 172     </varlistentry>
 173     <varlistentry>
 174       <term>geometry</term>
 175       <listitem><para>Size allocation</para></listitem>
 176     </varlistentry>
 177     <varlistentry>
 178       <term>icontheme</term>
 179       <listitem><para>Icon themes</para></listitem>
 180     </varlistentry>
 181     <varlistentry>
 182       <term>printing</term>
 183       <listitem><para>Printing support</para></listitem>
 184     </varlistentry>
 185     <varlistentry>
 186       <term>builder</term>
 187       <listitem><para>GtkBuilder support</para></listitem>
 188     </varlistentry>
 189
 190   </variablelist>
 191   The special value <literal>all</literal> can be used to turn on all
 192   debug options.
 193   </para>
 194 </formalpara>
 195
 196 <formalpara>
 197   <title><envar>GTK_MODULES</envar></title>
 198
 199   <para>
 200     A list of modules to load. Note that GTK+ also allows to specify modules to load via a commandline option (<option>--gtk-module</option>) and with the <literal>gtk-modules</literal> setting.
 201   </para>
 202 </formalpara>
 203
 204 <formalpara>
 205   <title><envar>GTK_PATH</envar></title>
 206
 207   <para>
 208     Specifies a list of directories to search when GTK+ is looking for
 209     dynamically loaded objects such as the modules specified by
 210     <envar>GTK_MODULES</envar>, theme engines, input method
 211     modules, file system backends and print backends. If the path to
 212     the dynamically loaded object is given as an absolute path name,
 213     then GTK+ loads it directly.
 214     Otherwise, GTK+ goes in turn through the directories in GTK_PATH,
 215     followed by the directory <filename>.gtk-3.0</filename> in the user's
 216     home directory, followed by the system default directory,
 217     which is <filename><replaceable>libdir</replaceable>/gtk-3.0/modules</filename>.
 218     (If <envar>GTK_EXE_PREFIX</envar> is defined, <replaceable>libdir</replaceable> is
 219     <filename>$GTK_EXE_PREFIX/lib</filename>. Otherwise it is the libdir
 220     specified when GTK+ was configured, usually
 221     <filename>/usr/lib</filename>, or
 222     <filename>/usr/local/lib</filename>.)
 223     For each directory in this list, GTK+ actually looks in a
 224     subdirectory
 225     <filename><replaceable>directory</replaceable>/<replaceable>version</replaceable>/<replaceable>host</replaceable>/<replaceable>type</replaceable></filename>
 226     Where <replaceable>version</replaceable> is derived from the
 227     version of GTK+ (use <literal>pkg-config
 228     --variable=gtk_binary_version gtk+-3.0</literal> to determine this from a
 229     script), <replaceable>host</replaceable> is the architecture on
 230     which GTK+ was built. (use <literal>pkg-config
 231     --variable=gtk_host gtk+-3.0</literal> to determine this from a
 232     script), and <replaceable>type</replaceable> is a directory
 233     specific to the type of modules; currently it can be
 234     <literal>modules</literal>, <literal>engines</literal>,
 235     <literal>immodules</literal>, <literal>filesystems</literal> or
 236     <literal>printbackends</literal>, corresponding to the types of
 237     modules mentioned above. Either <replaceable>version</replaceable>,
 238     <replaceable>host</replaceable>, or both may be omitted. GTK+ looks
 239     first in the most specific directory, then in directories with
 240     fewer components.
 241     The components of GTK_PATH are separated by the ':' character on
 242     Linux and Unix, and the ';' character on Windows.
 243   </para>
 244 </formalpara>
 245
 246 <formalpara>
 247   <title><envar>GTK_IM_MODULE</envar></title>
 248
 249   <para>
 250     Specifies an IM module to use in preference to the one determined
 251     from the locale.  If this isn't set and you are running on the system
 252     that enables <literal>XSETTINGS</literal> and has a value in
 253     <literal>Gtk/IMModule</literal>, that will be used for the default
 254     IM module.
 255   </para>
 256 </formalpara>
 257
 258 <formalpara id="im-module-file">
 259   <title><envar>GTK_IM_MODULE_FILE</envar></title>
 260
 261   <para>
 262     Specifies the file listing the IM modules to load. This environment
 263     variable overrides the <literal>im_module_file</literal> specified in
 264     the RC files, which in turn overrides the default value
 265     <filename><replaceable>libdir</replaceable>/gtk-3.0/3.0.0/immodules.cache</filename>
 266     (<replaceable>libdir</replaceable> has the same meaning here as explained for <envar>GTK_PATH</envar>).
 267   </para>
 268 </formalpara>
 269
 270 <formalpara>
 271   <title><envar>GTK2_RC_FILES</envar></title>
 272
 273   <para>
 274     Specifies a list of RC files to parse instead of the default ones;
 275     see <link linkend="gtk-Resource-Files">Resource Files</link>.
 276   </para>
 277 </formalpara>
 278
 279 <formalpara>
 280   <title><envar>GTK_EXE_PREFIX</envar></title>
 281
 282   <para>
 283     If set, GTK+ uses <filename>$GTK_EXE_PREFIX/lib</filename> instead of
 284     the libdir configured when GTK+ was compiled.
 285   </para>
 286 </formalpara>
 287
 288 <formalpara>
 289   <title><envar>GTK_DATA_PREFIX</envar></title>
 290
 291   <para>
 292     If set, makes GTK+ use <filename>$GTK_DATA_PREFIX</filename>
 293     instead of the prefix configured when GTK+ was compiled.
 294   </para>
 295 </formalpara>
 296
 297 <para>
 298 The following environment variables are used by GdkPixbuf, GDK or
 299 Pango, not by GTK+ itself, but we list them here for completeness
 300 nevertheless.
 301 </para>
 302
 303 <formalpara>
 304   <title><envar>GDK_PIXBUF_MODULE_FILE</envar></title>
 305
 306   <para>
 307     Specifies the file listing the GdkPixbuf loader modules to load.
 308     This environment variable overrides the default value
 309     <filename><replaceable>sysconfdir</replaceable>/gtk-3.0/gdk-pixbuf.loaders</filename>
 310     (<replaceable>sysconfdir</replaceable> is the sysconfdir specified when
 311           GTK+ was configured, usually <filename>/usr/local/etc</filename>.)
 312   </para>
 313  </formalpara>
 314
 315 <formalpara id="GDK-Debug-Options">
 316   <title><envar>GDK_DEBUG</envar></title>
 317
 318   <para>
 319   If GTK+ has been configured with <option>--enable-debug=yes</option>,
 320   this variable can be set to a list of debug options, which cause GDK
 321   to print out different types of debugging information.
 322   <variablelist>
 323     <varlistentry>
 324       <term>misc</term>
 325       <listitem><para>Miscellaneous information</para></listitem>
 326     </varlistentry>
 327     <varlistentry>
 328       <term>events</term>
 329       <listitem><para>Show all events received by GDK</para></listitem>
 330     </varlistentry>
 331     <varlistentry>
 332       <term>dnd</term>
 333       <listitem><para>Information about drag-and-drop</para></listitem>
 334     </varlistentry>
 335     <varlistentry>
 336       <term>xim</term>
 337       <listitem><para>Information about XIM support</para></listitem>
 338     </varlistentry>
 339     <varlistentry>
 340       <term>nograbs</term>
 341       <listitem><para>Turn off all pointer and keyboard grabs</para></listitem>
 342     </varlistentry>
 343     <varlistentry>
 344       <term>multihead</term>
 345       <listitem><para>Information related to multiple screens</para></listitem>
 346     </varlistentry>
 347     <varlistentry>
 348       <term>xinerama</term>
 349       <listitem><para>Simulate a multi-monitor setup</para></listitem>
 350     </varlistentry>
 351     <varlistentry>
 352       <term>cursor</term>
 353       <listitem><para>Information about cursor objects (only win32)</para></listitem>
 354     </varlistentry>
 355     <varlistentry>
 356       <term>draw</term>
 357       <listitem><para>Information about drawing operations (only win32)</para></listitem>
 358     </varlistentry>
 359     <varlistentry>
 360       <term>eventloop</term>
 361       <listitem><para>Information about event loop operation (mostly Quartz)</para></listitem>
 362     </varlistentry>
 363
 364   </variablelist>
 365   The special value <literal>all</literal> can be used to turn on all
 366   debug options.
 367   </para>
 368 </formalpara>
 369
 370 <formalpara>
 371   <title><envar>GDK_NATIVE_WINDOWS</envar></title>
 372
 373   <para>
 374     If set, GDK creates all windows as native windows. This can help
 375     applications that make assumptions about 1-1 correspondence between
 376     GDK windows and X11 windows.
 377   </para>
 378 </formalpara>
 379
 380 <formalpara>
 381   <title><envar>XDG_DATA_HOME</envar>, <envar>XDG_DATA_DIRS</envar></title>
 382
 383   <para>
 384     GTK+ uses these environment variables to locate icon themes
 385     and MIME information. For more information, see
 386     <ulink url="http://freedesktop.org/Standards/icon-theme-spec">Icon Theme Specification</ulink>,
 387     the <ulink url="http://freedesktop.org/Standards/shared-mime-info-spec">Shared MIME-info Database</ulink>
 388     and the <ulink url="http://freedesktop.org/Standards/basedir-spec">Base Directory Specification</ulink>.
 389   </para>
 390 </formalpara>
 391
 392 </refsect2>
 393
 394 </refsect1>
 395
 396 </refentry>