[gnome-session] [doc] Update man pages

[Vincent Untz <vuntz src gnome org>]

commit 86899d53b41f883f2a72d4070a46337dbe6d7d0a
Author: Vincent Untz <vuntz gnome org>
Date:   Fri Sep 10 02:11:28 2010 +0200

    [doc] Update man pages

 doc/man/gnome-session-properties.1 |   20 +++++++-----
 doc/man/gnome-session-save.1       |   34 ++++++++++----------
 doc/man/gnome-session.1            |   47 +++++++++++++++++-----------
 doc/man/gnome-wm.1                 |   59 ++++++++++++++++++++++--------------
 4 files changed, 92 insertions(+), 68 deletions(-)
---
diff --git a/doc/man/gnome-session-properties.1 b/doc/man/gnome-session-properties.1
index e998332..97fa344 100644
--- a/doc/man/gnome-session-properties.1
+++ b/doc/man/gnome-session-properties.1
@@ -1,22 +1,24 @@
+.\"
+.\" gnome-session-properties manual page.
+.\" (C) 2009-2010 Vincent Untz (vuntz gnome org)
+.\"
 .TH GNOME-SESSION-PROPERTIES 1 "GNOME"
 .SH NAME
-gnome-session-properties \- Configure what applications to start on login
+gnome-session-properties \- Configure applications to start on login
 .SH SYNOPSIS
-
 .B gnome-session-properties
-
 .SH DESCRIPTION
 .PP
-\fIgnome-session-properties\fP enables the users to configure what
-applications should be started on login, in addition to the default
-startup applications configured on the system.
+The \fIgnome-session-properties\fP program enables the users to
+configure what applications should be started on login, in addition to
+the default startup applications configured on the system.
 .PP
 It also proposes an interface to save a snapshot of the currently
 running applications so that they can automatically be restored to
 their current state on your next GNOME session.
+.SH BUGS
+If you find bugs in the \fIgnome-session-properties\fP program, please report
+these on https://bugzilla.gnome.org.
 .SH SEE ALSO
 .BR gnome-session(1)
 .BR gnome-session-save(1)
-.SH BUGS
-If you find bugs in the \fIgnome-session-properties\fP program, please report
-these on http://bugzilla.gnome.org.
diff --git a/doc/man/gnome-session-save.1 b/doc/man/gnome-session-save.1
index e55d6fa..bdea8f9 100644
--- a/doc/man/gnome-session-save.1
+++ b/doc/man/gnome-session-save.1
@@ -1,40 +1,40 @@
-.\" 
+.\"
 .\" gnome-session-save manual page.
 .\" (C) 2000 Miguel de Icaza (miguel helixcode com)
+.\" (C) 2009-2010 Vincent Untz (vuntz gnome org)
 .\"
 .TH GNOME-SESSION-SAVE 1 "GNOME"
 .SH NAME
-gnome-session-save \- Saves or ends the current GNOME session
+gnome-session-save \- End or save the current GNOME session
 .SH SYNOPSIS
 .B gnome-session-save [\-\-logout] [\-\-force\-logout] [\-\-logout\-dialog] [\-\-shutdown\-dialog] [\-\-gui] [\-\-kill [\-\-silent]]
 .SH DESCRIPTION
-\fIgnome-session-save\fP can be used from a GNOME session to save a snapshot
-of the currently running applications.  This session will be later
-restored at your next GNOME session.
+The \fIgnome-session-save\fP program can be used from a GNOME session to
+save a snapshot of the currently running applications. This session will
+be later restored at your next GNOME session.
 .PP
 The \fB\-\-gui\fP option will report errors in dialog boxes instead of
 printing to stderr.
-
+.PP
 If called with the \fB\-\-logout\fP option, the current GNOME session will be
-ended, unless logging out has been inhibited by an application.  The
+ended, unless logging out has been inhibited by an application. The
 \fB\-\-force\-logout\fP option can be used to end the session regardless of
 the inhibition state.
-
+.PP
 When the \fB\-\-logout\-dialog\fP option is given, the standard dialog
-displaying logout options is displayed.  When \fB\-\-shutdown\-dialog\fP
+displaying logout options is displayed. When \fB\-\-shutdown\-dialog\fP
 option is given, the standard dialog displaying shutdown options is
 displayed.
