Improve docs for new "background" feature.

2007-05-01  Brian Cameron  <brian.cameron@sun.com>

        * docs/C/gdm.xml: Improve docs for new "background" feature.

svn path=/trunk/; revision=4881

2 files changed, 80 insertions, 62 deletions

diff --git a/ChangeLog b/ChangeLog
index fdb35d36..4da3d844 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,7 +1,11 @@
+2007-05-01  Brian Cameron  <brian.cameron@sun.com>
+
+        * docs/C/gdm.xml: Improve docs for new "background" feature.
+
 2007-05-01  Changwoo Ryu  <cwryu@debian.org>
 
 	* configure.ac: Remove docs/ko/Makefile output for gnome-doc-utils
-	migration.
+	  migration.
 
 2007-04-30  Frederic Crozat  <fcrozat@mandriva.com>
 
@@ -36,9 +40,9 @@
 2007-04-24  William Jon McCann  <mccann@jhu.edu>
 
 	* common/test-config.c: (load_servers_group):
-	Cast gsize to int for printf.
-	Patch by Saleem Abdulrasool  <compnerd@gentoo.org>.
-	Fixes bug #432830.
+	  Cast gsize to int for printf.
+	  Patch by Saleem Abdulrasool  <compnerd@gentoo.org>.
+	  Fixes bug #432830.
 
 2007-04-24  Brian Cameron  <brian.cameron@sun.com>
 
@@ -77,20 +81,20 @@
 2007-04-20  William Jon McCann  <mccann@jhu.edu>
 
 	* daemon/gdm.c: (handle_flexi_server), (handle_dynamic_server),
-	(sup_handle_flexi_xserver), (sup_handle_flexi_xnest),
-	(sup_handle_set_logout_action),
-	(sup_handle_set_safe_logout_action), (sup_handle_query_vt),
-	(sup_handle_set_vt):
-	Fix detection of user specified in flexi command.
+	  (sup_handle_flexi_xserver), (sup_handle_flexi_xnest),
+	  (sup_handle_set_logout_action),
+	  (sup_handle_set_safe_logout_action), (sup_handle_query_vt),
+	  (sup_handle_set_vt):
+	  Fix detection of user specified in flexi command.
 
 	* gui/gdmflexiserver.c: (get_cur_vt), (change_vt),
-	(maybe_lock_screen):
-	Fix a double free.
+	  (maybe_lock_screen):
+	  Fix a double free.
 
 2007-04-20  William Jon McCann  <mccann@jhu.edu>
 
 	* gui/gdmflexiserver.c: (maybe_lock_screen), (main):
-	Properly initialize gtk.  Fixes #431044
+	  Properly initialize gtk.  Fixes #431044
 
 2007-04-20  William Jon McCann  <mccann@jhu.edu>
 
@@ -106,10 +110,10 @@
 	* utils/gdm-restart.in:
 	* utils/gdm-safe-restart.in:
 	* utils/gdm-stop.in:
-	Fixes the pid file handling in the gdm-restart/stop/safe-restart
-	scripts. Moves the scripts to the utils subdir.  Moves the
-	gdmsetup stuff from toplevel to utils subdir.  Removes gdm.spec.
-	Fixes #431462
+	  Fixes the pid file handling in the gdm-restart/stop/safe-restart
+	  scripts. Moves the scripts to the utils subdir.  Moves the
+	  gdmsetup stuff from toplevel to utils subdir.  Removes gdm.spec.
+	  Fixes #431462
 
 2007-04-19  Brian Cameron  <brian.cameron@sun.com>
 
@@ -139,63 +143,63 @@
 
 	* daemon/gdm-xdmcp-manager.c:
 	* daemon/gdm-xdmcp-manager.h:
-	Fix some includes issues from bug #376010.
+	  Fix some includes issues from bug #376010.
 
 2007-04-17  William Jon McCann  <mccann@jhu.edu>
 
 	* daemon/verify-crypt.c: (gdm_verify_user),
-	(gdm_verify_setup_user), (gdm_verify_setup_env):
+	  (gdm_verify_setup_user), (gdm_verify_setup_env):
 	* daemon/verify-pam.c: (audit_fail_login), (gdm_verify_user),
