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