Add overview and running sections to API docs

https://bugzilla.gnome.org/show_bug.cgi?id=695641

4 files changed, 126 insertions, 2 deletions

diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 7e7199660..36e97a17b 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -119,12 +119,18 @@ HTML_IMAGES=
 
 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=
+content_files= \
+	mutter-overview.xml \
+	running-mutter.xml \
+	$(NULL)
 
 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
 # These files must be listed here *and* in content_files
 # e.g. expand_content_files=running.sgml
-expand_content_files=
+expand_content_files= \
+	mutter-overview.xml \
+	running-mutter.xml \
+	$(NULL)
 
 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
diff --git a/doc/reference/meta-docs.sgml.in b/doc/reference/meta-docs.sgml.in
index e082fa0f6..fe6f90405 100644
--- a/doc/reference/meta-docs.sgml.in
+++ b/doc/reference/meta-docs.sgml.in
@@ -15,6 +15,9 @@
     </releaseinfo>
   </bookinfo>
 
+  <xi:include href="xml/mutter-overview.xml"/>
+  <xi:include href="xml/running-mutter.xml"/>
+
   <part id="core-reference">
     <title>Mutter Core Reference</title>
     <xi:include href="xml/main.xml"/>
diff --git a/doc/reference/mutter-overview.xml b/doc/reference/mutter-overview.xml
new file mode 100644
index 000000000..f17a228a2
--- /dev/null
+++ b/doc/reference/mutter-overview.xml
@@ -0,0 +1,15 @@
+<part id="mutter-overview">
+
+  <title>Overview</title>
+
+  <partintro>
+
+    <para>Mutter is a GObject-based library for creating compositing window managers.</para>
+
+    <para>Compositors that wish to use Mutter must implement a subclass of #MetaPlugin and register it with meta_plugin_manager_set_plugin_type() before calling meta_init() but after g_type_init().</para>
+
+    <para>#MetaPlugin provides virtual functions that allow to override default behavior in the window management code, such as the effect to perform when a window is created or when switching workspaces.</para>
+
+  </partintro>
+
+</part>
diff --git a/doc/reference/running-mutter.xml b/doc/reference/running-mutter.xml
new file mode 100644
index 000000000..570e96dab
--- /dev/null
+++ b/doc/reference/running-mutter.xml
@@ -0,0 +1,100 @@
+<part id="running-mutter">
+
+  <title>Running Mutter</title>
+
+  <partintro>
+
+    <section id="environment-variables">
+      <title>Environment Variables</title>
+
+      <para>
+        Mutter automatically checks environment variables during
+        its initialization. These environment variables are meant
+        as debug tools or overrides for default behaviours:
+      </para>
+
+      <variablelist>
+        <varlistentry>
+          <term>MUTTER_VERBOSE</term>
+          <listitem>
+            <para>Enable verbose mode, in which more information is printed to the console. Mutter needs to be built with the --enable-verbose-mode option (enabled by default). For more fine-grained control of the output, see meta_add_verbose_topic().</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>MUTTER_DEBUG</term>
+          <listitem>
+            <para>Traps and prints X errors to the console.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>MUTTER_G_FATAL_WARNINGS</term>
+          <listitem>
+            <para>Causes any logging from the domains Mutter, Gtk, Gdk, Pango or GLib to terminate the process (only when using the log functions in GLib).</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>MUTTER_USE_LOGFILE</term>
+          <listitem>
+            <para>Log all messages to a temporary file.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>MUTTER_DEBUG_XINERAMA</term>
+          <listitem>
+            <para>Log extra information about support of the XINERAMA extension.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>MUTTER_DEBUG_SM</term>
+          <listitem>
+            <para>Log extra information about session management.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>MUTTER_DEBUG_BUTTON_GRABS</term>
+          <listitem>
+            <para>Log extra information about button grabs.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>MUTTER_SYNC</term>
+          <listitem>
+            <para>Call XSync after each X call.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>MUTTER_DISPLAY</term>
+          <listitem>
+            <para>Name of the X11 display to use.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>META_DISABLE_MIPMAPS</term>
+          <listitem>
+            <para>Disable use of mipmaps for the textures that back window pixmaps.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>MUTTER_USE_STATIC_GRAVITY</term>
+          <listitem>
+            <para>Enable support for clients with static bit-gravity.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>MUTTER_WM_CLASS_FILTER</term>
+          <listitem>
+            <para>Comma-separated list of WM_CLASS names to which to restrict Mutter to.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>MUTTER_DISABLE_FALLBACK_COLOR</term>
+          <listitem>
+            <para>Disable fallback for themed colors, for easier detection of typographical errors.</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+
+    </section>
+
+  </partintro>
+</part>