icewm-session(1)

1ICEWM-SESSION(1)                 User Commands                ICEWM-SESSION(1)
2
3
4
5   NAME
6        icewm-session - X.Org session manager provider with IceWM
7
8   SYNOPSIS
9       icewm-session [OPTIONS]
10
11   DESCRIPTION
12       icewm-session is an implementation of a X.Org session manager and can
13       be run from a X11 session setup. It runs icewm as default window
14       manager and controls the life cycle of related support applications.
15
16   OPTIONS
17   SPECIFIC OPTIONS
18       -c, --config=FILE
19           Let IceWM load preferences from FILE.
20
21       -t, --theme=FILE
22           Let IceWM load the theme FILE.
23
24       -i, --icewm=FILE
25           Use FILE as the IceWM window manager.
26
27       -o, --output=FILE
28           Redirect all output to FILE.  A leading tilde or environment
29           variable is expanded.
30
31       -a, --alpha
32           Use a 32-bit visual for translucency.
33
34       -b, --nobg
35           Do not start icewmbg.
36
37       -n, --notray
38           Do not start icewmtray.  This is only applicable if IceWM was
39           explicitly configured to use an external icewmtray process.
40
41       -s, --sound
42           Also start icesound.
43
44   GENERAL OPTIONS
45       -d, --display=DISPLAY
46           Use DISPLAY to connect to the X server.  If this option is missing
47           then DISPLAY is read from the environment variable "DISPLAY".
48
49       --sync
50           Use a slower synchronous mode communication with the X11 server.
51
52       -h, --help
53           Give a list of all supported options and exit.
54
55       -V, --version
56           Print the program version and exit.
57
58       -C, --copying
59           Print copying permissions and exit.
60
61   DEBUGGING OPTIONS
62       -v, ---valgrind
63           Let "/usr/bin/valgrind" run icewm.  Thoroughly examines the
64           execution of icewm.
65
66       -g, ---catchsegv
67           Let "/usr/bin/catchsegv" run icewm.  Gives a backtrace if icewm
68           segfaults.
69
70   USAGE
71       On startup icewm-session executes the following steps.  From the file
72       env in the configuration directory it loads additional environment
73       variables, if that file exists.  Then it will start icewmbg to manage
74       root background colors and images.  It may also start icesound, if this
75       was enabled at configuration time.  Then icewm is started.
76
77       If there exists an executable script startup in the configuration
78       directory, it will be executed. It may contain commands to initialize
79       X11 settings with xset, load keyboard configuration, start a
80       compositing manager like compton and load system tray applications.
81
82       When icewm exits, icewm-session will execute a shutdown script, if it
83       exists in the configuration directory.  When this finishes, icewm-
84       session will terminate icewm, icewmbg and icesound. Finally, icewm-
85       session will exit.
86
87       If the icewm process crashes then icewm-session will attempt to restart
88       it. If two such crashes occur in a short period, then icewm-session
89       will attempt to popup a dialog using either yad, xmessage, kdialog or
90       zenity.  This dialog presents a choice between restarting icewm,
91       starting a terminal, or abort execution of icewm-session.
92
93   ENVIRONMENT
94       ICEWM_OPTIONS
95           A space separated list of options that will be added to the command
96           line invocation of icewm. This can be set in the env file.
97
98   SEE ALSO
99       icewm(1), icewm-env(5), icewm-shutdown(5), icewm-startup(5),
100       icewmbg(1).
101
102   BUGS
103       Please report bugs at <https://github.com/bbidulock/icewm/issues>.
104
105   AUTHOR
106       Brian Bidulock <mailto:bidulock@openss7.org>.
107
108       See --copying for full copyright notice and copying permissions.
109
110   LICENSE
111       IceWM is licensed under the GNU Library General Public License.  See
112       the COPYING file in the distribution or use the --copying flag to
113       display copying permissions.
114
115
116
117icewm 3.4.4                       2023-11-03                  ICEWM-SESSION(1)