-
-The \fB\-\-kill\fP and \fB\-\-silent\fP options are deprecated.  The
+.PP
+The \fB\-\-kill\fP and \fB\-\-silent\fP options are deprecated. The
 \fB\-\-kill\fP option is equivalent to the \fB\-\-logout\-dialog\fP
-option.  If \fB\-\-silent\fP is used with \fB\-\-kill\fR, then it will
+option. If \fB\-\-silent\fP is used with \fB\-\-kill\fR, then it will
 behave as if \fB\-\-logout\fP was used.
-
+.PP
 The session is not saved when \fIgnome-session-save\fP is called with any of
 the options ending the session.
-
-.SH SEE ALSO
-.BR gnome-session(1)
 .SH BUGS
 If you find bugs in the \fIgnome-session-save\fP program, please report
-these on http://bugzilla.gnome.org.
+these on https://bugzilla.gnome.org.
+.SH SEE ALSO
+.BR gnome-session(1)
diff --git a/doc/man/gnome-session.1 b/doc/man/gnome-session.1
index a256f2a..59cf661 100644
--- a/doc/man/gnome-session.1
+++ b/doc/man/gnome-session.1
@@ -1,16 +1,17 @@
-.\" 
+.\"
 .\" gnome-session manual page.
 .\" (C) 2000 Miguel de Icaza (miguel helixcode com)
+.\" (C) 2009-2010 Vincent Untz (vuntz gnome org)
 .\"
 .TH GNOME-SESSION 1 "GNOME"
 .SH NAME
-gnome-session \- Starts up the GNOME desktop environment
+gnome-session \- Start the GNOME desktop environment
 .SH SYNOPSIS
 .B gnome-session [\-\-autostart=DIR] [\-\-default-session-key=KEY] [\-\-failsafe|\-f] [\-\-debug]
 .SH DESCRIPTION
 The \fIgnome-session\fP program starts up the GNOME desktop
-environment.  This command is typically executed by your login manager
-(either gdm, xdm, or from your X startup scripts).  It will load
+environment. This command is typically executed by your login manager
+(either gdm, xdm, or from your X startup scripts). It will load
 either your saved session, or it will provide a default session for the
 user as defined by the system administrator (or the default GNOME
 installation on your system).
@@ -21,7 +22,7 @@ When saving a session, \fIgnome-session\fP saves the currently running
 applications in the \fB$XDG_CONFIG_HOME/gnome-session/saved-session\fP
 directory.
 .PP
-\fIgnome-session\fP is an X11R6 session manager.  It can manage GNOME
+\fIgnome-session\fP is an X11R6 session manager. It can manage GNOME
 applications as well as any X11R6 SM compliant.
 .SH OPTIONS
 The following options are supported:
@@ -33,38 +34,46 @@ or via the \fI--default-session-key\fP option. Multiple
 \fI--autostart\fP options can be passed.
 .TP
 .I "--default-session-key=KEY"
-Sets the GConf key from which applications running a default session
+Set the GConf key from which applications running a default session
 should be read to \fIKEY\fP. If not specificed,
 \fB/desktop/gnome/session/default_session\fP will be used.
 .TP
 .I "--failsafe"
-\fIgnome-session\fP will run in fail-safe mode. User-specified applications
-will not be started.
+Run in fail-safe mode. User-specified applications will not be started.
 .TP
 .I "--debug"
 Enable debugging code.
 .SH ENVIRONMENT
-\fIgnome-session\fP accepts all of the standard environment variables
-used by gnome programs, other than the SESSION_MANAGER 
-environment variable.
-\fIgnome-session\fP also sets several environment variables
-for the use of its child processes.
-.PP 
+\fIgnome-session\fP sets several environment variables for the use of
+its child processes:
+.PP
 .B SESSION_MANAGER
 .IP
 This variable is used by session-manager aware clients to contact
-gnome-session. 
+gnome-session.
 .PP
 .B DISPLAY
 .IP
-This variable is set to the X display being used by 
+This variable is set to the X display being used by
 \fIgnome-session\fP. Note that if the --display option is used
 this might be different from the setting of the environment variable
 when gnome-session is invoked.