-	(gdm_verify_setup_user), (gdm_verify_setup_env):
+	  (gdm_verify_setup_user), (gdm_verify_setup_env):
 	* daemon/verify-shadow.c: (gdm_verify_user),
-	(gdm_verify_setup_user):
-	Fix verify backends for VE patch from bug #355425.
+	  (gdm_verify_setup_user):
+	  Fix verify backends for VE patch from bug #355425.
 
 2007-04-16  William Jon McCann  <mccann@jhu.edu>
 
 	* common/gdm-common-config.c: (gdm_common_config_parse_key_string),
-	(gdm_common_config_get_int),
-	(gdm_common_config_get_translated_string),
-	(gdm_common_config_get_string), (gdm_common_config_get_boolean):
+	  (gdm_common_config_get_int),
+	  (gdm_common_config_get_translated_string),
+	  (gdm_common_config_get_string), (gdm_common_config_get_boolean):
 	* common/gdm-common-config.h:
-	Return FALSE if no default is given in the key and key doesn't
-	exist in the file.
+	  Return FALSE if no default is given in the key and key doesn't
+	  exist in the file.
 
 	* daemon/gdm-daemon-config.c:
-	(gdm_daemon_config_get_value_int_per_display),
-	(gdm_daemon_config_get_value_bool_per_display),
-	(gdm_daemon_config_get_value_string_per_display),
-	(gdm_daemon_config_key_to_string_per_display),
-	(gdm_daemon_config_key_to_string), (gdm_daemon_config_to_string):
+	  (gdm_daemon_config_get_value_int_per_display),
+	  (gdm_daemon_config_get_value_bool_per_display),
+	  (gdm_daemon_config_get_value_string_per_display),
+	  (gdm_daemon_config_key_to_string_per_display),
+	  (gdm_daemon_config_key_to_string), (gdm_daemon_config_to_string):
 	* daemon/gdm-daemon-config.h:
-	Fix handling of per display keys.
+	  Fix handling of per display keys.
 
 	* daemon/gdm-xdmcp-manager.c:
-	(gdm_xdmcp_manager_set_willing_script),
-	(gdm_xdmcp_manager_set_property), (gdm_xdmcp_manager_get_property):
-	Fix missing property.
+	  (gdm_xdmcp_manager_set_willing_script),
+	  (gdm_xdmcp_manager_set_property), (gdm_xdmcp_manager_get_property):
+	  Fix missing property.
 
 	* daemon/gdm.c: (gdm_start_first_unborn_local),
-	(gdm_final_cleanup), (custom_cmd_no_restart),
-	(gdm_cleanup_children), (mainloop_sig_callback), (main),
-	(gdm_handle_message), (handle_flexi_server),
-	(sup_handle_auth_local), (sup_handle_attached_servers),
-	(sup_handle_get_server_details), (sup_handle_flexi_xserver),
-	(sup_handle_flexi_xnest), (sup_handle_get_config),
-	(sup_handle_query_logout_action),
-	(sup_handle_query_custom_cmd_labels), (sup_handle_all_servers),
-	(sup_handle_get_server_list), (sup_handle_get_custom_config_file),
-	(sup_handle_greeterpids),
-	(sup_handle_query_custom_cmd_no_restart_status),
-	(sup_handle_set_logout_action),
-	(sup_handle_set_safe_logout_action), (sup_handle_query_vt),
-	(sup_handle_set_vt), (gdm_handle_user_message):
-	Break up the monolithic gdm_handle_user_message function so it
-	can be read more easily.
+	  (gdm_final_cleanup), (custom_cmd_no_restart),
+	  (gdm_cleanup_children), (mainloop_sig_callback), (main),
+	  (gdm_handle_message), (handle_flexi_server),
+	  (sup_handle_auth_local), (sup_handle_attached_servers),
+	  (sup_handle_get_server_details), (sup_handle_flexi_xserver),
+	  (sup_handle_flexi_xnest), (sup_handle_get_config),
+	  (sup_handle_query_logout_action),
+	  (sup_handle_query_custom_cmd_labels), (sup_handle_all_servers),
+	  (sup_handle_get_server_list), (sup_handle_get_custom_config_file),
+	  (sup_handle_greeterpids),
+	  (sup_handle_query_custom_cmd_no_restart_status),
+	  (sup_handle_set_logout_action),
+	  (sup_handle_set_safe_logout_action), (sup_handle_query_vt),
+	  (sup_handle_set_vt), (gdm_handle_user_message):
+	  Break up the monolithic gdm_handle_user_message function so it
+	  can be read more easily.
 
 	* daemon/slave.c: (check_for_interruption):
 	* daemon/verify-pam.c: (gdm_verify_user), (gdm_verify_setup_user):
