From 00a842f41bbc90692c189512482bc8568ac607d7 Mon Sep 17 00:00:00 2001 From: Tomeu Vizoso Date: Mon, 11 Mar 2013 16:51:24 +0100 Subject: [PATCH] Add overview and running sections to API docs https://bugzilla.gnome.org/show_bug.cgi?id=695641 --- doc/reference/Makefile.am | 10 ++- doc/reference/meta-docs.sgml.in | 3 + doc/reference/mutter-overview.xml | 15 +++++ doc/reference/running-mutter.xml | 100 ++++++++++++++++++++++++++++++ 4 files changed, 126 insertions(+), 2 deletions(-) create mode 100644 doc/reference/mutter-overview.xml create mode 100644 doc/reference/running-mutter.xml 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 @@ + + + Mutter Core Reference 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 @@ + + + Overview + + + + Mutter is a GObject-based library for creating compositing window managers. + + 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(). + + #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. + + + + 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 @@ + + + Running Mutter + + + +
+ Environment Variables + + + Mutter automatically checks environment variables during + its initialization. These environment variables are meant + as debug tools or overrides for default behaviours: + + + + + MUTTER_VERBOSE + + 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(). + + + + MUTTER_DEBUG + + Traps and prints X errors to the console. + + + + MUTTER_G_FATAL_WARNINGS + + Causes any logging from the domains Mutter, Gtk, Gdk, Pango or GLib to terminate the process (only when using the log functions in GLib). + + + + MUTTER_USE_LOGFILE + + Log all messages to a temporary file. + + + + MUTTER_DEBUG_XINERAMA + + Log extra information about support of the XINERAMA extension. + + + + MUTTER_DEBUG_SM + + Log extra information about session management. + + + + MUTTER_DEBUG_BUTTON_GRABS + + Log extra information about button grabs. + + + + MUTTER_SYNC + + Call XSync after each X call. + + + + MUTTER_DISPLAY + + Name of the X11 display to use. + + + + META_DISABLE_MIPMAPS + + Disable use of mipmaps for the textures that back window pixmaps. + + + + MUTTER_USE_STATIC_GRAVITY + + Enable support for clients with static bit-gravity. + + + + MUTTER_WM_CLASS_FILTER + + Comma-separated list of WM_CLASS names to which to restrict Mutter to. + + + + MUTTER_DISABLE_FALLBACK_COLOR + + Disable fallback for themed colors, for easier detection of typographical errors. + + + + +
+ + +