]> Pileus Git - ~andy/gtk/blobdiff - docs/reference/gtk/running.sgml
Move documentation to inline comments: GtkToggleButton
[~andy/gtk] / docs / reference / gtk / running.sgml
index 82a3c2070b245bb05b6b188ef644cf3927778731..cdb8fb09459f8187fcba11304ca4cafd077ded3c 100644 (file)
@@ -199,9 +199,13 @@ additional environment variables.
   <para>
     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.
   </para>
+  <warning>
+    Note that this environment variable is read by GTK+ 2.x too,
+    which may not have the same set of modules available for loading.
+  </warning>
 </formalpara>
 
-<formalpara>
+<formalpara id="gtk-path">
   <title><envar>GTK_PATH</envar></title>
 
   <para>
@@ -211,7 +215,7 @@ additional environment variables.
     modules, file system backends and print backends. If the path to
     the dynamically loaded object is given as an absolute path name,
     then GTK+ loads it directly.
-    Otherwise, GTK+ goes in turn through the directories in GTK_PATH,
+    Otherwise, GTK+ goes in turn through the directories in <envar>GTK_PATH</envar>,
     followed by the directory <filename>.gtk-3.0</filename> in the user's
     home directory, followed by the system default directory,
     which is <filename><replaceable>libdir</replaceable>/gtk-3.0/modules</filename>.
@@ -241,6 +245,12 @@ additional environment variables.
     The components of GTK_PATH are separated by the ':' character on
     Linux and Unix, and the ';' character on Windows.
   </para>
+  <warning>
+    Note that this environment variable is read by GTK+ 2.x too, which
+    makes it unsuitable for setting it system-wide (or session-wide),
+    since doing so will cause either GTK+ 2.x applications or GTK+ 3
+    applications to see incompatible modules.
+  </warning>
 </formalpara>
 
 <formalpara>
@@ -248,32 +258,32 @@ additional environment variables.
 
   <para>
     Specifies an IM module to use in preference to the one determined
-    from the locale.  If this isn't set and you are running on the system
+    from the locale. If this isn't set and you are running on the system
     that enables <literal>XSETTINGS</literal> and has a value in
     <literal>Gtk/IMModule</literal>, that will be used for the default
     IM module.
   </para>
 </formalpara>
 
-<formalpara id="im-module-file">
+<formalpara id="gtk-im-module-file">
   <title><envar>GTK_IM_MODULE_FILE</envar></title>
 
   <para>
     Specifies the file listing the IM modules to load. This environment
-    variable overrides the <literal>im_module_file</literal> specified in
-    the RC files, which in turn overrides the default value
+    variable the default value
     <filename><replaceable>libdir</replaceable>/gtk-3.0/3.0.0/immodules.cache</filename>
     (<replaceable>libdir</replaceable> has the same meaning here as explained for <envar>GTK_PATH</envar>).
   </para>
-</formalpara>
-
-<formalpara>
-  <title><envar>GTK2_RC_FILES</envar></title>
-
   <para>
-    Specifies a list of RC files to parse instead of the default ones;
-    see <link linkend="gtk-Resource-Files">Resource Files</link>.
+    The <filename>immodules.cache</filename> file is generated by the
+    <command>gtk-query-immodules-3.0</command> utility.
   </para>
+  <warning>
+    Note that this environment variable is read by GTK+ 2.x too, which
+    makes it unsuitable for setting it system-wide (or session-wide),
+    since doing so will cause either GTK+ 2.x applications or GTK+ 3
+    applications to see the wrong list of IM modules.
+  </warning>
 </formalpara>
 
 <formalpara>
@@ -306,9 +316,13 @@ nevertheless.
   <para>
     Specifies the file listing the GdkPixbuf loader modules to load.
     This environment variable overrides the default value
-       <filename><replaceable>libdir</replaceable>/gtk-3.0/3.0.0/loaders.cache</filename>
+    <filename><replaceable>libdir</replaceable>/gtk-3.0/3.0.0/loaders.cache</filename>
     (<replaceable>libdir</replaceable> is the sysconfdir specified when
-       GTK+ was configured, usually <filename>/usr/local/lib</filename>.)
+    GTK+ was configured, usually <filename>/usr/local/lib</filename>.)
+  </para>
+  <para>
+    The <filename>loaders.cache</filename> file is generated by the
+    <command>gdk-pixbuf-query-loaders</command> utility.
   </para>
  </formalpara>
 
@@ -368,12 +382,74 @@ nevertheless.
 </formalpara>
 
 <formalpara>
-  <title><envar>GDK_NATIVE_WINDOWS</envar></title>
+  <title><envar>GDK_RENDERING</envar></title>
+
+  <para>
+    If set, selects the way how GDK creates similar surfaces. This affects both the
+    functionality of the function gdk_window_create_similar_surface() as well as the
+    way GDK creates backing surfaces for double buffering. The following values can
+    be used:
+    <variablelist>
+
+      <varlistentry>
+        <term>similar</term>
+        <listitem><para>Create similar surfaces to the window in use. This is the
+          default behavior when the variable is not set.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>image</term>
+        <listitem><para>Always create image surfaces. This essentially turns off
+          all hardware acceleration inside GTK.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>recording</term>
+        <listitem><para>Always create recording surfaces. This causes bare rendering
+          to the backend without the creation of intermediate surfaces (Pixmaps in X)
+          and will likely cause flicker.</para></listitem>
+      </varlistentry>
+
+    </variablelist>
+    All other values will be ignored and fall back to the default behavior. More
+    values might be added in the future. 
+  </para>
+</formalpara>
+
+<formalpara>
+  <title><envar>GDK_BACKEND</envar></title>
 
   <para>
-    If set, GDK creates all windows as native windows. This can help
-    applications that make assumptions about 1-1 correspondence between
-    GDK windows and X11 windows.
+    If set, selects the GDK backend to use. Selecting a backend requires that GTK is compiled
+    with support for that backend. The following backends can be selected:
+    <variablelist>
+
+      <varlistentry>
+        <term>quartz</term>
+        <listitem><para>Selects the native Quartz backend</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>win32</term>
+        <listitem><para>Selects the native backend for Microsoft Windows</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>x11</term>
+        <listitem><para>Selects the native backend for connecting to X11 servers.</para></listitem>
+      </varlistentry>
+
+    </variablelist>
+    For more information about selecting backends, see the gdk_display_manager_get() function.
+  </para>
+</formalpara>
+
+<formalpara>
+  <title><envar>GDK_SYNCHRONIZE</envar></title>
+
+  <para>
+    If set, GDK makes all X requests synchronously. This is a useful
+    option for debugging, but it will slow down the performance considerably.
   </para>
 </formalpara>
 
@@ -389,6 +465,19 @@ nevertheless.
   </para>
 </formalpara>
 
+<formalpara>
+  <title><envar>DESKTOP_STARTUP_ID</envar></title>
+
+  <para>
+    GTK+ uses this environment variable to provide startup notification
+    according to the <ulink url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">Startup Notification Spec</ulink>.
+    Following the specification, GTK+ unsets this variable after reading
+    it (to keep it from leaking to child processes). So, if you need its
+    value for your own purposes, you have to read it before calling
+    gtk_init().
+  </para>
+</formalpara>
+
 </refsect2>
 
 </refsect1>