-	Update for changed daemon_config arguments.
+	  Update for changed daemon_config arguments.
 
 2007-04-16  William Jon McCann  <mccann@jhu.edu>
 
@@ -213,9 +217,9 @@
 	* daemon/server.c:
 	* daemon/slave.c:
 	* daemon/xdmcp.c: (gdm_xdmcp_init), (gdm_xdmcp_run),
-	(gdm_xdmcp_close), (gdm_xdmcp_migrate):
+	  (gdm_xdmcp_close), (gdm_xdmcp_migrate):
 	* daemon/xdmcp.h:
-	Turn XDMCP handling into an object.  From bug #376010.
+	  Turn XDMCP handling into an object.  From bug #376010.
 
 2007-04-13  Brian Cameron  <brian.cameron@sun.com>
 
@@ -5173,8 +5177,8 @@
 
 	* daemon/slave.c: Display an error dialog if the user's $HOME/.dmrc
 	  can't be accessed for permissions reasons.  Fixes bug 141126.
-	* gui/gdmlogin.c, gui/greeter/greeter_item_pam.c: Now tab acts like
-	  enter.  Fixes bug #127339.  * gui/gdmsetup.c: Fixed theme installer
+	* gui/gdmlogin.c, gui/greeter/greeter_item_pam.c: Now Tab acts like
+	  Enter.  Fixes bug #127339.  * gui/gdmsetup.c: Fixed theme installer
 	  so it remembers where the last theme was installed from and opens the
 	  file browser in that location.  Fixes bug #164785.  Also fixed a
 	  bug which was causing only *tar.gz files to be installable.  Now it
diff --git a/docs/C/gdm.xml b/docs/C/gdm.xml
index 2d67f592..f7d94d8b 100644
--- a/docs/C/gdm.xml
+++ b/docs/C/gdm.xml
@@ -6518,8 +6518,23 @@ homogeneous=&quot;bool&quot;&gt;
         </variablelist>
 
         <para>
-		Item nodes can have a &quot;background&quot; property, set to &quot;true&quot;
-		or &quot;false&quot; (not setting this property is equivalent to &quot;false&quot;), as follow :
+          By default, the GDM login screen will disappear after authentication.
+          This can result in flicker between the login screen and the session.
+          The &quot;background&quot; property allows users to specify what 
+          elements of the theme are the background image.  When used, this
+          will cause GDM to remove all non-background items from the display
+          and render the remaining &quot;background&quot; items to the root
+          window.  This can be used to create a smooth transition between the
+          login screen and the session.  For example, if the GDM theme and the
+          session use the same background, then this will make the background
+          apear seamless.
+        </para>
+          
+        <para>
+          Item nodes may specify a &quot;background&quot; property which can be
+          set to &quot;true&quot; or &quot;false&quot; (not setting this
+          property is equivalent to &quot;false&quot;), as follows:
+        </para>
 
 <screen>
 &lt;item type=&quot;rect&quot; background=&quot;true&quot;&gt;
@@ -6528,11 +6543,10 @@ homogeneous=&quot;bool&quot;&gt;
 &lt;/item&gt;
 </screen>
 
-		When this property is set on item nodes, background is applied to root window when greeter
-		exits after login, reducing screen flickering during login process. If no item node have &quot;background&quot;
-		property set, background is not modified when greeter exits.
+	<para>
+          If no item node has &quot;background&quot; property set, then the
+          background is not modified when greeter exits.
 	</para>
-
       </sect3>
 
       <sect3 id="positionnodes">