From a5598d73e239886f892f012162b02d2533bd4932 Mon Sep 17 00:00:00 2001 From: hekel Date: Mon, 17 Feb 2014 10:43:48 +0100 Subject: Update manpages --- doc/man/mate-session.1 | 125 ++++++++++++++++++++++++++----------------------- 1 file changed, 67 insertions(+), 58 deletions(-) (limited to 'doc/man/mate-session.1') diff --git a/doc/man/mate-session.1 b/doc/man/mate-session.1 index 427356a..522dd35 100644 --- a/doc/man/mate-session.1 +++ b/doc/man/mate-session.1 @@ -1,79 +1,88 @@ -.\" -.\" mate-session manual page. +.\" Manual page for mate-session .\" (C) 2000 Miguel de Icaza (miguel@helixcode.com) .\" (C) 2009-2010 Vincent Untz (vuntz@gnome.org) +.TH MATE-SESSION 1 "11 February 2014" "MATE Desktop Environment" +.\" Please adjust this date when revising the manpage. .\" -.TH MATE-SESSION 1 "MATE" -.SH NAME -mate-session \- Start the MATE desktop environment -.SH SYNOPSIS -.B mate-session [\-\-autostart=DIR] [\-\-default-session-key=KEY] [\-\-failsafe|\-f] [\-\-debug] -.SH DESCRIPTION -The \fImate-session\fP program starts up the MATE desktop -environment. This command is typically executed by your login manager -(either mdm, 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 MATE -installation on your system). +.SH "NAME" +mate-session \- Start the MATE Desktop Environment. +.SH "SYNOPSIS" +.B mate-session [OPTIONS] +.SH "DESCRIPTION" +The \fBmate-session\fP program starts up the MATE desktop environment. This command is typically executed by your Login/Display Manager (like GDM, LXDM, XDM, SLiM, or from your X startup scripts like .xinitrc). 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 MATE installation on your system). .PP -The default session is defined in the MateConf keys under -\fB/desktop/mate/session\fP. -When saving a session, \fImate-session\fP saves the currently running -applications in the \fB$XDG_CONFIG_HOME/mate-session/saved-session\fP -directory. +The default session is defined in the dconf keys under +.BI / org / mate / desktop / session / +.br +When saving a session, \fBmate-session\fP saves the currently running applications in the \fB~/.config/mate-session/saved-session\fP directory of the users /home. .PP -\fImate-session\fP is an X11R6 session manager. It can manage MATE -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/mate/session/default_session\fP, -or via the \fI--default-session-key\fP option. Multiple -\fI--autostart\fP options can be passed. +\fBmate-session\fP is an X11 session manager. It can manage MATE applications as well as any other X11 SM compliant ones. + +.SH "OPTIONS" +.SS The following options are supported: .TP -.I "--default-session-key=KEY" -Set the MateConf key from which applications running a default session -should be read to \fIKEY\fP. If not specificed, -\fB/desktop/mate/session/default_session\fP will be used. +\fB\-a, \-\-autostart=DIR\fR +Start all applications defined in "\fBDIR\fP", instead of starting the applications defined in +.BI / org / mate / desktop / session / default\-session +.br +Multiple \fB\-\-autostart\fP options can be passed. .TP -.I "--failsafe" +\fB\-f, \-\-failsafe\fR Run in fail-safe mode. User-specified applications will not be started. .TP -.I "--debug" +\fB\-\-debug\fR Enable debugging code. -.SH ENVIRONMENT -\fImate-session\fP sets several environment variables for the use of -its child processes: +.TP +\fB\-\-display=DISPLAY\fR +X display to use. +.TP +\fB\-\-version\fR +Output version information and exit. +.TP +\fB\-?, -h, \-\-help\fR +Print standard command line options. +.TP +\fB\-\-help\-all\fR +Print all command line options. + +.SH "ENVIRONMENT" +.SS \fBmate-session\fP sets several environment variables for the use of its child processes: .PP -.B SESSION_MANAGER +.B "SESSION_MANAGER" .IP -This variable is used by session-manager aware clients to contact -mate-session. +This variable is used by session-manager aware clients to contact mate-session. .PP -.B DISPLAY +.B "DISPLAY" .IP -This variable is set to the X display being used by -\fImate-session\fP. Note that if the --display option is used -this might be different from the setting of the environment variable -when mate-session is invoked. -.SH FILES +This variable is set to the X display being used by \fBmate-session\fP. Note that if the \-\-display option is used this might be different from the setting of the environment variable when mate-session is invoked. + +.SH "FILES" .PP -.B $XDG_CONFIG_HOME/config/autostart -.B $XDG_CONFIG_DIRS/config/autostart +.nf +.B ~/.config/autostart +.B /usr/share/autostart .B /usr/share/mate/autostart +.fi .IP -The applications defined in those directories will be started on login. -\fImate-session-properties(1)\fP can be used to easily configure them. +The applications defined in the above directories will be started on login. \fBmate-session-properties(1)\fP can be used to easily configure them. .PP -.B $XDG_CONFIG_HOME/mate-session/saved-session +.B ~/.config/mate-session/saved-session .IP This directory contains the list of applications of the saved session. -.SH BUGS -If you find bugs in the \fImate-session\fP program, please report -these on https://bugzilla.gnome.org. -.SH SEE ALSO -.BR mate-session-properties(1) -.BR mate-session-save(1) +.SH "BUGS" +.SS Should you encounter any bugs, they may be reported at: +http://github.com/mate-desktop/mate-session/issues +.SH "AUTHORS" +.SS This Manual page was originally written for gnome-session by: +.nf +Miguel de Icaza (2000) +Vincent Untz (2009-2010) +.fi +.SS It has been updated for the MATE Desktop Environment by: +Adam Erdman (2014) +.SH "SEE ALSO" +.SS Further information may also be available at: http://wiki.mate-desktop.org/docs +.P +.BR mate-session-properties(1), +.BR mate-session-save(1), .BR mate-wm(1) -- cgit v1.2.1