| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "ICEWM-SESSION 1" |
| 58 |
.TH ICEWM-SESSION 1 2026-01-18 "icewm\ 4.0.0" "User Commands" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SS NAME |
| 64 |
.IX Subsection "NAME" |
| 65 |
.Vb 1 |
| 66 |
\& icewm\-session \- X.Org session manager provider with IceWM |
| 67 |
.Ve |
| 68 |
.SS SYNOPSIS |
| 69 |
.IX Subsection "SYNOPSIS" |
| 70 |
\&\fBicewm-session\fR [\fIOPTIONS\fR] |
| 71 |
.SS DESCRIPTION |
| 72 |
.IX Subsection "DESCRIPTION" |
| 73 |
icewm-session is an implementation of a X.Org session manager and can be |
| 74 |
run from a X11 session setup. It runs \fBicewm\fR as default window manager |
| 75 |
and controls the life cycle of related support applications. |
| 76 |
.SS OPTIONS |
| 77 |
.IX Subsection "OPTIONS" |
| 78 |
.SS "SPECIFIC OPTIONS" |
| 79 |
.IX Subsection "SPECIFIC OPTIONS" |
| 80 |
.IP "\fB\-c\fR, \fB\-\-config=FILE\fR" 4 |
| 81 |
.IX Item "-c, --config=FILE" |
| 82 |
Let IceWM load preferences from \fIFILE\fR. |
| 83 |
.IP "\fB\-t\fR, \fB\-\-theme=FILE\fR" 4 |
| 84 |
.IX Item "-t, --theme=FILE" |
| 85 |
Let IceWM load the theme \fIFILE\fR. |
| 86 |
.IP "\fB\-i\fR, \fB\-\-icewm=FILE\fR" 4 |
| 87 |
.IX Item "-i, --icewm=FILE" |
| 88 |
Use \fIFILE\fR as the IceWM window manager. |
| 89 |
.IP "\fB\-o\fR, \fB\-\-output=FILE\fR" 4 |
| 90 |
.IX Item "-o, --output=FILE" |
| 91 |
Redirect all output to \fIFILE\fR. |
| 92 |
A leading tilde or environment variable is expanded. |
| 93 |
.IP "\fB\-a\fR, \fB\-\-alpha\fR" 4 |
| 94 |
.IX Item "-a, --alpha" |
| 95 |
Use a 32\-bit visual for translucency. |
| 96 |
.IP "\fB\-b\fR, \fB\-\-nobg\fR" 4 |
| 97 |
.IX Item "-b, --nobg" |
| 98 |
Do not start icewmbg. |
| 99 |
.IP "\fB\-n\fR, \fB\-\-notray\fR" 4 |
| 100 |
.IX Item "-n, --notray" |
| 101 |
Do not start icewmtray. |
| 102 |
This is only applicable if IceWM was explicitly configured |
| 103 |
to use an external icewmtray process. |
| 104 |
.IP "\fB\-s\fR, \fB\-\-sound\fR" 4 |
| 105 |
.IX Item "-s, --sound" |
| 106 |
Also start icesound. |
| 107 |
.IP \fB\-\-replace\fR 4 |
| 108 |
.IX Item "--replace" |
| 109 |
Replace an existing window manager. |
| 110 |
.SS "GENERAL OPTIONS" |
| 111 |
.IX Subsection "GENERAL OPTIONS" |
| 112 |
.IP "\fB\-d\fR, \fB\-\-display\fR=\fIDISPLAY\fR" 4 |
| 113 |
.IX Item "-d, --display=DISPLAY" |
| 114 |
Use \fIDISPLAY\fR to connect to the X server. |
| 115 |
If this option is missing then \fIDISPLAY\fR |
| 116 |
is read from the environment variable \f(CW\*(C`DISPLAY\*(C'\fR. |
| 117 |
.IP \fB\-\-sync\fR 4 |
| 118 |
.IX Item "--sync" |
| 119 |
Use a slower synchronous mode communication with the \fIX11\fR server. |
| 120 |
.IP "\fB\-h\fR, \fB\-\-help\fR" 4 |
| 121 |
.IX Item "-h, --help" |
| 122 |
Give a list of all supported options and exit. |
| 123 |
.IP "\fB\-V\fR, \fB\-\-version\fR" 4 |
| 124 |
.IX Item "-V, --version" |
| 125 |
Print the program version and exit. |
| 126 |
.IP "\fB\-C\fR, \fB\-\-copying\fR" 4 |
| 127 |
.IX Item "-C, --copying" |
| 128 |
Print copying permissions and exit. |
| 129 |
.SS "DEBUGGING OPTIONS" |
| 130 |
.IX Subsection "DEBUGGING OPTIONS" |
| 131 |
.IP "\fB\-v\fR, \fB\-\-\-valgrind\fR" 4 |
| 132 |
.IX Item "-v, ---valgrind" |
| 133 |
Let \f(CW\*(C`/usr/bin/valgrind\*(C'\fR run icewm. |
| 134 |
Thoroughly examines the execution of icewm. |
| 135 |
.IP "\fB\-g\fR, \fB\-\-\-catchsegv\fR" 4 |
| 136 |
.IX Item "-g, ---catchsegv" |
| 137 |
Let \f(CW\*(C`/usr/bin/catchsegv\*(C'\fR run icewm. |
| 138 |
Gives a backtrace if icewm segfaults. |
| 139 |
.SS USAGE |
| 140 |
.IX Subsection "USAGE" |
| 141 |
On startup icewm-session executes the following steps. |
| 142 |
From the file \fIenv\fR in the configuration directory |
| 143 |
it loads additional environment variables, if that file exists. |
| 144 |
Then it will start \fIicewmbg\fR to manage root background colors and images. |
| 145 |
It may also start \fIicesound\fR, if this was enabled at configuration time. |
| 146 |
Then \fIicewm\fR is started. |
| 147 |
.PP |
| 148 |
If there exists an executable script \fIstartup\fR in the configuration |
| 149 |
directory, it will be executed. It may contain commands to initialize X11 |
| 150 |
settings with \fIxset\fR, load keyboard configuration, start a compositing |
| 151 |
manager like \fIcompton\fR and load system tray applications. |
| 152 |
.PP |
| 153 |
When icewm exits, icewm-session will execute a \fIshutdown\fR script, |
| 154 |
if it exists in the configuration directory. |
| 155 |
When this finishes, icewm-session will terminate icewm, icewmbg |
| 156 |
and icesound. Finally, icewm-session will exit. |
| 157 |
.PP |
| 158 |
If the icewm process crashes then icewm-session will attempt to restart |
| 159 |
it. If two such crashes occur in a short period, then icewm-session will |
| 160 |
attempt to popup a dialog using either \fIyad\fR, \fIxmessage\fR, \fIkdialog\fR |
| 161 |
or \fIzenity\fR. This dialog presents a choice between restarting icewm, |
| 162 |
starting a terminal, or abort execution of icewm-session. |
| 163 |
.SS ENVIRONMENT |
| 164 |
.IX Subsection "ENVIRONMENT" |
| 165 |
.IP \fBICEWM_OPTIONS\fR 4 |
| 166 |
.IX Item "ICEWM_OPTIONS" |
| 167 |
A space separated list of options that will be added to the command |
| 168 |
line invocation of \fIicewm\fR. This can be set in the \fIenv\fR file. |
| 169 |
.SS "SEE ALSO" |
| 170 |
.IX Subsection "SEE ALSO" |
| 171 |
\&\fBicewm\fR\|(1), |
| 172 |
\&\fBicewm\-env\fR\|(5), |
| 173 |
\&\fBicewm\-shutdown\fR\|(5), |
| 174 |
\&\fBicewm\-startup\fR\|(5), |
| 175 |
\&\fBicewmbg\fR\|(1). |
| 176 |
.SS BUGS |
| 177 |
.IX Subsection "BUGS" |
| 178 |
Please report bugs at <https://github.com/ice\-wm/icewm/issues>. |
| 179 |
.SS AUTHOR |
| 180 |
.IX Subsection "AUTHOR" |
| 181 |
Brian Bidulock <mailto:[email protected]>. |
| 182 |
.PP |
| 183 |
See \fB\-\-copying\fR for full copyright notice and copying permissions. |
| 184 |
.SS LICENSE |
| 185 |
.IX Subsection "LICENSE" |
| 186 |
\&\fBIceWM\fR is licensed under the GNU Library General Public License. |
| 187 |
See the \fICOPYING\fR file in the distribution or use the \fB\-\-copying\fR flag |
| 188 |
to display copying permissions. |