.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "ICEWM-SESSION 1"
.TH ICEWM-SESSION 1 2025-05-03 "icewm\ 3.7.4" "User Commands"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SS NAME
.IX Subsection "NAME"
.Vb 1
\& icewm\-session \- X.Org session manager provider with IceWM
.Ve
.SS SYNOPSIS
.IX Subsection "SYNOPSIS"
\&\fBicewm-session\fR [\fIOPTIONS\fR]
.SS DESCRIPTION
.IX Subsection "DESCRIPTION"
icewm-session is an implementation of a X.Org session manager and can be
run from a X11 session setup. It runs \fBicewm\fR as default window manager
and controls the life cycle of related support applications.
.SS OPTIONS
.IX Subsection "OPTIONS"
.SS "SPECIFIC OPTIONS"
.IX Subsection "SPECIFIC OPTIONS"
.IP "\fB\-c\fR, \fB\-\-config=FILE\fR" 4
.IX Item "-c, --config=FILE"
Let IceWM load preferences from \fIFILE\fR.
.IP "\fB\-t\fR, \fB\-\-theme=FILE\fR" 4
.IX Item "-t, --theme=FILE"
Let IceWM load the theme \fIFILE\fR.
.IP "\fB\-i\fR, \fB\-\-icewm=FILE\fR" 4
.IX Item "-i, --icewm=FILE"
Use \fIFILE\fR as the IceWM window manager.
.IP "\fB\-o\fR, \fB\-\-output=FILE\fR" 4
.IX Item "-o, --output=FILE"
Redirect all output to \fIFILE\fR.
A leading tilde or environment variable is expanded.
.IP "\fB\-a\fR, \fB\-\-alpha\fR" 4
.IX Item "-a, --alpha"
Use a 32\-bit visual for translucency.
.IP "\fB\-b\fR, \fB\-\-nobg\fR" 4
.IX Item "-b, --nobg"
Do not start icewmbg.
.IP "\fB\-n\fR, \fB\-\-notray\fR" 4
.IX Item "-n, --notray"
Do not start icewmtray.
This is only applicable if IceWM was explicitly configured
to use an external icewmtray process.
.IP "\fB\-s\fR, \fB\-\-sound\fR" 4
.IX Item "-s, --sound"
Also start icesound.
.IP \fB\-\-replace\fR 4
.IX Item "--replace"
Replace an existing window manager.
.SS "GENERAL OPTIONS"
.IX Subsection "GENERAL OPTIONS"
.IP "\fB\-d\fR, \fB\-\-display\fR=\fIDISPLAY\fR" 4
.IX Item "-d, --display=DISPLAY"
Use \fIDISPLAY\fR to connect to the X server.
If this option is missing then \fIDISPLAY\fR
is read from the environment variable \f(CW\*(C`DISPLAY\*(C'\fR.
.IP \fB\-\-sync\fR 4
.IX Item "--sync"
Use a slower synchronous mode communication with the \fIX11\fR server.
.IP "\fB\-h\fR, \fB\-\-help\fR" 4
.IX Item "-h, --help"
Give a list of all supported options and exit.
.IP "\fB\-V\fR, \fB\-\-version\fR" 4
.IX Item "-V, --version"
Print the program version and exit.
.IP "\fB\-C\fR, \fB\-\-copying\fR" 4
.IX Item "-C, --copying"
Print copying permissions and exit.
.SS "DEBUGGING OPTIONS"
.IX Subsection "DEBUGGING OPTIONS"
.IP "\fB\-v\fR, \fB\-\-\-valgrind\fR" 4
.IX Item "-v, ---valgrind"
Let \f(CW\*(C`/usr/bin/valgrind\*(C'\fR run icewm.
Thoroughly examines the execution of icewm.
.IP "\fB\-g\fR, \fB\-\-\-catchsegv\fR" 4
.IX Item "-g, ---catchsegv"
Let \f(CW\*(C`/usr/bin/catchsegv\*(C'\fR run icewm.
Gives a backtrace if icewm segfaults.
.SS USAGE
.IX Subsection "USAGE"
On startup icewm-session executes the following steps.
From the file \fIenv\fR in the configuration directory
it loads additional environment variables, if that file exists.
Then it will start \fIicewmbg\fR to manage root background colors and images.
It may also start \fIicesound\fR, if this was enabled at configuration time.
Then \fIicewm\fR is started.
.PP
If there exists an executable script \fIstartup\fR in the configuration
directory, it will be executed. It may contain commands to initialize X11
settings with \fIxset\fR, load keyboard configuration, start a compositing
manager like \fIcompton\fR and load system tray applications.
.PP
When icewm exits, icewm-session will execute a \fIshutdown\fR script,
if it exists in the configuration directory.
When this finishes, icewm-session will terminate icewm, icewmbg
and icesound. Finally, icewm-session will exit.
.PP
If the icewm process crashes then icewm-session will attempt to restart
it. If two such crashes occur in a short period, then icewm-session will
attempt to popup a dialog using either \fIyad\fR, \fIxmessage\fR, \fIkdialog\fR
or \fIzenity\fR.  This dialog presents a choice between restarting icewm,
starting a terminal, or abort execution of icewm-session.
.SS ENVIRONMENT
.IX Subsection "ENVIRONMENT"
.IP \fBICEWM_OPTIONS\fR 4
.IX Item "ICEWM_OPTIONS"
A space separated list of options that will be added to the command
line invocation of \fIicewm\fR. This can be set in the \fIenv\fR file.
.SS "SEE ALSO"
.IX Subsection "SEE ALSO"
\&\fBicewm\fR\|(1),
\&\fBicewm\-env\fR\|(5),
\&\fBicewm\-shutdown\fR\|(5),
\&\fBicewm\-startup\fR\|(5),
\&\fBicewmbg\fR\|(1).
.SS BUGS
.IX Subsection "BUGS"
Please report bugs at <https://github.com/bbidulock/icewm/issues>.
.SS AUTHOR
.IX Subsection "AUTHOR"
Brian Bidulock <mailto:bidulock@openss7.org>.
.PP
See \fB\-\-copying\fR for full copyright notice and copying permissions.
.SS LICENSE
.IX Subsection "LICENSE"
\&\fBIceWM\fR is licensed under the GNU Library General Public License.
See the \fICOPYING\fR file in the distribution or use the \fB\-\-copying\fR flag
to display copying permissions.