source: x/wm/icewm.xml@ b1c2764d

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since b1c2764d was b1c2764d, checked in by Bruce Dubbs <bdubbs@…>, 18 months ago

Update to icewm-3.1.0.
  • Property mode set to 100644
File size: 17.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY icewm-download-http "https://github.com/ice-wm/icewm/archive/&icewm-version;/icewm-&icewm-version;.tar.gz">
8 <!ENTITY icewm-download-ftp " ">
9 <!ENTITY icewm-md5sum "2221e9f6e8472120f05db907b8485182">
10 <!ENTITY icewm-size "2.3 MB">
11 <!ENTITY icewm-buildsize "45 MB">
12 <!ENTITY icewm-time "0.3 SBU">
13]>
14
15<sect1 id="icewm" xreflabel="IceWM-&icewm-version;">
16 <?dbhtml filename="icewm.html" ?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>IceWM-&icewm-version;</title>
23
24 <indexterm zone="icewm">
25 <primary sortas="a-icewm">icewm</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to IceWM</title>
30
31 <para>
32 <application>IceWM</application> is a window manager with the goals of
33 speed, simplicity, and not getting in the user&apos;s way.
34 </para>
35
36 &lfs112_checked;
37
38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing="compact">
40 <listitem>
41 <para>
42 Download (HTTP): <ulink url="&icewm-download-http;"/>
43 </para>
44 </listitem>
45 <listitem>
46 <para>
47 Download (FTP): <ulink url="&icewm-download-ftp;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download MD5 sum: &icewm-md5sum;
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download size: &icewm-size;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Estimated disk space required: &icewm-buildsize;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated build time: &icewm-time;
68 </para>
69 </listitem>
70 </itemizedlist>
71
72 <bridgehead renderas="sect3">IceWM Dependencies</bridgehead>
73
74 <bridgehead renderas="sect4">Required</bridgehead>
75 <para role="required">
76 <xref linkend="cmake"/>,
77 <xref linkend="x-window-system"/>, and
78 <xref linkend="gdk-pixbuf-xlib"/>
79 </para>
80
81 <bridgehead renderas="sect4">Optional</bridgehead>
82 <para role="optional">
83 <xref linkend="asciidoc"/> (for regenerating the HTML documentation),
84 <xref linkend="fribidi"/> (for languages written right to left),
85 <xref linkend="imlib2"/>,
86 <xref linkend="librsvg"/>,
87 <xref linkend="libao"/>,
88 <xref linkend="libsndfile"/>, and
89 <xref linkend="alsa-lib"/> (for the experimental icesound program)
90 </para>
91
92 <para condition="html" role="usernotes">User Notes:
93 <ulink url="&blfs-wiki;/icewm"/></para>
94
95 </sect2>
96
97 <sect2 role="installation">
98 <title>Installation of IceWM</title>
99<!--
100 <note>
101 <para>
102 The tarball is compressed with <command>lzip</command>, and cannot be
103 processed with the <command>tar</command> program. It can be unpacked
104 with the <command>bsdtar</command> program from the libarchive
105 package.
106 </para>
107 </note>
108-->
109 <para>
110 Install <application>IceWM</application> by running the following
111 commands:
112 </para>
113
114<screen><userinput>mkdir build &amp;&amp;
115cd build &amp;&amp;
116
117cmake -DCMAKE_INSTALL_PREFIX=/usr \
118 -DCMAKE_BUILD_TYPE=Release \
119 -DCFGDIR=/etc \
120 -DENABLE_LTO=ON \
121 -DCONFIG_GDK_PIXBUF_XLIB=ON \
122 -DCONFIG_IMLIB2=OFF \
123 -DDOCDIR=/usr/share/doc/icewm-&icewm-version; \
124 .. &amp;&amp;
125make</userinput></screen>
126
127 <para>
128 This package does not have a working testsuite.
129 </para>
130
131 <para>
132 Now, as the <systemitem class="username">root</systemitem> user:
133 </para>
134<!--
135<screen role="root"><userinput>cp ../lib/IceWM.jpg lib &amp;&amp;
136make install &amp;&amp;
137rm /usr/share/xsessions/icewm.desktop</userinput></screen>
138-->
139<screen role="root"><userinput>make install</userinput></screen>
140
141 </sect2>
142
143 <sect2 role="commands">
144 <title>Command Explanations</title>
145
146 <para>
147 <parameter>-DENABLE_LTO=ON</parameter>: This option enables Link
148 Time Optimization and is required for this package.
149 </para>
150<!--
151 <para>
152 <command>rm /usr/share/xsessions/icewm.desktop</command>: The package
153 ships with both icewm.desktop and icewm-xsession.desktop. The former has
154 apparently been used in the past, but it will hang if used with a modern
155 desktop-manager<phrase revision='sysv'> such as
156 <xref linkend="lightdm"/></phrase>.
157 </para>
158
159 <para>
160 <command>cp ../lib/IceWM.jpg lib</command>: This instruction fixes an
161 install problem.
162 </para>
163-->
164 </sect2>
165
166 <sect2 role="configuration">
167 <title>Configuring IceWM</title>
168
169 <sect3 id="icewm-config">
170 <title>Config Files</title>
171
172 <para>
173 <filename>~/.icewm/keys</filename>,
174 <filename>~/.icewm/menu</filename>, and
175 <filename>~/.icewm/preferences</filename>, and
176 <filename>~/.icewm/toolbar</filename>, and
177 <filename>~/.icewm/winoptions</filename>. The default versions are
178 installed in <filename class="directory">/usr/share/icewm/</filename>
179 and will be used if you have not copied them to <filename
180 class="directory">~/.icewm</filename>.
181 </para>
182
183
184 <indexterm zone="icewm icewm-config">
185 <primary sortas="e-AA.icewm-keys">~/.icewm/keys</primary>
186 </indexterm>
187
188 <indexterm zone="icewm icewm-config">
189 <primary sortas="e-AA.icewm-menu">~/.icewm/menu</primary>
190 </indexterm>
191
192 <indexterm zone="icewm icewm-config">
193 <primary sortas="e-AA.icewm-preferences">~/.icewm/preferences</primary>
194 </indexterm>
195
196 <indexterm zone="icewm icewm-config">
197 <primary sortas="e-AA.icewm-toolbar">~/.icewm/toolbar</primary>
198 </indexterm>
199
200 <indexterm zone="icewm icewm-config">
201 <primary sortas="e-AA.icewm-winoptions">~/.icewm/winoptions</primary>
202 </indexterm>
203
204 </sect3>
205
206 <sect3>
207 <title>Configuration Information</title>
208
209 <para>
210 If <application>IceWM</application> is the only Window Manager you
211 want to use, you can start it with an <filename>.xinitrc</filename> file
212 in your home folder. Be sure to backup your current
213 <filename>.xinitrc</filename> before proceeding.
214 </para>
215
216 <indexterm zone="icewm icewm-config">
217 <primary sortas="e-AA.xinitrc">~/.xinitrc</primary>
218 </indexterm>
219
220<screen><userinput>echo icewm-session &gt; ~/.xinitrc</userinput></screen>
221
222 <para>
223 Now create the <application>IceWM</application> configuration files:
224 </para>
225
226<screen><userinput>mkdir -pv ~/.icewm &amp;&amp;
227cp -v /usr/share/icewm/keys ~/.icewm/keys &amp;&amp;
228cp -v /usr/share/icewm/menu ~/.icewm/menu &amp;&amp;
229cp -v /usr/share/icewm/preferences ~/.icewm/preferences &amp;&amp;
230cp -v /usr/share/icewm/toolbar ~/.icewm/toolbar &amp;&amp;
231cp -v /usr/share/icewm/winoptions ~/.icewm/winoptions</userinput></screen>
232
233 <para>
234 You can now edit these files to meet your requirements. In particular,
235 review the <filename>preferences</filename> file. You can use
236 <command>Logout -> Restart-IceWM</command> on the main menu to load
237 your changed preferences, but changes to the background only take
238 effect when <application>IceWM</application> is started.
239 </para>
240
241 <para>
242 At this point you can <emphasis>either</emphasis> modify the
243 traditional menu files to suit your requirements,
244 <emphasis>or</emphasis> use the newer
245 <command>icewm-menu-fdo</command> described later.
246 </para>
247
248 <para>
249 The syntax of the menus is explained in the help files, which you can
250 access by running <command>help</command> from the menu, but some of
251 the detail is out of date and the default selections in the menus (a
252 few old applications on the main menu, everything else on the
253 <command>Programs</command> menu) will benefit from being updated to
254 meet your needs. The following examples are provided to encourage you
255 to think about how you wish to organise your menus. Please note the
256 following:
257 </para>
258
259 <itemizedlist>
260 <listitem>
261 <para>
262 If a program listed in the menu has not been installed, it will
263 not appear when the menu is displayed. Similarly, if the program
264 exists but the specified icon does not, no icon will be displayed
265 in the menu.
266 </para>
267 </listitem>
268 <listitem>
269 <para>
270 The icons can be either <filename>.xpm</filename> or
271 <filename>.png</filename> files, and there is no need to specify
272 the extension. If the icon is located in the &quot;library&quot;
273 (<filename class="directory">/usr/share/icewm/icons</filename>)
274 there is no need to specify the path.
275 </para>
276 </listitem>
277 <listitem>
278 <para>
279 Most programs are in sub-menus, and the main menu will always
280 append entries for
281 <literal>windows, help, settings, logout</literal>
282 at the bottom.
283 </para>
284 </listitem>
285 <listitem>
286 <para>
287 An icon for <application>firefox</application> was copied to
288 the library directory and given a meaningful name. The icon for
289 <application>xine</application> is <filename>xine.xpm</filename>
290 which was installed to a pixmap directory.
291 </para>
292 </listitem>
293 <listitem>
294 <para>
295 The default toolbar is not altered.
296 </para>
297 </listitem>
298 </itemizedlist>
299
300 <para>
301 If you wish to use this traditional method, there are more examples in
302 previous releases of this book (e.g. BLFS-7.8).
303 </para>
304
305 <para>
306 <emphasis>Alternatively</emphasis>, you can create a menu which
307 conforms to the FDO Desktop Menu Specifications, where programs can be
308 found because they have a .desktop file in the XDG_DATA_HOME or
309 XDG_DATA_DIR directories. Unlike most windowmanagers,
310 <application>icewm</application> does not search for programs when the
311 menu is invoked, so if you take this route you will need to rerun the
312 following command after installing or removing programs:
313 </para>
314
315<screen><userinput>icewm-menu-fdo >~/.icewm/menu</userinput></screen>
316
317 <para>
318 If you wish to put icons on your desktop, you will need to install a
319 program such as <xref linkend="rox-filer"/> which provides a pinboard.
320 If you do that you will no longer be able to access the menu by
321 right-clicking on the desktop, you will have to use the
322 <application>IceWM</application> button. To ensure that the
323 <application>rox</application> pinboard is running, the following
324 commands will put it in the startup file:
325 </para>
326
327<screen role="nodump"><userinput>cat &gt; ~/.icewm/startup &lt;&lt; "EOF"
328<literal>rox -p Default &amp;
329EOF &amp;&amp;
330chmod +x ~/.icewm/startup</literal></userinput></screen>
331
332 <tip>
333 <para>
334 There are a number of keyboard shortcuts in
335 <application>IceWM</application>:
336 </para>
337 <itemizedlist>
338 <listitem>
339 <para>
340 Ctrl + Alt + F<replaceable>N</replaceable> : go to
341 <filename>tty<replaceable>N</replaceable></filename>.
342 </para>
343 </listitem>
344 <listitem>
345 <para>
346 Ctrl + Alt + <replaceable>N</replaceable> : go to desktop
347 number <replaceable>N</replaceable>
348 </para>
349 </listitem>
350 <listitem>
351 <para>
352 Ctrl + Alt + Space : open a box on the taskbar where you can
353 key in the name of an application and run it.
354 </para>
355 </listitem>
356 </itemizedlist>
357 </tip>
358
359 </sect3>
360
361 </sect2>
362
363 <sect2 role="content">
364 <title>Contents</title>
365
366 <segmentedlist>
367 <segtitle>Installed Programs</segtitle>
368 <segtitle>Installed Libraries</segtitle>
369 <segtitle>Installed Directories</segtitle>
370
371 <seglistitem>
372 <seg>icehelp, icesh, icesound, icewm, icewm-menu-fdo, icewm-menu-xrandr,
373 icewm-session, icewm-set-gnomewm, and icewmbg<!--, and icewmhint
374 icewmtray--></seg>
375 <seg>None</seg>
376 <seg>/usr/share/doc/icewm-&icewm-version;, /usr/share/icewm and ~/.icewm</seg>
377 </seglistitem>
378 </segmentedlist>
379
380 <variablelist>
381 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
382 <?dbfo list-presentation="list"?>
383 <?dbhtml list-presentation="table"?>
384
385 <varlistentry id="icehelp">
386 <term><command>icehelp</command></term>
387 <listitem>
388 <para>
389 is used to display the html manual
390 </para>
391 <indexterm zone="icewm icehelp">
392 <primary sortas="b-icehelp">icehelp</primary>
393 </indexterm>
394 </listitem>
395 </varlistentry>
396
397 <varlistentry id="icesh">
398 <term><command>icesh</command></term>
399 <listitem>
400 <para>
401 is a command-line window manager which can be used in
402 <filename>~/.icewm/startup</filename>
403 </para>
404 <indexterm zone="icewm icesh">
405 <primary sortas="b-icesh">icesh</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="icesound">
411 <term><command>icesound</command></term>
412 <listitem>
413 <para>
414 plays audio files on GUI events raised by IceWM
415 </para>
416 <indexterm zone="icewm icesound">
417 <primary sortas="b-icesound">icesound</primary>
418 </indexterm>
419 </listitem>
420 </varlistentry>
421
422 <varlistentry id="icewm-prog">
423 <term><command>icewm</command></term>
424 <listitem>
425 <para>
426 is the window manager
427 </para>
428 <indexterm zone="icewm icewm-prog">
429 <primary sortas="b-icewm">icewm</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="icewm-menu-fdo">
435 <term><command>icewm-menu-fdo</command></term>
436 <listitem>
437 <para>
438 can create a file in a format suitable for an IceWM menu, which
439 lists those programs currently installed in a layout conforming to
440 the FDO Desktop Menu Specifications
441 </para>
442 <indexterm zone="icewm icewm-menu-fdo">
443 <primary sortas="b-icewm-menu-fdo">icewm-menu-fdo</primary>
444 </indexterm>
445 </listitem>
446 </varlistentry>
447
448 <varlistentry id="icewm-menu-xrandr">
449 <term><command>icewm-menu-xrandr</command></term>
450 <listitem>
451 <para>
452 is a helper program used to manage multi-screen configurations
453 </para>
454 <indexterm zone="icewm icewm-menu-xrandr">
455 <primary sortas="b-icewm-menu-xrandr">icewm-menu-xrandr</primary>
456 </indexterm>
457 </listitem>
458 </varlistentry>
459
460 <varlistentry id="icewm-session">
461 <term><command>icewm-session</command></term>
462 <listitem>
463 <para>
464 runs icewmbg, icewm, icewmtray, startup, shutdown (i.e. startup
465 and shutdown scripts are run if installed)
466 </para>
467 <indexterm zone="icewm icewm-session">
468 <primary sortas="b-icewm-session">icewm-session</primary>
469 </indexterm>
470 </listitem>
471 </varlistentry>
472
473 <varlistentry id="icewm-set-gnomewm">
474 <term><command>icewm-set-gnomewm</command></term>
475 <listitem>
476 <para>
477 is a script to set the <application>GNOME</application> window
478 manager to <application>icewm</application> using
479 <application>gconftool</application>
480 </para>
481 <indexterm zone="icewm icewm-set-gnomewm">
482 <primary sortas="b-icewm-set-gnomewm">icewm-set-gnomewm</primary>
483 </indexterm>
484 </listitem>
485 </varlistentry>
486
487 <varlistentry id="icewmbg">
488 <term><command>icewmbg</command></term>
489 <listitem>
490 <para>
491 is used to set the background, according to the various
492 <literal>DesktopBackground</literal> settings in the preferences
493 </para>
494 <indexterm zone="icewm icewmbg">
495 <primary sortas="b-icewmbg">icewmbg</primary>
496 </indexterm>
497 </listitem>
498 </varlistentry>
499
500 <varlistentry id="icewmhint">
501 <term><command>icewmhint</command></term>
502 <listitem>
503 <para>
504 is used internally to provide hints to the user
505 </para>
506 <indexterm zone="icewm icewmhint">
507 <primary sortas="b-icewmhint">icewmhint</primary>
508 </indexterm>
509 </listitem>
510 </varlistentry>
511
512 <varlistentry id="icewmtray">
513 <term><command>icewmtray</command></term>
514 <listitem>
515 <para>
516 provides the tray
517 </para>
518 <indexterm zone="icewm icewmtray">
519 <primary sortas="b-icewmtray">icewmtray</primary>
520 </indexterm>
521 </listitem>
522 </varlistentry>
523
524 </variablelist>
525
526 </sect2>
527
528</sect1>
Note: See TracBrowser for help on using the repository browser.