+.SH FILES
+.PP
+.B $XDG_CONFIG_HOME/config/autostart
+.B $XDG_CONFIG_DIRS/config/autostart
+.B /usr/share/gnome/autostart
+.IP
+The applications defined in those directories will be started on login.
+\fIgnome-session-properties(1)\fP can be used to easily configure them.
+.PP
+.B $XDG_CONFIG_HOME/gnome-session/saved-session
+.IP
+This directory contains the list of applications of the saved session.
+.SH BUGS
+If you find bugs in the \fIgnome-session\fP program, please report
+these on https://bugzilla.gnome.org.
 .SH SEE ALSO
 .BR gnome-session-properties(1)
 .BR gnome-session-save(1)
 .BR gnome-wm(1)
-.SH BUGS
-If you find bugs in the \fIgnome-session\fP program, please report
-these on http://bugzilla.gnome.org.
diff --git a/doc/man/gnome-wm.1 b/doc/man/gnome-wm.1
index b42dc1a..88efb99 100644
--- a/doc/man/gnome-wm.1
+++ b/doc/man/gnome-wm.1
@@ -1,38 +1,51 @@
-.\" 
+.\"
 .\" gnome-wm manual page.
 .\" (C) 2000 Miguel de Icaza (miguel helixcode com)
+.\" (C) 2009-2010 Vincent Untz (vuntz gnome org)
 .\"
 .TH GNOME-WM 1 "GNOME"
 .SH NAME
-gnome-wm \- Launches the user selected window manager for the GNOME
-session
+gnome-wm \- Start the window manager configured by the user
 .SH SYNOPSIS
 .PP
-.B gnome-wm [--default-wm windowmanager] [--sm-client-id id]
+.B gnome-wm [--default-wm=WINDOWMANAGER] [--sm-client-id=ID]
 .SH DESCRIPTION
-The \fIgnome-wm\fP script invokes the user selected window manager.
-If the user has not chosen a window manager it will launch a
+The \fIgnome-wm\fP program starts the window manager configured by the
+user. If the user has not chosen a window manager it will launch a
 GNOME compliant window manager.
 .PP
-The user can overwrite the selection of a window manager by setting
-the 
-.B WINDOW_MANAGER
-environment variable.  If a \fB--default-wm\fP option is given the script uses
-that window manager in case
-.B WINDOW_MANAGER
-is not set.
+The user can define his preferred window manager with the
+\fB/desktop/gnome/session/required_components/windowmanager\fP GConf
+key. The value of this key should be the name of the desktop file of the
+desired window manager, without its \fB.desktop\fP extension. If this
+key is set to \fIgnome-wm\fP, then \fIgnome-wm\fP will simply look for
+an appropriate window manager. The user can also override the selection
+of a window manager by setting the \fBWINDOW_MANAGER\fP environment
+variable.
 .PP
-The script takes the \fB--sm-client-id\fP option and translates the id to an
-appropriate option depending on which window manager was selected.
+If the \fB--default-wm\fP option is used, \fIgnome-wm\fP will use
+\fIWINDOWMANAGER\fP as window manager if the \fBWINDOW_MANAGER\fP
+environment variable is not set and if the
+\fB/desktop/gnome/session/required_components/windowmanager\fP GConf
+key does not define a specific window manager, or if the configured
+window manager cannot be found.
 .PP
-
+The \fB--sm-client-id\fP option is translated to an appropriate option
+depending on which window manager will be started.
+.SH OPTIONS
+The following options are supported:
+.TP
+.I --default-wm=WINDOWMANAGER
+Define the default window manager to start if no window manager is
+configured, or if the configured window manager cannot be found.
+.TP
+.I --sm-client-id=ID
+Specify the session management \fIID\fP when connecting to the session manager.
 .SH ENVIRONMENT
-The \fIgnome-wm\fP program uses the value of the
-.B WINDOW_MANAGER 
-environment variable to let the user override the configured window
-manager. 
-.SH SEE ALSO
-.BR gnome-session(1)
+\fIgnome-wm\fP uses the value of the \fBWINDOW_MANAGER\fP environment
+variable to let the user override the configured window manager.
 .SH BUGS
 If you find bugs in the \fIgnome-wm\fP program, please report
-these on http://bugzilla.gnome.org.
+these on https://bugzilla.gnome.org.
+.SH SEE ALSO
+.BR gnome-session(1)