summaryrefslogtreecommitdiffstats
path: root/upstream/debian-bookworm/man1/icewm-session.1
blob: e2be9201efb6ec57fdbb018323d82f84e826b017 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ICEWM-SESSION 1"
.TH ICEWM-SESSION 1 "2023-02-05" "icewm\ 3.3.1" "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 "\s-1NAME\s0"
.IX Subsection "NAME"
.Vb 1
\& icewm\-session \- X.Org session manager provider with IceWM
.Ve
.SS "\s-1SYNOPSIS\s0"
.IX Subsection "SYNOPSIS"
\&\fBicewm-session\fR [\fI\s-1OPTIONS\s0\fR]
.SS "\s-1DESCRIPTION\s0"
.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 "\s-1OPTIONS\s0"
.IX Subsection "OPTIONS"
.SS "\s-1SPECIFIC OPTIONS\s0"
.IX Subsection "SPECIFIC OPTIONS"
.IP "\fB\-c\fR, \fB\-\-config=FILE\fR" 4
.IX Item "-c, --config=FILE"
Let IceWM load preferences from \fI\s-1FILE\s0\fR.
.IP "\fB\-t\fR, \fB\-\-theme=FILE\fR" 4
.IX Item "-t, --theme=FILE"
Let IceWM load the theme \fI\s-1FILE\s0\fR.
.IP "\fB\-i\fR, \fB\-\-icewm=FILE\fR" 4
.IX Item "-i, --icewm=FILE"
Use \fI\s-1FILE\s0\fR as the IceWM window manager.
.IP "\fB\-o\fR, \fB\-\-output=FILE\fR" 4
.IX Item "-o, --output=FILE"
Redirect all output to \fI\s-1FILE\s0\fR.
.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.
.SS "\s-1GENERAL OPTIONS\s0"
.IX Subsection "GENERAL OPTIONS"
.IP "\fB\-d\fR, \fB\-\-display\fR=\fI\s-1DISPLAY\s0\fR" 4
.IX Item "-d, --display=DISPLAY"
Use \fI\s-1DISPLAY\s0\fR to connect to the X server.
If this option is missing then \fI\s-1DISPLAY\s0\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 "\s-1DEBUGGING OPTIONS\s0"
.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 "\s-1USAGE\s0"
.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 "\s-1ENVIRONMENT\s0"
.IX Subsection "ENVIRONMENT"
.IP "\fB\s-1ICEWM_OPTIONS\s0\fR" 4
.IX Item "ICEWM_OPTIONS"
A space separated list of options which will be added to the command
line invocation of \fIicewm\fR. This can be set in the \fIenv\fR file.
.SS "\s-1SEE ALSO\s0"
.IX Subsection "SEE ALSO"
\&\fBicewm\fR\|(1),
\&\fBicewm\-env\fR\|(5),
\&\fBicewm\-shutdown\fR\|(5),
\&\fBicewm\-startup\fR\|(5),
\&\fBicewmbg\fR\|(1).
.SS "\s-1BUGS\s0"
.IX Subsection "BUGS"
Please report bugs at <https://github.com/bbidulock/icewm/issues>.
.SS "\s-1AUTHOR\s0"
.IX Subsection "AUTHOR"
Brian Bidulock <mailto:bidulock@openss7.org>.
.PP
See \fB\-\-copying\fR for full copyright notice and copying permissions.
.SS "\s-1LICENSE\s0"
.IX Subsection "LICENSE"
\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License.
See the \fI\s-1COPYING\s0\fR file in the distribution or use the \fB\-\-copying\fR flag
to display copying permissions.