source: x/wm/fluxbox.xml

trunk
Last change on this file was e8b3f50, checked in by Douglas R. Reno <renodr@…>, 2 months ago

Tags
  • Property mode set to 100644
File size: 12.1 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 fluxbox-download-http "&sourceforge-dl;/fluxbox/fluxbox-&fluxbox-version;.tar.xz">
8 <!ENTITY fluxbox-download-ftp " ">
9 <!ENTITY fluxbox-md5sum "b44afd10ee1e64624c23115aa51dcd55">
10 <!ENTITY fluxbox-size "772 KB">
11 <!ENTITY fluxbox-buildsize "101 MB">
12 <!ENTITY fluxbox-time "0.9 SBU">
13]>
14
15<sect1 id="fluxbox" xreflabel="Fluxbox-&fluxbox-version;">
16 <?dbhtml filename="fluxbox.html" ?>
17
18
19 <title>Fluxbox-&fluxbox-version;</title>
20
21 <indexterm zone="fluxbox">
22 <primary sortas="a-Fluxbox">Fluxbox</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Fluxbox</title>
27
28 <para>
29 The <application>Fluxbox</application> package contains a window
30 manager.
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="&fluxbox-download-http;"/>
40 </para>
41 </listitem>
42 <listitem>
43 <para>
44 Download (FTP): <ulink url="&fluxbox-download-ftp;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download MD5 sum: &fluxbox-md5sum;
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download size: &fluxbox-size;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Estimated disk space required: &fluxbox-buildsize;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated build time: &fluxbox-time;
65 </para>
66 </listitem>
67 </itemizedlist>
68
69 <bridgehead renderas="sect3">Fluxbox Dependencies</bridgehead>
70
71 <bridgehead renderas="sect4">Required</bridgehead>
72 <para role="required">
73 <xref linkend="x-window-system"/>
74 </para>
75
76 <bridgehead renderas="sect4">Optional</bridgehead>
77 <para role="optional">
78 <xref role="runtime" linkend="dbus"/> (runtime),
79 <xref linkend="fribidi"/>, and
80 <xref linkend="imlib2"/> (if you wish to use other image formats in
81 addition to XPM)
82 </para>
83
84 </sect2>
85
86 <sect2 role="installation">
87 <title>Installation of Fluxbox</title>
88
89 <para>
90 First, fix a build failure when building with gcc-11.1:
91 </para>
92
93<screen><userinput remap="pre">sed -i '/text_prop.value &gt; 0/s/&gt;/!=/' util/fluxbox-remote.cc</userinput></screen>
94
95 <para>
96 Install <application>Fluxbox</application> by running the following
97 commands:
98 </para>
99
100<screen><userinput>./configure --prefix=/usr &amp;&amp;
101make</userinput></screen>
102
103 <para>
104 This package does not have a working test suite.
105 </para>
106
107 <para>
108 Now, as the <systemitem class="username">root</systemitem> user:
109 </para>
110
111<screen role="root"><userinput>make install</userinput></screen>
112
113 </sect2>
114
115 <sect2 role="configuration">
116 <title>Configuring Fluxbox</title>
117
118 <sect3 id="fluxbox-config">
119 <title>Config Files</title>
120
121 <para>
122 <filename>~/.fluxbox/init</filename>,
123 <filename>~/.fluxbox/keys</filename>, and
124 <filename>~/.fluxbox/menu</filename>
125 </para>
126
127 <indexterm zone="fluxbox fluxbox-config">
128 <primary sortas="e-AA.fluxbox-init">~/.fluxbox/init</primary>
129 </indexterm>
130
131 <indexterm zone="fluxbox fluxbox-config">
132 <primary sortas="e-AA.fluxbox-keys">~/.fluxbox/keys</primary>
133 </indexterm>
134
135 <indexterm zone="fluxbox fluxbox-config">
136 <primary sortas="e-AA.fluxbox-menu">~/.fluxbox/menu</primary>
137 </indexterm>
138
139 </sect3>
140
141 <sect3>
142 <title>Configuration Information</title>
143
144 <para>
145 If <application>Fluxbox</application> is the only Window Manager
146 you want to use, you can start it with an <filename>.xinitrc</filename>
147 file in your home folder. Be sure to backup your
148 current <filename>.xinitrc</filename> before proceeding.
149 </para>
150
151 <indexterm zone="fluxbox fluxbox-config">
152 <primary sortas="e-AA.xinitrc">~/.xinitrc</primary>
153 </indexterm>
154
155<screen><userinput>echo startfluxbox &gt; ~/.xinitrc</userinput></screen>
156
157 <para>
158 Or alternatively, if you use a login manager like
159 <xref linkend="gdm"/> or <xref linkend="lightdm"/>,
160 and would like to be able to choose <application>Fluxbox</application>
161 at the login prompt, create a <filename>fluxbox.desktop</filename>
162 file. As <systemitem class="username">root</systemitem>:
163 </para>
164
165<screen role="root"><userinput>mkdir -pv /usr/share/xsessions &amp;&amp;
166cat &gt; /usr/share/xsessions/fluxbox.desktop &lt;&lt; "EOF"
167<literal>[Desktop Entry]
168Encoding=UTF-8
169Name=Fluxbox
170Comment=This session logs you into Fluxbox
171Exec=startfluxbox
172Type=Application</literal>
173EOF</userinput></screen>
174
175 <para>
176 If you didn't install <xref linkend="gdm"/> or <xref
177 linkend="lightdm"/> in <filename class='directory'>/usr</filename>,
178 then change that command to fit the prefix you chose.
179 </para>
180
181 <para>
182 Now create the <application>Fluxbox</application> configuration files:
183 </para>
184
185<screen><userinput>mkdir -v ~/.fluxbox &amp;&amp;
186cp -v /usr/share/fluxbox/init ~/.fluxbox/init &amp;&amp;
187cp -v /usr/share/fluxbox/keys ~/.fluxbox/keys</userinput></screen>
188
189 <para>
190 To generate the application menu, first you may wish to run
191 <command>fluxbox-generate_menu -h</command>, in order to choose any
192 <replaceable>&lt;user_options&gt;</replaceable>, then issue:
193 </para>
194
195<screen role="nodump"><userinput>cd ~/.fluxbox &amp;&amp;
196fluxbox-generate_menu <replaceable>&lt;user_options&gt;</replaceable></userinput></screen>
197
198 <para>
199 Alternately, copy a pregenerated menu:
200 </para>
201
202<screen><userinput>cp -v /usr/share/fluxbox/menu ~/.fluxbox/menu</userinput></screen>
203
204 <para>
205 Menu items are added by editing <filename>~/.fluxbox/menu</filename>.
206 The syntax is explained on the <command>fluxbox</command> man page.
207 </para>
208
209 <para>
210 If you want to use an image as your desktop background, copy the
211 theme you like into <filename class='directory'>~/.fluxbox</filename>.
212 Then add a line to make it use the correct image. In the following
213 command, change <replaceable>&lt;theme&gt;</replaceable> for the name
214 of the theme you want and change
215 <replaceable>&lt;/path/to/nice/image.ext&gt;</replaceable> to point to
216 the actual image you want to use, where <replaceable>ext</replaceable>
217 must be <quote>xpm</quote>, if <xref linkend="imlib2"/> is not installed
218 to allow other image formats.
219 </para>
220
221<screen role="nodump"><userinput>cp -r /usr/share/fluxbox/styles/&lt;theme&gt; ~/.fluxbox/theme &amp;&amp;
222
223sed -i 's,\(session.styleFile:\).*,\1 ~/.fluxbox/theme,' ~/.fluxbox/init &amp;&amp;
224
225[ -f ~/.fluxbox/theme ] &amp;&amp;
226echo "background.pixmap: &lt;/path/to/nice/image.ext&gt;" >> ~/.fluxbox/theme ||
227[ -d ~/.fluxbox/theme ] &amp;&amp;
228echo "background.pixmap: &lt;/path/to/nice/image.ext&gt;" >> ~/.fluxbox/theme/theme.cfg</userinput></screen>
229
230 <para>
231 In some locales the font specified in the theme may not contain the
232 needed characters. This results in menus with blank items. You can fix
233 this by editing <filename>~/.fluxbox/theme</filename> with a text
234 editor and altering it so that it names a suitable font.
235 </para>
236
237 </sect3>
238
239 </sect2>
240
241 <sect2 role="content">
242 <title>Contents</title>
243
244 <segmentedlist>
245 <segtitle>Installed Programs</segtitle>
246 <segtitle>Installed Libraries</segtitle>
247 <segtitle>Installed Directories</segtitle>
248
249 <seglistitem>
250 <seg>fluxbox, fbsetbg, fbsetroot, fluxbox-generate_menu, startfluxbox,
251 fbrun, fluxbox-remote, and fluxbox-update_configs</seg>
252 <seg>None</seg>
253 <seg>/usr/share/fluxbox and ~/.fluxbox</seg>
254 </seglistitem>
255 </segmentedlist>
256
257 <variablelist>
258 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
259 <?dbfo list-presentation="list"?>
260 <?dbhtml list-presentation="table"?>
261
262 <varlistentry id="fluxbox-prog">
263 <term><command>fluxbox</command></term>
264 <listitem>
265 <para>
266 is a window manager for <application>X11</application> based
267 on <application>Blackbox</application> 0.61.0
268 </para>
269 <indexterm zone="fluxbox fluxbox-prog">
270 <primary sortas="b-fluxbox">fluxbox</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="fbsetbg">
276 <term><command>fbsetbg</command></term>
277 <listitem>
278 <para>
279 is a utility that sets the background image. It requires one
280 of the following at runtime:
281 <command>Esetroot</command>, <command>wmsetbg</command>,
282 <xref linkend="feh-prog"/>, <command>hsetroot</command>,
283 <command>chbg</command>, <xref linkend="display"/>,
284 <command>qiv</command>, <command>xv</command>,
285 <command>xsri</command>, <command>xli</command>, or
286 <command>xsetbg</command>. It also requires
287 <xref linkend="which-prog"/> if <command>Esetroot</command> is
288 found
289 </para>
290 <indexterm zone="fluxbox fbsetbg">
291 <primary sortas="b-fbsetbg">fbsetbg</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="fbsetroot">
297 <term><command>fbsetroot</command></term>
298 <listitem>
299 <para>
300 is a utility to change root window appearance based on the
301 <application>Blackbox</application> application bsetroot
302 </para>
303 <indexterm zone="fluxbox fbsetroot">
304 <primary sortas="b-fbsetroot">fbsetroot</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="fluxbox-generate_menu">
310 <term><command>fluxbox-generate_menu</command></term>
311 <listitem>
312 <para>
313 is a utility that generates a menu by scanning your
314 <envar>PATH</envar>
315 </para>
316 <indexterm zone="fluxbox fluxbox-generate_menu">
317 <primary sortas="b-fluxbox-generate_menu">fluxbox-generate_menu</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="startfluxbox">
323 <term><command>startfluxbox</command></term>
324 <listitem>
325 <para>
326 is a session startup script that allows for command
327 executions prior to <command>fluxbox</command> starting
328 </para>
329 <indexterm zone="fluxbox startfluxbox">
330 <primary sortas="b-startfluxbox">startfluxbox</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334
335 <varlistentry id="fbrun">
336 <term><command>fbrun</command></term>
337 <listitem>
338 <para>
339 displays a run dialog window
340 </para>
341 <indexterm zone="fluxbox fbrun">
342 <primary sortas="b-fbrun">fbrun</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="fluxbox-remote">
348 <term><command>fluxbox-remote</command></term>
349 <listitem>
350 <para>
351 provides command line access to key commands for
352 <application>Fluxbox</application>
353 </para>
354 <indexterm zone="fluxbox fluxbox-remote">
355 <primary sortas="b-fluxbox-remote">fluxbox-remote</primary>
356 </indexterm>
357 </listitem>
358 </varlistentry>
359
360 <varlistentry id="fluxbox-update_configs">
361 <term><command>fluxbox-update_configs</command></term>
362 <listitem>
363 <para>
364 use to manage config files (reload, update, test)
365 </para>
366 <indexterm zone="fluxbox fluxbox-update_configs">
367 <primary sortas="b-fluxbox-update_configs">fluxbox-update_configs</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 </variablelist>
373
374 </sect2>
375
376</sect1>
Note: See TracBrowser for help on using the repository browser.