source: x/wm/icewm.xml@ dd01bb01

12.0 12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since dd01bb01 was 6e7b9fd, checked in by Bruce Dubbs <bdubbs@…>, 11 months ago

Tag most of multimedia and icons plus icewm

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