[gdm: 52/70] Documentation improvements. Fixes bugs #569893 and #571250.
- From: Ray Strode <halfline src gnome org>
- To: svn-commits-list gnome org
- Subject: [gdm: 52/70] Documentation improvements. Fixes bugs #569893 and #571250.
- Date: Tue, 31 Mar 2009 14:55:08 -0400 (EDT)
commit 6e165eeb966fa6cd9cbc1e85079893755bdf66f3
Author: Brian Cameron <brian cameron sun com>
Date: Tue Feb 17 18:45:39 2009 +0000
Documentation improvements. Fixes bugs #569893 and #571250.
2009-02-17 Brian Cameron <brian cameron sun com>
* docs/C/gdm.xml: Documentation improvements. Fixes bugs #569893 and
#571250.
svn path=/trunk/; revision=6712
---
ChangeLog | 5 +
docs/C/gdm.xml | 222 ++++++++++++++++++++++++++++++++++++++++++++++++--------
2 files changed, 196 insertions(+), 31 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 3ce30c7..16b4e64 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
2009-02-17 Brian Cameron <brian cameron sun com>
+ * docs/C/gdm.xml: Documentation improvements. Fixes bugs #569893 and
+ #571250.
+
+2009-02-17 Brian Cameron <brian cameron sun com>
+
* configure.ac, acconfig.h, daemon/Makefile.am: Add --with-default-path
to configure so distros can configure the default PATH to use in the
user's session. Cleanup some unused cruft from configure.ac,
diff --git a/docs/C/gdm.xml b/docs/C/gdm.xml
index b10868f..8f160ee 100644
--- a/docs/C/gdm.xml
+++ b/docs/C/gdm.xml
@@ -2,8 +2,8 @@
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
<!ENTITY legal SYSTEM "legal.xml">
- <!ENTITY version "2.24.0">
- <!ENTITY date "08/27/2008">
+ <!ENTITY version "2.26.0">
+ <!ENTITY date "02/10/2009">
<!ENTITY mdash "—">
<!ENTITY percnt "%">
]>
@@ -317,19 +317,25 @@
<sect2 id="greeterpanel">
<title>Greeter Panel</title>
<para>
- The GDM greeter program displays a panel docked at the bottom of the screen
- which provides additional functionality. When a user is selected, the
- panel allows the user to select which session, language, and keyboard layout
- to use after logging in. The keyboard layout selector also changes the keyboard
- layout used when typing your password. The panel also contains an area
- for login services to leave status icons. Some example status icons
- include a battery icon for current battery usage, and an icon for
- enabling accessibility features. The greeter program also provides
- buttons which allow the user to shutdown or restart the system. It is
- possible to configure GDM to not provide the shutdown and restart
- buttons, if desired. GDM can also be configured via PolicyKit (or via
- RBAC on Solaris) to require the user have appropriate authorization
- before accepting the shutdown or restart request.
+ The GDM greeter program displays a panel docked at the bottom of the
+ screen which provides additional functionality. When a user is
+ selected, the panel allows the user to select which session, language,
+ and keyboard layout to use after logging in. The keyboard layout
+ selector also changes the keyboard layout used when typing your
+ password. The panel also contains an area for login services to leave
+ status icons. Some example status icons include a battery icon for
+ current battery usage, and an icon for enabling accessibility features.
+ The greeter program also provides buttons which allow the user to
+ shutdown or restart the system. It is possible to configure GDM to not
+ provide the shutdown and restart buttons, if desired. GDM can also be
+ configured via PolicyKit (or via RBAC on Solaris) to require the user
+ have appropriate authorization before accepting the shutdown or restart
+ request.
+ </para>
+
+ <para>
+ Note that keyboard layout features are only available on systems that
+ support libxklavier.
</para>
</sect2>
@@ -343,7 +349,9 @@
features such as an on-screen keyboard, screen reader, screen
magnifier, and Xserver AccessX keyboard accessibility are available.
It is also possible to enable large text or high contrast icons and
- controls, if needed.
+ controls, if needed. Refer to the "Accessibility
+ Configuration" section of the document for more information
+ how various accessibility features can be configured.
</para>
<para>
@@ -529,6 +537,11 @@
to the default panel configuration. It can be added using the panel context
menu.
</para>
+ <para>
+ Note this feature is available on systems that support Virtual
+ Terminals. This feature will not function if Virtual Terminals is not
+ available.
+ </para>
</sect2>
</sect1>
@@ -920,10 +933,10 @@ gdm: .your.domain
<sect2 id="scripting">
<title>Scripting Integration Points</title>
- <para>
- The GDM script integration points can be found in the
- <filename><etc>/gdm/</filename> directory:
- </para>
+ <para>
+ The GDM script integration points can be found in the
+ <filename><etc>/gdm/</filename> directory:
+ </para>
<screen>
Xsession
@@ -960,7 +973,8 @@ PostSession/
</para>
<para>
- When the Xserver has been successfully started, GDM will run the
+ When the Xserver for the login GUI has been successfully started, but
+ before the login GUI is actually displayed, GDM will run the
<filename>Init</filename> script. This script is useful for starting
programs that should be run while the login screen is showing, or for
doing any special initialization required.
@@ -976,13 +990,6 @@ PostSession/
</para>
<para>
- Note that the <filename>PostSession</filename> script will be run
- even when the display fails to respond due to an I/O error or
- similar. Thus, there is no guarantee that X applications will work
- during script execution.
- </para>
-
- <para>
After the user session has been initialized, GDM will run the
<filename>PreSession</filename> script. This script is useful for
doing any session initialization that needs to happen after the
@@ -998,6 +1005,13 @@ PostSession/
</para>
<para>
+ Note that the <filename>PostSession</filename> script will be run
+ even when the display fails to respond due to an I/O error or
+ similar. Thus, there is no guarantee that X applications will work
+ during script execution.
+ </para>
+
+ <para>
All of the above scripts will set the
<filename>$RUNNING_UNDER_GDM</filename> environment variable to
<filename>yes</filename>. If the scripts are also shared with other
@@ -1006,6 +1020,31 @@ PostSession/
</para>
</sect2>
+ <sect2 id="autostart">
+ <title>Autostart Configuration</title>
+
+ <para>
+ The <filename><share>/gdm/autostart/LoginWindow</filename>
+ directory contains files in the format specified by the
+ "FreeDesktop.org Desktop Application Autostart
+ Specification". Standard features in the specification may be
+ used to specify programs should auto-restart or only be launched if a
+ GConf configuration value is set, etc.
+ </para>
+
+ <para>
+ Any <filename>.desktop</filename> files in this directory will cause
+ the associated program to automatically start with the login GUI
+ greeter. By default, GDM is shipped with files which will autostart
+ the gdm-simple-greeter login GUI greeter itself, the
+ gnome-power-manager application, the gnome-settings-daemon, and the
+ metacity window manager. These programs are needed for the greeter
+ program to work. In addition, desktop files are provided for starting
+ various AT programs if the configuration values specified in the
+ Accessibility Configuration section below are set.
+ </para>
+ </sect2>
+
<sect2 id="xsessionscript">
<title>Xsession Script</title>
@@ -1507,11 +1546,11 @@ gdm:.my.domain
</varlistentry>
<varlistentry>
- <term>/apps/gdm/simple-greeter/logo_icon_name</term>
+ <term>/apps/gdm/simple-greeter/debug</term>
<listitem>
- <synopsis>computer (string)</synopsis>
+ <synopsis>false (boolean)</synopsis>
<para>
- Set to the themed icon name to use for the greeter logo.
+ If true, then debugging mode is enabled for the greeter.
</para>
</listitem>
</varlistentry>
@@ -1528,6 +1567,71 @@ gdm:.my.domain
</varlistentry>
<varlistentry>
+ <term>/apps/gdm/simple-greeter/disable_user_list</term>
+ <listitem>
+ <synopsis>false (boolean)</synopsis>
+ <para>
+ If true, then the face browser with known users is not shown
+ in the login window.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>/apps/gdm/simple-greeter/logo_icon_name</term>
+ <listitem>
+ <synopsis>computer (string)</synopsis>
+ <para>
+ Set to the themed icon name to use for the greeter logo.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>/apps/gdm/simple-greeter/recent-languages</term>
+ <listitem>
+ <synopsis>[] (string list)</synopsis>
+ <para>
+ Set to a list of languages to be shown by default in the login
+ window. Default value is "[]". With the default setting only
+ the system default language is shown and the option "Other..."
+ which pops-up a dialog box showing a full list of available
+ languages which the user can select.
+ </para>
+
+ <para>
+ Users are not intended to change this setting by hand. Instead
+ GDM keeps track of any languages selected in this configuration
+ key, and will show them in the language combo box along with
+ the "Other..." choice. This way, commonly selected languages
+ are easier to select.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>/apps/gdm/simple-greeter/recent-layouts</term>
+ <listitem>
+ <synopsis>[] (string list)</synopsis>
+ <para>
+ Set to a list of keyboard layouts to be shown by default in the
+ login panel. Default value is "[]". With the default setting
+ only the system default keyboard layout is shown and the option
+ "Other..." which pops-up a dialog box showing a full list of
+ available keyboard layouts which the user can select.
+ </para>
+
+ <para>
+ Users are not intended to change this setting by hand. Instead
+ GDM keeps track of any keyboard layouts selected in this
+ configuration key, and will show them in the keyboard layout
+ combo box along with the "Other..." choice. This way, commonly
+ selected keyboard layouts are easier to select.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>/apps/gdm/simple-greeter/wm_use_compiz</term>
<listitem>
<synopsis>false (boolean)</synopsis>
@@ -1540,6 +1644,62 @@ gdm:.my.domain
</variablelist>
</sect2>
+ <sect2 id="accessibilityconfiguration">
+ <title>Accessibility Configuration</title>
+
+ <para>
+ If the user associated with running the GDM GUI programs has
+ accessibility features enabled via GConf configuration, then the
+ GDM GUI programs will recognize these.
+ </para>
+
+ <variablelist>
+ <title>Greeter Configuration Keys</title>
+
+ <varlistentry>
+ <term>/desktop/gnome/interface/accessibility</term>
+ <listitem>
+ <synopsis>false (boolean)</synopsis>
+ <para>
+ Controls whether the Accessibility infrastructure will be
+ started with the GDM GUI. This is needed for any accessibility
+ technology programs to work.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>/desktop/gnome/applications/at/screen_magnifier_enabled</term>
+ <listitem>
+ <synopsis>false (boolean)</synopsis>
+ <para>
+ If set, then the GNOME magnifier will be started with the GDM
+ GUI programs.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>/desktop/gnome/applications/at/screen_keyboard_enabled</term>
+ <listitem>
+ <synopsis>false (boolean)</synopsis>
+ <para>
+ If set, then the GNOME on-screen keyboard will be started with
+ the GDM GUI programs.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>/desktop/gnome/applications/at/screen_reader_enabled</term>
+ <listitem>
+ <synopsis>false (boolean)</synopsis>
+ <para>
+ If set, then the GNOME screen reader will be started with
+ the GDM GUI programs.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
<sect2 id="generalsessionconfig">
<title>General Session Settings</title>
<!--
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
