source: x/wm/icewm.xml@ e7d893b

elogind
Last change on this file since e7d893b was e7d893b, checked in by DJ Lucas <dj@…>, 5 years ago

Merge to HEAD 21602.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/BOOK-elogind@21603 af4574ff-66df-0310-9fd7-8a98e5e911e0

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