Commit 87e24d30 authored by Vincent Untz's avatar Vincent Untz Committed by Vincent Untz

rework the man pages so that they're up-to-date.

2009-03-18  Vincent Untz  <vuntz@gnome.org>

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

svn path=/trunk/; revision=5342
parent a3686216
2009-03-18 Vincent Untz <vuntz@gnome.org>
* configure.in:
* doc/man/*: rework the man pages so that they're up-to-date.
2009-03-16 Vincent Untz <vuntz@gnome.org>
* configure.in: post-release bump to 2.26.1
......
......@@ -334,8 +334,6 @@ doc/Makefile
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
......
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)
.\"
.\" GNOME default session manual page
.\" (C) 2000 Miguel de Icaza (miguel@helixcode.com).
.\"
.\" This manual page is covered by the terms of the GNU General
.\" Public License.
.\"
.TH GNOME 1 "GNOME 1.0"
.SH NAME
default.session \- GNOME Default session configuration file.
.SH DESCRIPTION
The
.I @datadir@/gnome/default.session
file contains a list of programs to be launched the first time a user
logs into the GNOME environment.
.PP
The format of the file is the one used by the gnome_config libraries,
and it looks like this:
.PP
.nf
[Section]
SEQID,id=uniqueID
SEQID,Priority=PRIO
SEQID,RestartCommand=command
num_clients=TOP
.fi
.PP
There are three possible names for
.B Section
And they are:
.PP
.I Default
.IP
This specifies the Default session to load
.PP
.I Chooser
.IP
Lets the user configure which non-session aware programs should be
started up when the session begins
.PP
.I Warner
.IP
.PP
Since the gnome_config file format is not very flexible, an array of
data is emulated by listing starting from 0 chunks of
"id,Priority,RestartCommand", and at the end the
.I num_clients
variable lists the number of chunks listed.
.PP
The
.B uniqueid
key provides a name that is unique within this file and passed to the
app as the client id which it must use to register with
gnome-session.
.PP
The
.B RestartCommand
specifies the command to run from the $PATH.
.PP
The
.B Priority
determines the order in which the commands are started
(with Priority = 0 first) and defaults to 50.
.PP
The clients must be numbered from 0 to the value of
.I num_clients-1
.TH GNOME-SESSION-PROPERTIES 1 "GNOME"
.SH NAME
gnome-session-properties \- Configure what 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.
.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 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.
......@@ -10,27 +10,28 @@ gnome-session-save \- Saves or ends the current GNOME session
.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)
......
......@@ -2,68 +2,52 @@
.\" gnome-session manual page.
.\" (C) 2000 Miguel de Icaza (miguel@helixcode.com)
.\"
.TH GNOME 1 "GNOME 1.0"
.TH GNOME-SESSION 1 "GNOME"
.SH NAME
gnome-session \- Starts up the GNOME desktop environment
.SH SYNOPSIS
.B gnome-session [\-\-choosesession] [\-\-failsafe]
[\-\-purge-delay=DELAY] [\-\-warn-delay=DELAY]
[\-\-suicide-delay=DELAY] [session-name]
.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 last session, or it will provide a default session for the
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
You can optionally specify a specific session name to restore.
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.
.PP
\fIgnome-session\fP uses the contents of the ~/.gnome2/session file
for starting up as specified by the "CurrentSession" key in the
~/.gnome2/session-options file. Various default values are
provided in case the file entry does not exist.
.PP
If the session file does not exist, \fIgnome-session\fP will use the
contents of the
.I @datadir@/gnome/default.session
file.
.SH OPTIONS
The following options are supported:
.TP
.I "--choose-session=ARG"
User can specify a session to load, as opposed to the session
specified in the ~/.gnome2/session-options file. If that entry
does not exist in the ~/.gnome2/session file (or if that file
doesn't exist), it will use the default session and all saves
to that session will be to the new session name.
.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 "--failsafe"
Fail safe operations mode: only reads saved sessions from the
default.session file.
.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 "--purge-delay=ARG"
The number of millisecond that \fIgnome-session\fP will wait for
clients to register, if you use 0 it will wait forever (default value:
30,000 milliseconds).
.TP
.I "--warn-delay=ARG"
The number of millisecond that \fIgnome-session\fP will wait for
clients to respond, if you use 0 it will wait forever (default value:
10,000 milliseconds).
.I "--failsafe"
\fIgnome-session\fP will run in fail-safe mode. User-specified applications
will not be started.
.TP
.I "--suicide-delay=ARG"
The number of millisecond that \fIgnome-session\fP will wait for
clients to die, if you use 0 it will wait forever (default value:
10,000 milliseconds).
.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. [ xref to a manpage where this is documented. ]
gnome-session also sets several environment variables
environment variable.
\fIgnome-session\fP also sets several environment variables
for the use of its child processes.
.PP
.B SESSION_MANAGER
......@@ -78,9 +62,9 @@ This variable is set to the X display being used by
this might be different from the setting of the environment variable
when gnome-session is invoked.
.SH SEE ALSO
.BR default.session (5), gnome-session-save(1)
.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 using \fIbug-buddy\fP or the \fIgnome-bug\fP script included
with the GNOME libraries distribution.
these on http://bugzilla.gnome.org.
......@@ -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 @@ session
.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 @@ The \fIgnome-wm\fP program uses the value of the
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.
.\" 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" "" ""
.SH NAME
session-properties-capplet \- control what programs are started at login time.
.SH SYNOPSIS
\fBsession-properties-capplet\fR [ \fB --warner \fR ]
.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.
.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).
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY dhfirstname "<firstname>Christian</firstname>">
<!ENTITY dhsurname "<surname>Marillat</surname>">
<!ENTITY dhdate "<date>April 17, 2001</date>">
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>marillat@debian.org</email>">
<!ENTITY dhusername "Christian Marillat">
<!ENTITY dhucpackage "<refentrytitle>session-properties-capplet</refentrytitle>">
<!ENTITY dhpackage "session-properties-capplet">
<!ENTITY debian "<productname>Debian GNU/Linux</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2001</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose> control what programs are started at login time.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option> --warner </option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> 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.</para>
<para>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.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>--warner</option></term>
<listitem>
<para>Only display warnings.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; &dhemail; for
the &debian; system (but may be used by others).</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
.\" 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" "1" "10 februar 2002" "" ""
.SH NAME
session-properties \- a non-CORBA version of the session-properties-capplet.
.SH SYNOPSIS
\fBsession-properties\fR [ \fB --init-session-settings \fR ] [ \fB --warner \fR ]
.SH "DESCRIPTION"
.PP
\fBsession-properties\fR monitors the state of current GNOME
running applications and capplets. It allows you to change the style
and priority of each program. You can shut down applications, if you
wish, and those applications will be removed from your GNOME session.
You can also use Session Properties to kill a GNOME application and
remove it from session management so it will not be restarted when you
log in next time. Of course, there are other ways to kill an
application, such as using an explicit kill command, but they would
not prevent an application from being restarted if it has the Respawn
Style. The only way to permanently remove such an application is with
the Remove button.
.SH "OPTIONS"
.TP
\fB--init-session-settings\fR
Initialize session settings.
.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).
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY dhfirstname "<firstname>Christian</firstname>">
<!ENTITY dhsurname "<surname>Marillat</surname>">
<!ENTITY dhdate "<date>April 17, 2001</date>">
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>marillat@debian.org</email>">
<!ENTITY dhusername "Christian Marillat">
<!ENTITY dhucpackage "<refentrytitle>session-properties</refentrytitle>">
<!ENTITY dhpackage "session-properties">
<!ENTITY debian "<productname>Debian GNU/Linux</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2001</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose> a non-CORBA version of the session-properties-capplet.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option> --init-session-settings </option></arg>
<arg><option> --warner </option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> monitors the state of current GNOME
running applications and capplets. It allows you to change the style
and priority of each program. You can shut down applications, if you
wish, and those applications will be removed from your GNOME session.
You can also use Session Properties to kill a GNOME application and
remove it from session management so it will not be restarted when you
log in next time. Of course, there are other ways to kill an
application, such as using an explicit kill command, but they would
not prevent an application from being restarted if it has the Respawn
Style. The only way to permanently remove such an application is with
the Remove button.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>--init-session-settings</option></term>
<listitem>
<para>Initialize session settings.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--warner</option></term>
<listitem>
<para>Only display warnings.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; &dhemail; for
the &debian; system (but may be used by others).</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment