Debian Codegraph @

upstream/fedora-44/man1/icewm-session.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.47)
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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "ICEWM-SESSION 1"
61 .TH ICEWM-SESSION 1 2026-01-16 "icewm\ 4.0.0" "User Commands"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SS NAME
67 .IX Subsection "NAME"
68 .Vb 1
69 \& icewm\-session \- X.Org session manager provider with IceWM
70 .Ve
71 .SS SYNOPSIS
72 .IX Subsection "SYNOPSIS"
73 \&\fBicewm\-session\fR [\fIOPTIONS\fR]
74 .SS DESCRIPTION
75 .IX Subsection "DESCRIPTION"
76 icewm\-session is an implementation of a X.Org session manager and can be
77 run from a X11 session setup. It runs \fBicewm\fR as default window manager
78 and controls the life cycle of related support applications.
79 .SS OPTIONS
80 .IX Subsection "OPTIONS"
81 .SS "SPECIFIC OPTIONS"
82 .IX Subsection "SPECIFIC OPTIONS"
83 .IP "\fB\-c\fR, \fB\-\-config=FILE\fR" 4
84 .IX Item "-c, --config=FILE"
85 Let IceWM load preferences from \fIFILE\fR.
86 .IP "\fB\-t\fR, \fB\-\-theme=FILE\fR" 4
87 .IX Item "-t, --theme=FILE"
88 Let IceWM load the theme \fIFILE\fR.
89 .IP "\fB\-i\fR, \fB\-\-icewm=FILE\fR" 4
90 .IX Item "-i, --icewm=FILE"
91 Use \fIFILE\fR as the IceWM window manager.
92 .IP "\fB\-o\fR, \fB\-\-output=FILE\fR" 4
93 .IX Item "-o, --output=FILE"
94 Redirect all output to \fIFILE\fR.
95 A leading tilde or environment variable is expanded.
96 .IP "\fB\-a\fR, \fB\-\-alpha\fR" 4
97 .IX Item "-a, --alpha"
98 Use a 32\-bit visual for translucency.
99 .IP "\fB\-b\fR, \fB\-\-nobg\fR" 4
100 .IX Item "-b, --nobg"
101 Do not start icewmbg.
102 .IP "\fB\-n\fR, \fB\-\-notray\fR" 4
103 .IX Item "-n, --notray"
104 Do not start icewmtray.
105 This is only applicable if IceWM was explicitly configured
106 to use an external icewmtray process.
107 .IP "\fB\-s\fR, \fB\-\-sound\fR" 4
108 .IX Item "-s, --sound"
109 Also start icesound.
110 .IP \fB\-\-replace\fR 4
111 .IX Item "--replace"
112 Replace an existing window manager.
113 .SS "GENERAL OPTIONS"
114 .IX Subsection "GENERAL OPTIONS"
115 .IP "\fB\-d\fR, \fB\-\-display\fR=\fIDISPLAY\fR" 4
116 .IX Item "-d, --display=DISPLAY"
117 Use \fIDISPLAY\fR to connect to the X server.
118 If this option is missing then \fIDISPLAY\fR
119 is read from the environment variable \f(CW\*(C`DISPLAY\*(C'\fR.
120 .IP \fB\-\-sync\fR 4
121 .IX Item "--sync"
122 Use a slower synchronous mode communication with the \fIX11\fR server.
123 .IP "\fB\-h\fR, \fB\-\-help\fR" 4
124 .IX Item "-h, --help"
125 Give a list of all supported options and exit.
126 .IP "\fB\-V\fR, \fB\-\-version\fR" 4
127 .IX Item "-V, --version"
128 Print the program version and exit.
129 .IP "\fB\-C\fR, \fB\-\-copying\fR" 4
130 .IX Item "-C, --copying"
131 Print copying permissions and exit.
132 .SS "DEBUGGING OPTIONS"
133 .IX Subsection "DEBUGGING OPTIONS"
134 .IP "\fB\-v\fR, \fB\-\-\-valgrind\fR" 4
135 .IX Item "-v, ---valgrind"
136 Let \f(CW\*(C`/usr/bin/valgrind\*(C'\fR run icewm.
137 Thoroughly examines the execution of icewm.
138 .IP "\fB\-g\fR, \fB\-\-\-catchsegv\fR" 4
139 .IX Item "-g, ---catchsegv"
140 Let \f(CW\*(C`/usr/bin/catchsegv\*(C'\fR run icewm.
141 Gives a backtrace if icewm segfaults.
142 .SS USAGE
143 .IX Subsection "USAGE"
144 On startup icewm\-session executes the following steps.
145 From the file \fIenv\fR in the configuration directory
146 it loads additional environment variables, if that file exists.
147 Then it will start \fIicewmbg\fR to manage root background colors and images.
148 It may also start \fIicesound\fR, if this was enabled at configuration time.
149 Then \fIicewm\fR is started.
150 .PP
151 If there exists an executable script \fIstartup\fR in the configuration
152 directory, it will be executed. It may contain commands to initialize X11
153 settings with \fIxset\fR, load keyboard configuration, start a compositing
154 manager like \fIcompton\fR and load system tray applications.
155 .PP
156 When icewm exits, icewm\-session will execute a \fIshutdown\fR script,
157 if it exists in the configuration directory.
158 When this finishes, icewm\-session will terminate icewm, icewmbg
159 and icesound. Finally, icewm\-session will exit.
160 .PP
161 If the icewm process crashes then icewm\-session will attempt to restart
162 it. If two such crashes occur in a short period, then icewm\-session will
163 attempt to popup a dialog using either \fIyad\fR, \fIxmessage\fR, \fIkdialog\fR
164 or \fIzenity\fR. This dialog presents a choice between restarting icewm,
165 starting a terminal, or abort execution of icewm\-session.
166 .SS ENVIRONMENT
167 .IX Subsection "ENVIRONMENT"
168 .IP \fBICEWM_OPTIONS\fR 4
169 .IX Item "ICEWM_OPTIONS"
170 A space separated list of options that will be added to the command
171 line invocation of \fIicewm\fR. This can be set in the \fIenv\fR file.
172 .SS "SEE ALSO"
173 .IX Subsection "SEE ALSO"
174 \&\fBicewm\fR\|(1),
175 \&\fBicewm\-env\fR\|(5),
176 \&\fBicewm\-shutdown\fR\|(5),
177 \&\fBicewm\-startup\fR\|(5),
178 \&\fBicewmbg\fR\|(1).
179 .SS BUGS
180 .IX Subsection "BUGS"
181 Please report bugs at <https://github.com/ice\-wm/icewm/issues>.
182 .SS AUTHOR
183 .IX Subsection "AUTHOR"
184 Brian Bidulock <mailto:[email protected]>.
185 .PP
186 See \fB\-\-copying\fR for full copyright notice and copying permissions.
187 .SS LICENSE
188 .IX Subsection "LICENSE"
189 \&\fBIceWM\fR is licensed under the GNU Library General Public License.
190 See the \fICOPYING\fR file in the distribution or use the \fB\-\-copying\fR flag
191 to display copying permissions.