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-properties.1 | 50 +++++++++++---- doc/man/mate-session-save.1 | 88 ++++++++++++++++++--------- doc/man/mate-session.1 | 125 ++++++++++++++++++++------------------ doc/man/mate-wm.1 | 73 +++++++++++----------- 4 files changed, 200 insertions(+), 136 deletions(-) diff --git a/doc/man/mate-session-properties.1 b/doc/man/mate-session-properties.1 index 1ceae63..bcaa626 100644 --- a/doc/man/mate-session-properties.1 +++ b/doc/man/mate-session-properties.1 @@ -1,24 +1,48 @@ -.\" .\" mate-session-properties manual page. .\" (C) 2009-2010 Vincent Untz (vuntz@gnome.org) .\" -.TH MATE-SESSION-PROPERTIES 1 "MATE" -.SH NAME -mate-session-properties \- Configure applications to start on login -.SH SYNOPSIS +.TH MATE-SESSION-PROPERTIES 1 "11 February 2014" "MATE Desktop Environment" +.\" Please adjust this date when revising the manpage. +.\" +.SH "NAME" +mate-session-properties \- Configure applications to start on login. +.SH "SYNOPSIS" .B mate-session-properties -.SH DESCRIPTION +.SH "DESCRIPTION" .PP -The \fImate-session-properties\fP program enables the users to +The \fBmate-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 MATE session. -.SH BUGS -If you find bugs in the \fImate-session-properties\fP program, please report -these on https://bugzilla.gnome.org. -.SH SEE ALSO -.BR mate-session(1) -.BR mate-session-save(1) +.SH "OPTIONS" +.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 "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 +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(1), +.BR mate-session-save(1), +.BR mate-wm(1) diff --git a/doc/man/mate-session-save.1 b/doc/man/mate-session-save.1 index 6babab0..ccec6aa 100644 --- a/doc/man/mate-session-save.1 +++ b/doc/man/mate-session-save.1 @@ -1,40 +1,70 @@ -.\" .\" mate-session-save manual page. .\" (C) 2000 Miguel de Icaza (miguel@helixcode.com) .\" (C) 2009-2010 Vincent Untz (vuntz@gnome.org) .\" -.TH MATE-SESSION-SAVE 1 "MATE" -.SH NAME +.TH MATE-SESSION-SAVE 1 "11 February 2014" "MATE Desktop Environment" +.\" Please adjust this date when revising the manpage. +.\" +.SH "NAME" mate-session-save \- End or save the current MATE session -.SH SYNOPSIS +.SH "SYNOPSIS" .B mate-session-save [\-\-logout] [\-\-force\-logout] [\-\-logout\-dialog] [\-\-shutdown\-dialog] [\-\-gui] [\-\-kill [\-\-silent]] -.SH DESCRIPTION -The \fImate-session-save\fP program can be used from a MATE session to -save a snapshot of the currently running applications. This session will -be later restored at your next MATE session. -.PP -The \fB\-\-gui\fP option will report errors in dialog boxes instead of -printing to stderr. +.SH "DESCRIPTION" +The \fBmate-session-save\fP program can be used from a MATE session to save a snapshot of the currently running applications. This session will be later restored at your next MATE session. +.SH "USAGE" +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 MATE session will be -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. +If called with the \fB\-\-logout\fP option, the current MATE session will be 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 -option is given, the standard dialog displaying shutdown options is -displayed. +When the \fB\-\-logout\-dialog\fP option is given, the standard dialog displaying logout options is displayed. When \fB\-\-shutdown\-dialog\fP option is given, the standard dialog displaying shutdown options is displayed. .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 -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. .PP -The session is not saved when \fImate-session-save\fP is called with any of -the options ending the session. -.SH BUGS -If you find bugs in the \fImate-session-save\fP program, please report -these on https://bugzilla.gnome.org. -.SH SEE ALSO +The session is not saved when \fBmate-session-save\fP is called with any of the options ending the session. +.SH "OPTIONS" +.TP +\fB\-\-logout\fR +Log out +.TP +\fB\-\-force-logout\fR +Log out, ignoring any existing inhibitors +.TP +\fB\-\-ogout-dialog\fR +Show logout dialog +.TP +\fB\-\-shutdown-dialog\fR +Show shutdown dialog +.TP +\fB\-\-gui\fR +.br +Use dialog boxes for errors +.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 "BUGS" +.SS Should you encounter any bugs, they may be reported at: +http://github.com/mate-desktop/mate-session/issues +.SH "AUTHORS" +.SS This Man Page has been updated/re-written for the MATE Desktop Environment by: +Adam Erdman (2014) +.SH "HISTORY" +.SS This Manual was originally written for gnome-session by: +.nf +Miguel de Icaza (2000) +Vincent Untz (2009-2010) +.fi +.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-wm(1), .BR 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) diff --git a/doc/man/mate-wm.1 b/doc/man/mate-wm.1 index db59c23..25866bb 100644 --- a/doc/man/mate-wm.1 +++ b/doc/man/mate-wm.1 @@ -1,51 +1,52 @@ -.\" .\" mate-wm manual page. .\" (C) 2000 Miguel de Icaza (miguel@helixcode.com) .\" (C) 2009-2010 Vincent Untz (vuntz@gnome.org) .\" -.TH MATE-WM 1 "MATE" -.SH NAME +.TH MATE-WM 1 "11 February 2014" "MATE Desktop Environment" +.\" Please adjust this date when revising the manpage. +.\" +.SH "NAME" mate-wm \- Start the window manager configured by the user -.SH SYNOPSIS +.SH "SYNOPSIS" .PP .B mate-wm [--default-wm=WINDOWMANAGER] [--sm-client-id=ID] -.SH DESCRIPTION -The \fImate-wm\fP program starts the window manager configured by the -user. If the user has not chosen a window manager it will launch a -MATE compliant window manager. -.PP +.SH "DESCRIPTION" +The \fBmate-wm\fP program starts the window manager configured by the user. If the user has not chosen a window manager it will launch a MATE compliant window manager. +.SH "USAGE" The user can define his preferred window manager with the -\fB/desktop/mate/session/required_components/windowmanager\fP MateConf -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 \fImate-wm\fP, then \fImate-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. +.BI / org / mate / desktop / session / required-components / windowmanager +dconf 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 \fBmate-wm\fP, then \fBmate-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 -If the \fB--default-wm\fP option is used, \fImate-wm\fP will use -\fIWINDOWMANAGER\fP as window manager if the \fBWINDOW_MANAGER\fP -environment variable is not set and if the -\fB/desktop/mate/session/required_components/windowmanager\fP MateConf -key does not define a specific window manager, or if the configured -window manager cannot be found. +If the \fB\-\-default-wm\fP option is used, \fBmate-wm\fP will use \fBWINDOWMANAGER\fP as window manager if the \fBWINDOW_MANAGER\fP environment variable is not set and if the +.BI / org / mate / desktop / session / required-components / windowmanager +dconf 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 \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. +.B \-\-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 +.B \-\-sm-client-id=ID Specify the session management \fIID\fP when connecting to the session manager. -.SH ENVIRONMENT -\fImate-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 \fImate-wm\fP program, please report -these on https://bugzilla.gnome.org. -.SH SEE ALSO +.SH "ENVIRONMENT" +\fImate-wm\fP uses the value of the \fBWINDOW_MANAGER\fP environment variable to let the user override the configured window manager. +.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 Man Page has been updated for the MATE Desktop Environment by: +Adam Erdman (2014) +.SH "HISTORY" +.SS This Manual was originally written for gnome-session by: +.nf +Miguel de Icaza (2000) +Vincent Untz (2009-2010) +.fi +.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-session(1) -- cgit v1.2.1