gnome-session r5342 - in trunk: . doc/man

[vuntz svn gnome org]

Author: vuntz
Date: Wed Mar 18 22:03:01 2009
New Revision: 5342
URL: http://svn.gnome.org/viewvc/gnome-session?rev=5342&view=rev

Log:
2009-03-18  Vincent Untz  <vuntz gnome org>

	* configure.in:
	* doc/man/*: rework the man pages so that they're up-to-date.


Added:
   trunk/doc/man/gnome-session-properties.1
      - copied, changed from r5341, /trunk/doc/man/session-properties-capplet.1
   trunk/doc/man/gnome-session.1
Removed:
   trunk/doc/man/default.session.5.in
   trunk/doc/man/gnome-session.1.in
   trunk/doc/man/session-properties-capplet.1
   trunk/doc/man/session-properties-capplet.sgml
   trunk/doc/man/session-properties.1
   trunk/doc/man/session-properties.sgml
Modified:
   trunk/ChangeLog
   trunk/configure.in
   trunk/doc/man/Makefile.am
   trunk/doc/man/gnome-session-save.1
   trunk/doc/man/gnome-wm.1

Modified: trunk/configure.in
==============================================================================
--- trunk/configure.in	(original)
+++ trunk/configure.in	Wed Mar 18 22:03:01 2009
@@ -334,8 +334,6 @@
 doc/dbus/Makefile
 doc/dbus/gnome-session.xml
 doc/man/Makefile
-doc/man/gnome-session.1
-doc/man/default.session.5
 data/Makefile
 data/gnome-wm.desktop.in
 data/session-properties.desktop.in

Modified: trunk/doc/man/Makefile.am
==============================================================================
--- trunk/doc/man/Makefile.am	(original)
+++ trunk/doc/man/Makefile.am	Wed Mar 18 22:03:01 2009
@@ -1,11 +1,8 @@
-man_MANS =			\
-	gnome-session-save.1	\
-	session-properties.1	\
-	gnome-wm.1		\
-	gnome-session.1		\
-	default.session.5
+man_MANS =				\
+	gnome-session.1			\
+	gnome-session-properties.1	\
+	gnome-session-save.1		\
+	gnome-wm.1
 
 EXTRA_DIST =			\
-	$(man_MANS)		\
-	gnome-session.1.in	\
-	default.session.5.in
+	$(man_MANS)

Copied: trunk/doc/man/gnome-session-properties.1 (from r5341, /trunk/doc/man/session-properties-capplet.1)
==============================================================================
--- /trunk/doc/man/session-properties-capplet.1	(original)
+++ trunk/doc/man/gnome-session-properties.1	Wed Mar 18 22:03:01 2009
@@ -1,36 +1,22 @@
-.\" This manpage has been automatically generated by docbook2man 
-.\" from a DocBook document.  This tool can be found at:
-.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
-.\" Please send any bug reports, improvements, comments, patches, 
-.\" etc. to Steve Cheng <steve ggi-project org>.
-.TH "SESSION-PROPERTIES-CAPPLET" "1" "10 februar 2002" "" ""
+.TH GNOME-SESSION-PROPERTIES 1 "GNOME"
 .SH NAME
-session-properties-capplet \- control what programs are started at login time.
+gnome-session-properties \- Configure what applications to start on login
 .SH SYNOPSIS
 
-\fBsession-properties-capplet\fR [ \fB --warner \fR ]
+.B gnome-session-properties
 
-.SH "DESCRIPTION"
+.SH DESCRIPTION
 .PP
-\fBsession-properties-capplet\fR allows you to control what programs
-are started at login time. Gnome has the concept of session
-management. In simple terms, it means that you can save your "session"
-(that is, information about currently working applications, their
-status and position on the screen) at any stage, and at your next
-login the same applications will reappear on your screen in the same
-positions, allowing you to continue your work. Note, however, this
-only works for Gnome compliant applications.
+\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.
 .PP
-Gnome also provides another way of starting applications at login. 
-You can explicitly specify one or more commands to run, and Gnome will
-execute them at login in addition to the applications from your saved
-session. This works for all kinds of applications, whether Gnome
-compliant or not.
-.SH "OPTIONS"
-.TP
-\fB--warner\fR
-Only display warnings.
-.SH "AUTHOR"
-.PP
-This manual page was written by Christian Marillat <marillat debian org> for
-the Debian GNU/Linux system (but may be used by others).
+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 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.

Modified: trunk/doc/man/gnome-session-save.1
==============================================================================
--- trunk/doc/man/gnome-session-save.1	(original)
+++ trunk/doc/man/gnome-session-save.1	Wed Mar 18 22:03:01 2009
@@ -10,27 +10,28 @@
 .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 startup session.
+restored at your next GNOME session.
 .PP
-The \fB\-\-gui\fP argument will report errors in dialog boxes instead of
+The \fB\-\-gui\fP option will report errors in dialog boxes instead of
 printing to stderr.
 
-If called with the \fB\-\-logout\fP argument, the current GNOME session will be
+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
-\fB\-\-force\-logout\fP argument can be used to end the session regardless of
+\fB\-\-force\-logout\fP option can be used to end the session regardless of
 the inhibition state.
 
-When the \fB\-\-logout\-dialog\fP argument is given, the standard dialog
+When the \fB\-\-logout\-dialog\fP option is given, the standard dialog
 displaying logout options is displayed.  When \fB\-\-shutdown\-dialog\fP
-argument is given, the standard dialog displaying shutdown options is
+option is given, the standard dialog displaying shutdown options is
 displayed.
 
-The \fB\-\-kill\fP argument is deprecated.  It is equivalent to the
-\fB\-\-logout\-dialog\fP argument.  If \fB\-\-silent\fP is used with
-\fB\-\-kill\fR, then it will behave as if \fB\-\-logout\fP was used.
+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
+behave as if \fB\-\-logout\fP was used.
 
 The session is not saved when \fIgnome-session-save\fP is called with any of
-the arguments ending the session.
+the options ending the session.
 
 .SH SEE ALSO
 .BR gnome-session(1)

Added: trunk/doc/man/gnome-session.1
==============================================================================
--- (empty file)
+++ trunk/doc/man/gnome-session.1	Wed Mar 18 22:03:01 2009
@@ -0,0 +1,70 @@
+.\" 
+.\" gnome-session manual page.
+.\" (C) 2000 Miguel de Icaza (miguel helixcode com)
+.\"
+.TH GNOME-SESSION 1 "GNOME"
+.SH NAME
+gnome-session \- Starts up 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
+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).
+.PP
+The default session is defined in the GConf keys under
+\fB/desktop/gnome/session\fP.
+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
+applications as well as any X11R6 SM compliant.
+.SH OPTIONS
+The following options are supported:
+.TP
+.I "--autostart=DIR"
+Start all applications defined in \fIDIR\fP, instead of starting the
+applications defined in \fB/desktop/gnome/session/default_session\fP,
+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
+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.
+.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 
+.B SESSION_MANAGER
+.IP
+This variable is used by session-manager aware clients to contact
+gnome-session. 
+.PP
+.B DISPLAY
+.IP
+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 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.

Modified: trunk/doc/man/gnome-wm.1
==============================================================================
--- trunk/doc/man/gnome-wm.1	(original)
+++ trunk/doc/man/gnome-wm.1	Wed Mar 18 22:03:01 2009
@@ -2,7 +2,7 @@
 .\" gnome-wm manual page.
 .\" (C) 2000 Miguel de Icaza (miguel helixcode com)
 .\"
-.TH GNOME 1 "GNOME 1.0"
+.TH GNOME-WM 1 "GNOME"
 .SH NAME
 gnome-wm \- Launches the user selected window manager for the GNOME
 session
@@ -11,19 +11,18 @@
 .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 try to launch a
+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 --default-wm option is given the script uses
+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.  If gnome-wm is given as the argument to --default-wm then it
-is the same as if no default was given.
+is not set.
 .PP
-The script takes the --sm-client-id argument and translates the id to an
+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.
 .PP
 
@@ -33,8 +32,7 @@
 environment variable to let the user override the configured window
 manager. 
 .SH SEE ALSO
-.BR gnome-session(1), default.session(5)
+.BR gnome-session(1)
 .SH BUGS
 If you find bugs in the \fIgnome-wm\fP program, please report
-these using \fIbug-buddy\fP.
-
+these on http://bugzilla.gnome.org.