source: x/wm/icewm.xml

trunk
Last change on this file was 06a19a4, checked in by Bruce Dubbs <bdubbs@…>, 4 weeks ago

Update to icewm-3.4.7.

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