~ubuntu-branches/ubuntu/trusty/fluxbox/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/asciidoc/fluxbox.txt

  • Committer: Package Import Robot
  • Author(s): Paul Tagliamonte
  • Date: 2010-08-12 21:16:02 UTC
  • mfrom: (0.1.1) (1.1.10)
  • Revision ID: package-import@ubuntu.com-20100812211602-3tsmzl9in5nmwz7z
Tags: 1.1.1+git20100807.0cc08f9-1
* debian/ dir has been cleaned out, complete repackage
  of most files.
* pulled new archive from git.fluxbox.org HEAD, saved as
  tar.gz.
* Added in fluxbox.* files from the old dfsg tree.
* Added in system.fluxbox-menu file from the old dfsg tree
* Added the source/format file to bump package source
  version from 1.0 to 3.0 (quilt). 
* Changed rules file to match the old dfsg setup so that
  fluxbox behaves nicely.
* Removed entries from copyright that no longer apply.
* Added theme based on Denis Brand ( naran )'s old theme.
* Added a background I whipped up.
* Changed compile flags to point to debian theme by default
* Adding a patch to have fluxbox use x-terminal-emulator
  over xterm. Closes: #591694 (LP: #580485)
* Adding a patch to allow titlebar-window dragging.
* Changed the flags in rules to pull from a script. This script
  lets us un-hardcode what theme is default. Be sure there
  is a theme pack!
* Added comments to my patches.
* Removing debian/docs, empty file.
* Fixing fluxbox.desktop to remove all the warnings from
  desktop-file-validate
* Fixing libtool issue by running an update before
  configure in the rules script.
* Added a compile flag script to auto-detect what platform
  we are running on, and apply the correct theme. This
  should solve Ubuntnu issues later on.
* adding in a get-orig-source rule
* fixing the upstream version number to pinpoint
  the commit ( thanks, lfaraone ).
* adding a rule for get-orig-source. ( thanks again,
  lfaraone ).
* Updated rules to actually allow us to do a build from it
* Removed Denis from the uploaders ( as per an email
  conversation )
* Removing madduck from the uploaders ( thanks for asking,
  lfaraone. ). Thanks for your hard work, madduck.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
fluxbox(1)
 
2
==========
 
3
Henrik Kinnunen <fluxgen@fluxbox.org>
 
4
v1.1.2, 18 February 2009
 
5
:man source:   fluxbox.txt
 
6
:man version:  {revision}
 
7
:man manual:   Fluxbox Manual  
 
8
 
 
9
NAME
 
10
----
 
11
fluxbox - A lightweight window manager for the X Windowing System
 
12
 
 
13
SYNOPSIS
 
14
--------
 
15
*fluxbox* [-rc 'rcfile']
 
16
          [-log 'logfile']
 
17
          [-display 'display']
 
18
          [-screen all|'scr','scr'...]
 
19
          [-verbose]
 
20
          [-sync]
 
21
 
 
22
*fluxbox* [-v | -version] |
 
23
          [-h | -help] |
 
24
          [-i | -info] |
 
25
          [-list-commands]
 
26
 
 
27
DESCRIPTION
 
28
-----------
 
29
*fluxbox(1)* is a window manager. As such it provides configurable window
 
30
decorations, a root menu to launch applications and a toolbar that shows the
 
31
current workspace name, a set of application names and the current time. There
 
32
is also a workspace menu to add or remove workspaces.
 
33
 
 
34
Fluxbox can iconify (or minimize) windows to the toolbar One click and they
 
35
reappear. A double-click on the titlebar of the window will 'shade' it; i.e. the
 
36
window will disappear, and only the titlebar will remain visible.
 
37
 
 
38
There are also two areas commonly used by small applets: the `slit' can be used
 
39
to dock small applications; e.g. most of the ``bbtools'' and ``Window Maker
 
40
dockapps'' can use the slit, and the `systray' which lives in the toolbar
 
41
supports standard system tray icons provided by some applications.
 
42
 
 
43
Fluxbox uses its own graphics class to render its images on the fly. By using
 
44
style files, you can determine in great detail how your desktop looks.
 
45
fluxbox styles are compatible with those of Blackbox 0.65 or earlier versions,
 
46
so users migrating can still use their current favourite themes.
 
47
 
 
48
Most of the default keyboard and mouse button actions mentioned in this manual
 
49
can be changed and configured in the `keys' file.  This powerful configuration
 
50
file can also be used to automate almost any action you may want to perform,
 
51
from launching applications to moving windows around the screen.  See
 
52
*fluxbox-keys(5)* for details.
 
53
 
 
54
Fluxbox can also remember certain attributes of individual application
 
55
windows and restore these settings the next time the window opens. See
 
56
the *fluxbox-apps(5)* for details.
 
57
 
 
58
Fluxbox supports the majority of the Extended Window Manager Hints (EWMH)
 
59
specification, as well as numerous other Window Hinting standards. This
 
60
allows all compliant window managers to provide a common interface to
 
61
standard features used by applications and desktop utilities.
 
62
 
 
63
OPTIONS
 
64
-------
 
65
*-display* 'display'::
 
66
    Start fluxbox on the specified display. Programs started by fluxbox
 
67
    will share the DISPLAY environment variable also.
 
68
*-h*, *-help*::
 
69
    Display command line options.
 
70
*-i*, *-info*::
 
71
    Display useful information concerning the defaults and compiled-in
 
72
    options.
 
73
*-log* 'logfile'::
 
74
    Starting fluxbox with this option will designate a file in which you
 
75
    want to log events to.
 
76
*-rc* 'rcfile'::
 
77
    Use a different config file other than the default *\~/.fluxbox/init*.
 
78
*-v*, *-version*::
 
79
    The version of fluxbox installed.
 
80
*-screen* all|'scr','scr'...::
 
81
    Run on specified screens only or all (by default).
 
82
*-verbose*::
 
83
    Print more information in process.
 
84
*-sync*::
 
85
    Synchronize with the X server for debugging.
 
86
*-list-commands*::
 
87
    Lists all available internal commands.
 
88
 
 
89
STARTING FLUXBOX
 
90
----------------
 
91
*fluxbox(1)* comes with a program called *startfluxbox(1)* usually located
 
92
wherever you installed fluxbox. This script provides you with many options and
 
93
variables that can be set when starting fluxbox. To actually call fluxbox and
 
94
begin using it, you should place ``exec startfluxbox'' in your *\~/.xinitrc* as
 
95
the last executed command. This is assuming that the location of *fluxbox(1)*
 
96
and *startfluxbox(1)* are in your shell's $PATH. Also note that you may need to
 
97
create the *\~/.xinitrc* file or your setup may use *\~/.xsession* instead,
 
98
depending on your X setup. Some X login managers like *gdm(1)* or *kdm(1)* may
 
99
simply provide a ``Fluxbox'' session for you without having to alter any
 
100
settings.
 
101
 
 
102
By using fluxbox -i you'll see the defaults used by *fluxbox(1)*. These are what
 
103
fluxbox looks for upon startup. In the list of ``Defaults:'' you'll see a menu
 
104
file location, this is where you can provide a system-wide menu file for your
 
105
users.
 
106
 
 
107
On exit or restart, fluxbox will save user defaults in the file
 
108
*\~/.fluxbox/init*. Resources in this file can also be edited by hand, see the
 
109
*RESOURCES* section for more details. *fluxbox(1)* also has many tools to edit
 
110
these; look through the main menu once fluxbox has started to find different
 
111
ways of managing your session.
 
112
 
 
113
USING FLUXBOX
 
114
-------------
 
115
When using fluxbox for the first time, users who are more accustomed to
 
116
full desktop environments such as KDE or Gnome may be a little surprised by
 
117
the minimal screen content. fluxbox is designed to be fast and powerful, so it
 
118
may take a bit of getting used to -- however, the rewards are worthwhile.
 
119
 
 
120
In this section, we'll give a quick summary of the common things. However, we
 
121
recommend that you consult the referenced sections of this manual to further
 
122
develop your understanding of what you can do with fluxbox.
 
123
 
 
124
Root Window (Main)
 
125
~~~~~~~~~~~~~~~~~~
 
126
Looking at the fluxbox desktop immediately after startup you'll generally see
 
127
only one thing: the toolbar. If you right-click (mouse button 3) somewhere on
 
128
the desktop, you can access the Root Menu. A middle-click (mouse button 2) on
 
129
the desktop shows you the Workspace Menu.
 
130
 
 
131
Root Menu and Workspace Menu
 
132
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
133
From the RootMenu you can launch applications and configure fluxbox. The
 
134
WorkspaceMenu shows all windows and on which workspaces they are. See
 
135
section *MENUS* on how to customize these menus.
 
136
 
 
137
Toolbar
 
138
~~~~~~~
 
139
The toolbar contains any combination of the following tools, by default in this
 
140
order:
 
141
 
 
142
- *Workspace Name*:
 
143
    Name of the current visible workspace
 
144
- *Workspace Arrows*:
 
145
    Previous/Next Workspace
 
146
- *Iconbar*:
 
147
    List of windows managed by fluxbox
 
148
- *Window Arrows*:
 
149
    Previous/Next Application Window
 
150
- *System Tray*:
 
151
    Area for applets
 
152
- *Clock*:
 
153
    Date and Time
 
154
 
 
155
The contents and behavior of the toolbar can be configured, see the *TOOLBAR*
 
156
section for details.
 
157
 
 
158
Slit
 
159
~~~~
 
160
Initially you won't be able to see the slit. It is there, but it isn't
 
161
being used yet, which confuses some people initially. Think of it as a dock
 
162
where you can place smaller programs. If you've looked at any screenshots on the
 
163
official fluxbox web site, you will have noticed some small programs on the edge
 
164
of some of the screens. These were more than likely docked programs in the slit.
 
165
To learn more about the slit, we have an entire *SLIT* section below that goes
 
166
into detail about the options you have.
 
167
 
 
168
Layers
 
169
~~~~~~
 
170
fluxbox manages the following layers (from highest to lowest):
 
171
 
 
172
* Above Dock
 
173
* Dock
 
174
* Top
 
175
* Normal
 
176
* Bottom
 
177
* Desktop
 
178
 
 
179
Windows on a higher layer will always appear above those on a lower one. These
 
180
layers can be used on application windows, the slit or the toolbar. You can
 
181
assign applications to a certain layer by specifying it in the `apps' file or
 
182
through the WindowMenu. We discuss the `apps' file in *fluxbox-apps(5)*. We
 
183
discuss the WindowMenu in the *MENUS* section. We discuss layers in more detail
 
184
in the *LAYERS* section.
 
185
 
 
186
Focus Model
 
187
~~~~~~~~~~~
 
188
The window that has the focus is the one that receives key and mouse
 
189
events. The focus model is selectable via the Configuration menu located
 
190
in the root menu. We'll discuss the different types of focus below in the
 
191
*FOCUS MODEL* section.
 
192
 
 
193
Windows
 
194
~~~~~~~
 
195
A left-click (mouse button 1) on any part of the window's border will
 
196
raise it. Dragging then moves the window to another part of the desktop. A right
 
197
click and drag on the border resizes the window. Dragging the resize grips at
 
198
the left and right bottom corners also will resize the window. Middle clicking
 
199
on a border or titlebar will immediately lower the window. Right clicking on the
 
200
titlebar opens the Window menu. The commands unique to this menu are discussed
 
201
in detail in the *Window Menu* section.
 
202
 
 
203
Tabs
 
204
~~~~
 
205
fluxbox allows windows to be `grouped' by middle clicking and holding on a
 
206
window's tab and dragging it onto another window. This `tabbing' allows you to
 
207
put multiple applications in one location on the desktop and do several
 
208
operations (for example, moving or resizing) to all windows in the group. By
 
209
default, tabs are located just above the window, but they may be embedded in the
 
210
titlebar or moved to other locations on the outside of the window. Configuration
 
211
is discussed in TAB OPTIONS section.
 
212
 
 
213
You can also set up automatic grouping using the `apps' file. See *GROUP
 
214
SECTIONS* in *fluxbox-apps(5)* for details.
 
215
 
 
216
Key Bindings
 
217
~~~~~~~~~~~~
 
218
There are a number of key bindings set up by default, which can be configured
 
219
and extended to just about anything you can imagine with the keyboard.  See
 
220
*fluxbox-keys(5)* for details on how to do this.
 
221
 
 
222
The default bindings set up by fluxbox are as follows:
 
223
 
 
224
Mouse clicks on the empty desktop:
 
225
 
 
226
- *Left-click* (Button 1): hides all fluxbox menus
 
227
- *Middle-click* (Button 2): shows the Workspace Menu
 
228
- *Right-click* (Button 3): shows the Root Menu
 
229
- *Scroll wheel* (Buttons 4 and 5): jump to the previous/next workspace
 
230
 
 
231
Mouse gestures on a window:
 
232
 
 
233
- *ALT+Drag Left-click* anywhere on a window moves the window.
 
234
- *ALT+Drag Right-click* anywhere on a window resizes the window.
 
235
- *ALT+Middle-click* anywhere on a window lowers the current window.
 
236
 
 
237
Mouse gestures on a window's titlebar:
 
238
 
 
239
- *CTRL+Drag Left-click* on a window's titlebar lets you drag to attach the
 
240
  window to another's tab group
 
241
- *Double Left-click* on a window's titlebar shades the window
 
242
- *Middle-click* on a window's titlebar lowers the window
 
243
- *Right-click* on a window's titlebar pops up the *Window Menu*
 
244
 
 
245
Mouse gestures on the toolbar:
 
246
 
 
247
- *Scroll wheel* on the toolbar cycles through windows
 
248
 
 
249
Keyboard bindings:
 
250
 
 
251
- *ALT+Tab* / *ALT+Shift+Tab*: Cycle through windows
 
252
- *WIN+Tab* / *WIN+Shift+Tab*: Cycle through tabs
 
253
- *Win+1* -> *Win+9*: Select the 1st -> 9th tab in the current window
 
254
- *ALT+F1*: Run *xterm(1)* to open a new terminal
 
255
- *ALT+F2*: Run *fbrun(1)* for a small ``run program'' dialog
 
256
- *ALT+F4*: Close the current window
 
257
- *ALT+F5*: Kill the current window (like *xkill(1)*)
 
258
- *ALT+F9*: Minimize (iconify) the current window
 
259
- *ALT+F10*: Maximize the current window
 
260
- *ALT+F11*: Full-screen the current window
 
261
- *ALT+Space*: Open the *Window Menu*
 
262
- *CTRL+ALT+Del*: Exit fluxbox (log out)
 
263
- *CTRL+ALT+Left* / *CTRL+ALT+Right*: Go to the previous/next workspace
 
264
- *WIN+Left* / *WIN+Right*: Send the current window to the previous/next
 
265
  workspace, but remain on this workspace
 
266
- *CTRL+WIN+Left* / *CTRL+WIN+Right*: Take the current window to the previous/next
 
267
  workspace, and switch to that workspace
 
268
- *CTRL+F1* -> *CTRL+F12*: Switch to the 1st -> 12th workspace
 
269
- *WIN+F1* -> *WIN+F12*: Send the current window to a specific workspace
 
270
- *CTRL+WIN+F1* -> *CTRL+WIN+F12*: Take the current window to a specific workspace
 
271
 
 
272
MENUS
 
273
-----
 
274
fluxbox provides a popup menu facility that is used by a few different types of
 
275
native menus.
 
276
 
 
277
When a menu is open, you can click on items with the mouse to activate them.
 
278
Some special menu items react slightly differently depending on the mouse button
 
279
you use, but normally you will want to use a left-click (button 1).
 
280
 
 
281
You can also use the the keyboard arrow key to navigate, or even type the first
 
282
few letters of the item's label to select it, and ``enter'' to activate the
 
283
item.
 
284
 
 
285
Normally activating a menu item should close the menu. You can also right-click
 
286
the title are of a menu or press ``esc'' to close it without activating an item.
 
287
 
 
288
Root Menu
 
289
~~~~~~~~~
 
290
The root menu is where you can launch commonly-used applications and change
 
291
different aspects of fluxbox by simply clicking on a menu item. By default it is
 
292
opened by a right-click on the empty area of the desktop.
 
293
 
 
294
The contents of this menu can be configured, see *fluxbox-menu(5)* for details.
 
295
 
 
296
The default menu, which is created by the ``fluxbox-generate_menu'' command,
 
297
contains menus for installed applications, as well as a special ``Fluxbox menu''
 
298
item with the items detailed below:
 
299
 
 
300
*Configure*::
 
301
    The next level under this menu is where you can set certain resources and
 
302
    really begin to customize the look and feel of your desktop. See the
 
303
         *Configure Menu* section below for more details.
 
304
 
 
305
*System Styles*::
 
306
         This is where the standard styles are listed. You can select one of these by
 
307
         clicking on it, and it will be applied immediately.  System styles are
 
308
         located in *@pkgdatadir@/styles/* upon a default install.  Remember that you
 
309
         can confirm this with fluxbox -i.
 
310
 
 
311
*User Styles*:::
 
312
         This is where your custom styles are listed. It will list any styles from
 
313
         *\~/.fluxbox/styles/*, which may be styles you grab from the Internet, or
 
314
         your own custom styles, provided you follow the standards described in
 
315
         *fluxbox-style(5)*.
 
316
 
 
317
*Workspace List*:::
 
318
    This is the same as the *Workspace Menu* detailed below.
 
319
 
 
320
*Tools*:::
 
321
    Listed here are different tools that you can use. You can rename your
 
322
    workspace, run programs from a command line or regenerate your menu.
 
323
 
 
324
*Window Managers*:::
 
325
    Allows you to switch your window manager. (Only listed if you have other
 
326
    window managers/desktop environments installed.)
 
327
 
 
328
*Lock Screen*:::
 
329
    Locks the screen, if a suitable locking program has been detected.
 
330
 
 
331
*Fluxbox Command*:::
 
332
    A little Commandline will popup where you can enter a fluxbox command. These
 
333
         commands are the same as those detailed in *fluxbox-keys(5)*.
 
334
 
 
335
*Reload config*:::
 
336
    Use this to reload the fluxbox configuration files. You must do this after
 
337
         editing the `keys' file, `init' file, or the current style.
 
338
 
 
339
*Restart*:::
 
340
    Restart the whole darn thing. This starts a completely new fluxbox process,
 
341
    rereads files and redraws all graphical elements. Running applications will
 
342
    remain open, however, and restored to the same workspaces they were
 
343
         previously in once fluxbox returns.
 
344
 
 
345
*Exit*:::
 
346
    Exits fluxbox, which in turn either shuts down the X Window server or
 
347
         returns you to the graphical login screen.
 
348
 
 
349
Configuration Menu
 
350
~~~~~~~~~~~~~~~~~~
 
351
This menu offers the opportunity to set up fluxbox. It contains many options
 
352
which can be altered manually in the `init' file, but this is an easier and
 
353
faster way to change the most common settings.
 
354
 
 
355
All changes take effect immediately.
 
356
 
 
357
*Focus Model*:::
 
358
         Lets you configure the window focus model. For details, see *FOCUS MODEL*,
 
359
         below.
 
360
 
 
361
*Maximize Options*:::
 
362
Lets you configure what happens when you maximize a window. The four
 
363
options are:
 
364
+
 
365
--
 
366
        *Full Maximization*:;;
 
367
                Normally, a maximized window will not overlap the toolbar, slit, or any
 
368
                docked windows (like panels). Enabling this option allows maximized
 
369
                windows to be as large as the actual screen resolution.
 
370
        *Ignore Resize Increment*:;;
 
371
                Normally, terminal windows specify a ``resize increment'' which mean
 
372
                fluxbox will only resize the window to an even multiple of the character
 
373
                size. Enabling this option will ignore this specification when maximizing.
 
374
        *Disable Moving* / *Disable Resizing*:;;
 
375
                Normally, maximized windows can still be moved and resized. Enabling these
 
376
                options prevents these behaviour.
 
377
--
 
378
 
 
379
*Tab Options*:::
 
380
    Lets you configure the properties of tabs. Detailed in *TAB OPTIONS*,
 
381
    below.
 
382
 
 
383
*Slit*:::
 
384
    This menu can also be found by right-clicking the slit (if visible). Find more
 
385
    information about this menu's options in the *Slit Menu* section, below.
 
386
 
 
387
*Toolbar*:::
 
388
    This menu can also be found by right-clicking any non-icon part of the
 
389
         toolbar. Find more information about this menu's options in the *Toolbar
 
390
         Menu* section, below.
 
391
 
 
392
*Transparency*:::
 
393
This sets the default transparency for a focused windows, unfocused window and
 
394
the menu.  Use the left mouse button to decrease and the right mouse button to
 
395
increase the value. 0 is invisible, 255 is not transparent at all.
 
396
+
 
397
The transparency of individual application windows can be overridden in the
 
398
`apps' file (*fluxbox-apps(5)*).
 
399
+
 
400
The *Force Pseudo Transparency* option will force fluxbox to ignore the
 
401
xcomposite extension and use pseudo-transparency instead of true transparency.
 
402
Note: When pseudo-transparency is on, the transparency values here only affect
 
403
titlebars, not window contents.
 
404
 
 
405
*Opaque Window Moving*:::
 
406
    If enabled, you will see the window content while dragging it. Otherwise
 
407
    only an outline of the window will be shown.
 
408
 
 
409
*Workspace Warping*:::
 
410
    If enabled, you can drag windows from one workspace to another. The previous
 
411
         workspace is to the left, the next workspace is to the right.
 
412
 
 
413
Window Menu
 
414
~~~~~~~~~~~
 
415
The Window menu is displayed when you right click on the titlebar of a window.
 
416
 
 
417
To customize this menu, see the *WINDOW MENU* section of *fluxbox-menu(5)*.
 
418
 
 
419
By default, this menu contains:
 
420
 
 
421
*Shade*:::
 
422
    Shade the window (display the titlebar only).
 
423
 
 
424
*Stick*:::
 
425
    (Un)Stick window. A `stuck' window will always be displayed on all
 
426
    workspaces.
 
427
 
 
428
*Send To...*:::
 
429
    Send window to another workspace. When you select the workspace with
 
430
    a middle click, fluxbox will send you along with the application to
 
431
    the selected workspace.
 
432
 
 
433
*Maximize*:::
 
434
    (Un)Maximize window. Depending on your toolbar and slit
 
435
    configuration, maximize may cover them. You can use the different
 
436
    mouse buttons for different aspects of maximize function.
 
437
 
 
438
    * Button 1  (Un)Maximize as normal.
 
439
    * Button 2  (Un)Maximize window vertically.
 
440
    * Button 3  (Un)Maximize window horizontally.
 
441
 
 
442
*Iconify*:::
 
443
         Iconify (or minimize) a window. The `icon' can be found in the Icons submenu
 
444
         of the workspace menu as well as in the toolbar (if a Toolbar mode showing
 
445
         Icons is selected).
 
446
 
 
447
*Raise*:::
 
448
    Raise the window above all others in the same layer.
 
449
 
 
450
*Lower*:::
 
451
    Lower the window below all others in the same layer.
 
452
 
 
453
*Layer...*:::
 
454
    Change the layer of this window. See *LAYERS* for more details.
 
455
 
 
456
*Transparency*:::
 
457
    Change this window's transparency, overriding the defaults from the
 
458
         *Configuration Menu*.
 
459
 
 
460
*Remember...*:::
 
461
Specify which window settings should be stored in the `apps' file and
 
462
resumed the next time this window is opened. 
 
463
+
 
464
Specifically the setting you may store are:
 
465
+
 
466
--
 
467
*Workpace:*;;
 
468
        Open this in the same workspace as where the window currently resides.
 
469
*Jump to workspace:*;;
 
470
        When *Workspace* is selected, fluxbox will jump to the appropriate workspace
 
471
        when this window is opened there. If not selected, the window will open in
 
472
        the background.
 
473
*Head*:;;
 
474
        For xinerama users only, start this window on the current head (or screen).
 
475
*Dimensions*:;;
 
476
        Record the current window height and width.
 
477
*Position*:;;
 
478
        Record the current X and Y coordinates of the window.
 
479
*Sticky*:;;
 
480
        Record whether the window is on all desktops, or not.
 
481
*Decorations*:;;
 
482
        Record the current set of decorations (title bar, grips, tabs, etc) on the window.
 
483
*Shaded*:;;
 
484
        Record whether the window is shaded (or rolled-up) or not.
 
485
*Minimized*:;;
 
486
        Record whether the window is iconified (or minimized) or not.
 
487
*Maximized*:;;
 
488
        Record whether the window is maximized or not.
 
489
*Fullscreen*:;;
 
490
        Record whether the window is in fullscreen mode or not.
 
491
*Transparency*:;;
 
492
        Record the current *Transparency* settings.
 
493
*Layer*:;;
 
494
        Record the current layer.
 
495
*Save on close*:;;
 
496
        If selected, any of the above items which are also selected will be updated
 
497
        with the window's current values as it is closed.
 
498
 
 
499
--
 
500
+
 
501
These are is covered in more detail in *fluxbox-apps(5)*.
 
502
 
 
503
*Close*:::
 
504
    Close the application softly.
 
505
 
 
506
*Kill*:::
 
507
    Kill the window's parent process, like *xkill(1)*.
 
508
 
 
509
Workspace Menu
 
510
~~~~~~~~~~~~~~
 
511
The workspace menu can be found, by default, by middle-clicking on the
 
512
background. This menu contains entries to explore the currently defined
 
513
workspaces, windows, and add/remove/rename workspaces.
 
514
 
 
515
*Icons*:::
 
516
        This menu shows any iconified (or, minimized) windows. Clicking on a window
 
517
        in this menu will raise it on the current workspace.
 
518
 
 
519
'Workspaces':::
 
520
        The next section provides one submenu per workspace. Middle-clicking on a
 
521
        workspace name will take you to that workspace. The submenu contains a list
 
522
        of all open windows on that workspace. Clicking on a window name will take
 
523
        you to that window and raise it, changing the active workspace if necessary.
 
524
 
 
525
*New Workspace*:::
 
526
        This entry adds a new workspace to the end of the list of current workspaces.
 
527
 
 
528
*Edit current workspace name*:::
 
529
        Pops up a dialog to enter a new name for the current workspace.
 
530
 
 
531
*Remove Last*:::
 
532
        Remove the last workspace in the list. Any windows curretly open there will
 
533
        be sent to the next-to-last workspace.
 
534
 
 
535
TOOLBAR
 
536
-------
 
537
The toolbar is a small area to display information like a clock, workspace name,
 
538
a system tray or a taskbar (iconbar) that can contain the running programs. The
 
539
color, look, font etc. is defined in the *STYLE*.
 
540
 
 
541
The tools in the toolbar can be enabled/disabled in the `init' file with the
 
542
*session.screen0.toolbar.tools* resource. See the *RESOURCES* section for
 
543
details on how to alter this value.
 
544
 
 
545
The possible tools are:
 
546
 
 
547
*Clock*:::
 
548
    This will show an area to display a clock and the date according to the
 
549
    format specification listed in "man strtftime"
 
550
 
 
551
*Iconbar*:::
 
552
    This is the area that contains all windows (all running applications, all
 
553
    minimized windows or maybe no window, all depending on the Toolbar
 
554
    Settings).
 
555
 
 
556
*Systemtray*:::
 
557
    The Systemtray can hold applications that are made to use it.
 
558
 
 
559
*WorkspaceName*:::
 
560
    This displays the name of the current workspace.
 
561
 
 
562
*PrevWorkspace*:::
 
563
    This displays an arrow that allows to switch to the workspace left of the
 
564
    current one.
 
565
 
 
566
*NextWorkspace*:::
 
567
    This displays an arrow that allows to switch to the workspace right of the
 
568
    current one.
 
569
 
 
570
*PrevWindow*:::
 
571
    This displays an arrow that switches focus to the previous visible window on
 
572
    the current workspace.
 
573
 
 
574
*NextWindow*:::
 
575
    This displays an arrow that switches focus to the next visible window on the
 
576
    current workspace.
 
577
 
 
578
Other aspects of the toolbar can be configured in two ways: through the toolbar
 
579
menu, which is accessible in the Configuration part of the RootMenu or with a
 
580
right click on the edge the toolbar, or by editing the init file (see the
 
581
*RESOURCES* section for more information about that).
 
582
 
 
583
Toolbar Menu
 
584
~~~~~~~~~~~~
 
585
This menu can be opened by right-clicking on the toolbar (though not on a
 
586
window's name in the iconbar), or from the *Configuration Menu*.
 
587
 
 
588
All changes take effect immediately. Here are the settings:
 
589
 
 
590
*Visible*:::
 
591
    Sets the toolbar either to visible or invisible.
 
592
 
 
593
*Auto hide*:::
 
594
    If this is enabled the toolbar will disappear after a defined time when the
 
595
    mouse pointer leaves the toolbar. It will slide in when the cursor hits the
 
596
    remaining edge of the toolbar. See the *session.autoRaiseDelay* resource for
 
597
         the delay time.
 
598
 
 
599
*Toolbar width percentage*:::
 
600
         Sets the width of the toolbar in a percentage of your total screen size. Use
 
601
         the left mouse button to decrease and the right mouse-button to increase the
 
602
         value. The value can be from 1-100.
 
603
 
 
604
*Maximize Over*:::
 
605
         Enabling this option will allow windows to maximize over the toolbar.  With
 
606
         this switched on they will only expand to the edge of the bar.  This option
 
607
         may be overridden by the ``Full Maximization'' from the *Configuration
 
608
         Menu*.  If that option is enabled, this option will have no effect..
 
609
 
 
610
*Layer...*:::
 
611
    This sets the layer on which the toolbar is set. With this you can set the
 
612
    toolbar to "Always on top".
 
613
 
 
614
*Placement*:::
 
615
    Sets the toolbar to any edge of the screen, either centered or aligned with
 
616
    a corner.
 
617
 
 
618
*Alpha*:::
 
619
    This sets the alpha value for the toolbar. Use the left mouse button to
 
620
    decrease and the right mouse button to increase the value. 0 is invisible,
 
621
    255 is not transparent at all.
 
622
 
 
623
*Iconbar Mode*:::
 
624
Specifies various modes of the iconbar's operation.
 
625
+
 
626
The first section outlines what types of windows will be shown in the iconbar:
 
627
+
 
628
--
 
629
*None*:;;
 
630
        Will not show any windows
 
631
*Icons*:;;
 
632
        Shows windows from all workspaces that are iconified (or, minimized)
 
633
*NoIcons*:;;
 
634
        Shows windows from all workspaces that are not iconified
 
635
*WorkspaceIcons*:;;
 
636
        Shows windows from the current workspace that are iconified
 
637
*WorkspaceNoIcons*:;;
 
638
        Shows windows from the current workspace that are not iconified
 
639
*Workspace*:;;
 
640
        Shows all windows (iconified or not) from the current workspace
 
641
*All Windows*:;;
 
642
        Shows all windows (iconified or not) from all workspaces
 
643
 
 
644
--
 
645
+
 
646
The next section specifies the alignment of the window names shown in the
 
647
iconbar. The with is specified via the *session.screen0.iconbar.iconWidth*
 
648
resource:
 
649
+
 
650
--
 
651
*Left*:;;
 
652
        All icons will be left-aligned with the width set in the `init' file
 
653
*Relative*:;;
 
654
        All icons will be sized evenly to fill the iconbar completely
 
655
*Right*:;;
 
656
        All icons will be right-aligned with the width set in the `init' file
 
657
 
 
658
--
 
659
+
 
660
The last option in this submenu is:
 
661
+
 
662
*Show Pictures*:;;
 
663
    If enabled the iconbar will show the application's icon (if provided by the
 
664
    application)
 
665
 
 
666
*Clock*:::
 
667
    Lets you switch between the 00:00am - 11:59pm and 00:00 - 23:59 notation
 
668
 
 
669
*Edit Clock Format*:::
 
670
    clicking this entry will pop up a dialog window in which the clock format
 
671
    can be set according to 'man strftime' (or 'man date').
 
672
 
 
673
FOCUS MODEL
 
674
-----------
 
675
The Focus Model defines how windows gain focus (i.e. become the active window,
 
676
which receives keyboard and mouse events). The focus model can be changed in
 
677
the configuration menu (usually located under 'fluxbox menu' in the Root Menu.
 
678
 
 
679
There are two main aspects of the focus model: how windows gain focus and how
 
680
tabs gain focus. Each of these has two options: focus follows mouse and click
 
681
to focus. Focus follows mouse means that windows will gain focus when the mouse
 
682
hovers over them. Click to focus means that windows will gain focus when the
 
683
mouse clicks on them.
 
684
 
 
685
Thus, there are four main options when choosing a focus model. You should choose
 
686
one of the first two and one of the last two. They are:
 
687
 
 
688
*Click To Focus*:::
 
689
    Click to focus windows.
 
690
*Mouse Focus*:::
 
691
    Window focus follows mouse.
 
692
*ClickTabFocus*:::
 
693
    Click to focus tabs.
 
694
*MouseTabFocus*:::
 
695
    Tab focus follows mouse.
 
696
 
 
697
There are three more settings in the ``Focus Model'' menu:
 
698
 
 
699
*Focus New Windows*:::
 
700
        If enabled, a new window will grab X focus as soon as it is opened.
 
701
 
 
702
*Auto Raise*::
 
703
        If enabled, focusing on a new window will automatically raise that window
 
704
        above all others within its layer. When disabled, you must explicitly raise a
 
705
        focused window using the window menu, keybinding, or *Click Raises*.
 
706
 
 
707
*Click Raises*::
 
708
        If enabled, clicking anywhere on a window will raise it above all others
 
709
        within its layer.
 
710
 
 
711
TAB OPTIONS
 
712
-----------
 
713
This section of fluxbox configuration menu lets you configure many features of 
 
714
tabs. Inside of it there are three main options:
 
715
 
 
716
*Placement*:::
 
717
    You can choose where the external tabs will be positioned relative to the
 
718
    window. For these options to work, 'Tabs in Titlebar' must be off.
 
719
 
 
720
*Tabs in Titlebar*:::
 
721
    When this option is on, tabs are fixed in window titlebar and the width
 
722
    varies according to the amount of windows grouped.
 
723
 
 
724
*Maximize Over*:::
 
725
    When this option is on, maximizing a window will disregard the size and
 
726
    location of external tabs, which means they may be pushed out of the screen
 
727
         entirely.
 
728
 
 
729
*External Tab Width*:::
 
730
    This specifies in pixels the width of external tabs.
 
731
 
 
732
STYLES
 
733
------
 
734
fluxbox enables you to use specialized files that contain *X(1)* resources to
 
735
specify colors, textures, pixmaps and fonts, and thus the overall look of your
 
736
window borders, menus and the toolbar.
 
737
 
 
738
The default installation of fluxbox provides some of these style files. See
 
739
*fluxbox-style(5)* to accommodate the growing number of style components.
 
740
 
 
741
Style Overlay
 
742
~~~~~~~~~~~~~
 
743
In addition to the style file, the overlay file, whose location is specified by
 
744
*session.screen0.styleOverlay* (default: *\~/.fluxbox/overlay*) can be used to
 
745
set style resources that override all styles. For more information about which
 
746
parts of fluxbox can be controlled by the overlay file, see *fluxbox-style(5)*.
 
747
 
 
748
THE SLIT
 
749
--------
 
750
The slit is a special fluxbox window frame that can contain dockable
 
751
applications, such as ``bbtools'' or ``window maker dockapps''.
 
752
 
 
753
When applications are run in the slit they have no window borders of their
 
754
own; instead they are framed in the slit, and they are always visible in the
 
755
current workspace.
 
756
 
 
757
Most dockable applications use the -w option to run in the slit. For example,
 
758
you could put in your *\~/.fluxbox/startup*:
 
759
 
 
760
..............
 
761
bbmail -w &
 
762
bbpager -w &
 
763
wmdrawer &
 
764
exec fluxbox
 
765
..............
 
766
 
 
767
To use the slit you must have it compiled into fluxbox. This is the default
 
768
setting.
 
769
 
 
770
Slit Menu
 
771
~~~~~~~~~
 
772
This menu can be opened by right-clicking on the slit (though not on an
 
773
application running within the slit), or from the *Configuration Menu*.
 
774
 
 
775
All changes take effect immediately. Here are the settings:
 
776
 
 
777
*Placement*:::
 
778
    This lets you set the position of the slit.
 
779
 
 
780
*Layer*:::
 
781
    See *LAYERS* for details on the layer order.
 
782
 
 
783
*Auto hide*:::
 
784
    If this is enabled the slit will disappear after a defined time when the
 
785
    mouse pointer leaves the slit. It will slide in when the cursor hits the
 
786
    remaining edge of the slit. See the *session.autoRaiseDelay* resource for
 
787
         the delay time.
 
788
 
 
789
*Maximize Over*:::
 
790
         Enabling this option will allow windows to maximizing over the slit.  With
 
791
         this switched off they will only expand to the edge of the slit.  This
 
792
         option may be overridden by the ``Full Maximization'' from the
 
793
         *Configuration Menu*. If that option is enabled, this option will have no
 
794
         effect..
 
795
 
 
796
*Alpha*:::
 
797
    This sets the alpha value for the slit. Use the left mouse button to
 
798
    decrease and the right mouse button to increase the value. 0 is invisible,
 
799
    255 is not transparent at all.
 
800
 
 
801
*Clients*:::
 
802
    This submenu lets you reorder the the applications running in the
 
803
         slit. You are able to hide apps from the slit by unselecting them in the
 
804
         list showing. This will not kill the app. You can make them re-appear by
 
805
         selecting them in the list. The "Save SlitList" option saves the new order
 
806
         to you slitlist located in *\~/.fluxbox/slitlist*.  See the next section for
 
807
         details.
 
808
 
 
809
Slitlist File
 
810
~~~~~~~~~~~~~
 
811
fluxbox's slitlist file is available for those that use dockapps in the slit.
 
812
This file helps fluxbox keep track of the *order* of the dockapps when in the
 
813
slit. The file is generally located at *\~/.fluxbox/slitlist*.
 
814
 
 
815
A simple procedure for getting the slit sequences the way you like it is:
 
816
1.   Run fluxbox with no pre-loaded dockapps
 
817
2.   Run dockapps individually in the order you want them
 
818
3.   Add dockapps to your *startfluxbox(1)* script
 
819
 
 
820
This sequence will be saved by default to *\~/.fluxbox/slitlist* and will be
 
821
remembered for future instances of fluxbox.
 
822
 
 
823
Users are free to manually edit the slitlist file. It is a simple list of window
 
824
names, as given by *xprop(1)*, one per dockapp. Similar to the init file it should
 
825
not be edited while fluxbox is running. Otherwise changes may get overwritten.
 
826
 
 
827
The user also has the option of choosing a different path for the slitlist file,
 
828
by setting the *session.session0.slitlistFile* resource.
 
829
 
 
830
LAYERS
 
831
------
 
832
Layers affect the way that windows will overlap each other on the screen.
 
833
Windows on a higher layer will always appear above those on a lower one,
 
834
whether they are focused or not. By default, fluxbox uses 13 layers, starting
 
835
from 1 (highest). The total number of layers can be changed by using the
 
836
*session.numLayers* resource.
 
837
 
 
838
There are two ways to assign a window to a different layer. When the window is
 
839
open, you may select the layer in the `Layer ...' submenu of the window menu.
 
840
The menu gives six choices for the layer, which fluxbox manages by name. The
 
841
names are (from highest to lowest layer):
 
842
 
 
843
* 2  - Above Dock
 
844
* 4  - Dock
 
845
* 6  - Top
 
846
* 8  - Normal
 
847
* 10 - Bottom
 
848
* 12 - Desktop
 
849
 
 
850
The other way to set the layer for a window is through the `apps' file. This
 
851
method is described in *fluxbox-apps(5)*.
 
852
 
 
853
RESOURCES
 
854
---------
 
855
Usually the *\~/.fluxbox/init* resource file is created and maintained by
 
856
fluxbox itself. You can use the *Configure Menu*, mentioned above, to set most
 
857
of these options.  However, we'll cover all of the resource options that are
 
858
available to the user.  If you edit this file while fluxbox is running, you must
 
859
``reconfigure'' to reload the resource options.
 
860
 
 
861
When running fluxbox in a multiple-screen environment the screen0 key can also
 
862
be screen1, screen2, to customize the behavior of fluxbox on each desktop
 
863
accordingly. Here are the resources that are currently available:
 
864
 
 
865
*session.screen0.window.{focus|unfocus}.alpha*: 'integer'::
 
866
These resources are available to the user to set different levels of
 
867
transparency for different components of fluxbox. Each one accepts a value
 
868
between 0-255, 255 being opaque and 0 being completely transparent.
 
869
+
 
870
Default: *255*
 
871
 
 
872
*session.screen0.{slit|toolbar}.autoHide*: 'boolean'::
 
873
The autoHide resources allow the user to set the behavior of the toolbar
 
874
and slit. This behavior can be that they disappear when they are not being
 
875
used actively by the user, or they remain visible at all times.
 
876
+
 
877
Default: *False*
 
878
 
 
879
*session.screen0.{slit|toolbar}.layer*: 'layer'::
 
880
With these two resources, you can set the layer you want the toolbar and
 
881
the slit to appear on. Please read the LAYER section for more information.
 
882
+
 
883
Default: *Dock*
 
884
 
 
885
*session.screen0.{slit|toolbar}.placement*: 'placement'::
 
886
These allow users to place the slit and toolbar where they like.
 
887
+
 
888
--
 
889
Possible options are:;;
 
890
        *BottomLeft* *BottomCenter* *BottomRight* *LeftBottom* *LeftCenter* *LeftTop*
 
891
        *RightBottom* *RightCenter* *RightTop* *TopLeft* *TopCenter* *TopRight*
 
892
--
 
893
+
 
894
Slit default: *TopRight*
 
895
+
 
896
Toolbar default: *BottomCenter*
 
897
 
 
898
*session.screen0.{slit|toolbar|tabs}.maxOver*: 'boolean'::
 
899
Setting these to True will allow application windows to maximize over the
 
900
complete screen. Setting to False allows the slit, toolbar, and external
 
901
tabs to hold their territory and will always be visible when an
 
902
application is maximized.
 
903
+
 
904
Default: *False*
 
905
 
 
906
*session.screen0.toolbar.height*: 'integer'::
 
907
Set the height of the toolbar. If the value is set to 0, the style file
 
908
will gain control over the toolbar height. It is possible to set a fixed
 
909
height by changing this value to something greater than 0.
 
910
+
 
911
Default: *0*
 
912
 
 
913
*session.screen0.toolbar.visible*: 'boolean'::
 
914
The user can set whether they want to have a toolbar on screen at all.
 
915
Setting to False removes the toolbar from the screen.
 
916
+
 
917
Default: *True*
 
918
 
 
919
*session.screen0.toolbar.widthPercent*: 'integer'::
 
920
This resource sets the width percentage of the toolbar on the screen.
 
921
+
 
922
Default: *100*
 
923
 
 
924
*session.screen0.toolbar.tools*: 'tools'::
 
925
This resource specifies the tools plugged into the toolbar. Read the
 
926
TOOLBAR section in this manual for a description of each of these.
 
927
They may be specified in any order, delimited by the *,* character.
 
928
They will appear in the order given.
 
929
+
 
930
Possible tools:;;
 
931
*clock* *iconbar* *nextwindow* *prevwindow* *nextworkspace* *prevworkspace*
 
932
*systemtray* *workspacename*
 
933
+
 
934
Default:;;
 
935
*workspacename, prevworkspace, nextworkspace, iconbar, prevwindow, nextwindow,
 
936
systemtray, clock*
 
937
 
 
938
*session.screen0.{slit|toolbar}.onhead*: 'integer'::
 
939
For those that use xinerama, users can set this value to the number of the
 
940
head where they would like to see the slit and toolbar, starting from 1.
 
941
Setting this to 0 will ignore xinerama information.
 
942
+
 
943
Default: *0* for slit, *1* for toolbar
 
944
 
 
945
*session.screen0.iconbar.mode*: 'pattern'::
 
946
This determines which windows will be displayed in the iconbar. Any window
 
947
pattern is acceptable. See the section *CLIENT PATTERNS* in either
 
948
*fluxbox-keys(5)* or *fluxbox-apps(5)* for details.
 
949
+
 
950
Default: *{static groups} (workspace)*
 
951
 
 
952
*session.screen0.iconbar.usePixmap*: 'boolean'::
 
953
This is also set in the Iconbar Mode menu. When set to True, this will
 
954
show the native icon of applications.
 
955
+
 
956
Default: *True*
 
957
 
 
958
*session.screen0.iconbar.iconTextPadding*: 'integer'::
 
959
This specifies the space between the window title and the edge of the
 
960
button.
 
961
+
 
962
Default: *10*
 
963
 
 
964
*session.screen0.iconbar.alignment*: 'position'::
 
965
This value should be changed in the Iconbar Mode menu.
 
966
+
 
967
--
 
968
Available options:;;
 
969
- *Left*: Fixed width, aligned left
 
970
- *Relative*: Width varies to fill the iconbar
 
971
- *Right*: Fixed width, aligned right
 
972
--
 
973
+
 
974
Default: *Relative*
 
975
 
 
976
*session.screen0.iconbar.iconWidth*: 'integer'::
 
977
Used to specify the iconbar button width for Left/Right alignment.
 
978
+
 
979
Default: *128*
 
980
 
 
981
*session.screen0.strftimeFormat*: 'date'::
 
982
This adjusts the way the current time is displayed in the toolbar. The
 
983
*strftime(3)* format is used.
 
984
+
 
985
Default: *%I:%M %p*
 
986
 
 
987
*session.screen0.tabs.intitlebar*: 'boolean'::
 
988
This specifies whether tabs should be embedded in the titlebar or placed
 
989
outside the window.
 
990
+
 
991
Default: *True*
 
992
 
 
993
*session.screen0.tab.placement*: 'placement'::
 
994
This specifies where external tabs will appear on the window. It has the same
 
995
possible values as *sesion.screen0.{slit|toolbar}.placement*.
 
996
+
 
997
Default: *TopLeft*
 
998
 
 
999
*session.screen0.tab.width*: 'integer'::
 
1000
This specifies the width of external tabs in pixels.
 
1001
+
 
1002
Default: *64*
 
1003
 
 
1004
*session.screen0.focusModel*: *ClickToFocus|MouseFocus|StrictMouseFocus*::
 
1005
This controls how windows gain focus via the mouse. With `ClickToFocus',
 
1006
the user must click on the window. With `MouseFocus', windows gain focus
 
1007
whenever the mouse moves over them, but only when the mouse is moving. With
 
1008
`StrictMouseFocus', windows gain focus whenever the mouse enters any exposed
 
1009
area, even if this is due to layer changes, window movement, changing desktops, closing windows, etc.
 
1010
+
 
1011
Default: *ClickToFocus*
 
1012
      
 
1013
*session.screen0.autoRaise*: 'boolean'::
 
1014
When True, this setting automatically raises any window that gains focus.
 
1015
+
 
1016
Default: *True*
 
1017
 
 
1018
*session.autoRaiseDelay*: 'integer'::
 
1019
Adjusts the delay (in milli-sec) before focused windows will raise
 
1020
when using the Autoraise option.
 
1021
+
 
1022
Default: *250*
 
1023
 
 
1024
*session.screen0.clickRaises*: 'boolean'::
 
1025
This setting allows a user to click anywhere on a window to bring it on
 
1026
top of other windows. Otherwise, only the titlebar will work.
 
1027
+
 
1028
Default: *True*
 
1029
 
 
1030
*session.screen0.workspacewarping*: 'boolean'::
 
1031
This setting enables a user to change workspaces by dragging a window
 
1032
across the edge of the screen.
 
1033
+
 
1034
Default: *True*
 
1035
 
 
1036
*session.screen0.showwindowposition*: 'boolean'::
 
1037
Setting this resource to True shows the user, in a little window,
 
1038
the exact position of the application window while the user is
 
1039
dragging it. Allows a precise placement of windows on a screen.
 
1040
+
 
1041
Default: *True*
 
1042
 
 
1043
*session.screen0.defaultDeco*: 'string'::
 
1044
This specifies the default window decorations, according to the same
 
1045
options available to the *[Deco]* option in the `apps' file, described in
 
1046
*fluxbox-apps(5)*.
 
1047
+
 
1048
Default: *NORMAL*
 
1049
 
 
1050
*session.screen0.menuDelay*: 'integer'::
 
1051
This sets the delay in milliseconds for submenus to open when you hover
 
1052
over them or to close when you hover over another item.
 
1053
+
 
1054
Default: *200*
 
1055
 
 
1056
*session.screen0.focusNewWindows*: 'boolean'::
 
1057
This sets whether or not new windows will become focused automatically.
 
1058
+
 
1059
Default: *True*
 
1060
 
 
1061
*session.screen0.workspaceNames*: 'names'::
 
1062
Here is where the user can name their workspaces, in a comma-delimited list.
 
1063
However it is recommended to use the tool available in the Workspace Menu to set
 
1064
these.
 
1065
+
 
1066
Default: *one, two, three, four*
 
1067
 
 
1068
*session.screen0.edgeSnapThreshold*: 'integer'::
 
1069
When moving a window across your screen, fluxbox is able to have it `snap'
 
1070
to the edges of the screen and other windows for easy placement. This
 
1071
variable tells fluxbox the distance (in pixels) at which the window will
 
1072
jump to the edge.
 
1073
+
 
1074
Default: *10*
 
1075
 
 
1076
*session.screen0.windowPlacement*: 'strategy'::
 
1077
This resource specifies where to place new windows when not otherwise
 
1078
specified (by the program or the `apps' file, for example).
 
1079
+
 
1080
--
 
1081
Available strategies:;;
 
1082
- RowSmartPlacement: tries to place windows in rows without overlapping
 
1083
- ColSmartPlacement: tries to place windows in columns without overlapping
 
1084
- CascadePlacement: places windows below the titlebar of the previous one
 
1085
- UnderMousePlacement: places new windows underneath the mouse
 
1086
--
 
1087
+
 
1088
Default: *RowSmartPlacement*
 
1089
 
 
1090
*session.screen0.rowPlacementDirection*: *LeftToRight*|*RightToLeft*::
 
1091
These settings control the direction in which windows are tiled using the
 
1092
RowSmartPlacement and ColSmartPlacement strategies described above.
 
1093
+
 
1094
Default: *LeftToRight*
 
1095
 
 
1096
*session.screen0.colPlacementDirection*: *TopToBottom*|*BottomToTop*::
 
1097
These settings control the direction in which windows are tiled using the
 
1098
RowSmartPlacement and ColSmartPlacement strategies described above.
 
1099
+
 
1100
Default: *TopToBottom*
 
1101
 
 
1102
*session.screen0.fullMaximization*: 'boolean'::
 
1103
If this setting is enabled, windows will maximize over the toolbar, slit,
 
1104
and any other window that creates a strut, no matter what their individual
 
1105
settings are.
 
1106
+
 
1107
Default: *False*
 
1108
 
 
1109
*session.screen0.opaqueMove*: 'boolean'::
 
1110
When moving a window, setting this to True will draw the window
 
1111
contents as it moves (this is nasty on slow systems). If False, it
 
1112
will only draw an outline of the window border.
 
1113
+
 
1114
Default: *True*
 
1115
 
 
1116
*session.screen0.workspaces*: 'integer'::
 
1117
Set this to the number of workspaces the users wants.
 
1118
+
 
1119
Default: *4*
 
1120
 
 
1121
*session.cacheLife*: 'minutes'::
 
1122
This tells fluxbox how long unused pixmaps may stay in the X
 
1123
server's memory.
 
1124
+
 
1125
Default: *5*
 
1126
 
 
1127
*session.cacheMax*: 'KbSize'::
 
1128
This tells fluxbox how much memory it may use to store cached
 
1129
pixmaps on the X server. If your machine runs short of memory, you may
 
1130
lower this value.
 
1131
+
 
1132
Default: *200*
 
1133
 
 
1134
*session.colorsPerChannel*: 'integer'::
 
1135
This tells fluxbox how many colors to take from the X server on
 
1136
pseudo-color displays. A channel would be red, green, or blue. fluxbox
 
1137
will allocate this variable ^ 3 and make them always available. Value must
 
1138
be between 2-6. When you run fluxbox on an 8bpp display, you must set this
 
1139
resource to 4.
 
1140
+
 
1141
Default: *4*
 
1142
 
 
1143
*session.doubleClickInterval*: 'integer'::
 
1144
Adjust the delay in milliseconds between mouse clicks for fluxbox to
 
1145
consider a double click.
 
1146
+
 
1147
Default: *250*
 
1148
 
 
1149
*session.forcePseudoTransparency*: 'boolean'::
 
1150
If you have Xorg's composite extension enabled, this setting will force
 
1151
the menu, windows, toolbar, and slit to use pseudo-transparency instead of
 
1152
true transparency.
 
1153
+
 
1154
Default: *False*
 
1155
 
 
1156
*session.ignoreBorder*: 'boolean'::
 
1157
This configures the ability to move windows by dragging the border.
 
1158
+
 
1159
Default: *False*
 
1160
 
 
1161
*session.tabPadding*: 'integer'::
 
1162
This specifies the spacing between tabs.
 
1163
+
 
1164
Default: *0*
 
1165
 
 
1166
*session.tabsAttachArea*: *Window|Titlebar*::
 
1167
With this set to `Window', windows may be grouped by dragging one tab with
 
1168
the middle mouse button and dropping it anywhere on another window. With
 
1169
`Titlebar', the user must drop the tab on the target window's titlebar.
 
1170
+
 
1171
Default: *Window*
 
1172
 
 
1173
*session.titlebar.{left|right}*: 'buttons'::
 
1174
The buttons or icons to place in the titlebar of decorated windows. You
 
1175
may specify any number, space-delimited.
 
1176
+
 
1177
--
 
1178
The available options are:;;
 
1179
        *Close* *Maximize* *MenuIcon* *Minimize* *Shade* *Stick*
 
1180
--
 
1181
+
 
1182
Default left: *Stick MenuIcon*
 
1183
+
 
1184
Default right: *Shade Minimize Maximize Close*
 
1185
 
 
1186
All of the 'location' resources following require a pathname to their specific
 
1187
files. This is where you can specify different files. Most of the defaults will
 
1188
be located in the user's *\~/.fluxbox* directory.
 
1189
 
 
1190
*session.appsFile*: 'location'::
 
1191
        Location of persistent application settings, or the `apps' file. See the
 
1192
        *Remember...* item in the *Window Menu* section above or *fluxbox-apps(5)*
 
1193
        for details.
 
1194
 
 
1195
*session.groupFile*: 'location'::
 
1196
        Deprecated, auto-grouping is now done in the `apps' file, see
 
1197
        *fluxbox-apps(5)* for details.
 
1198
 
 
1199
*session.keyFile*: 'location'::
 
1200
        Location of the keyboard mapping settings, or the `keys' file.
 
1201
        See *fluxbox-keys(5)* for details.
 
1202
 
 
1203
*session.menuFile*: 'location'::
 
1204
        Location of the Root Menu file.
 
1205
        See *fluxbox-menu(5)* for details.
 
1206
 
 
1207
*session.slitlistFile*: 'location'::
 
1208
        Location of the file used to remember slit client ordering.
 
1209
        See *SLIT* above for details.
 
1210
 
 
1211
*session.styleFile*: 'location'::
 
1212
        Location of the currently selected style.
 
1213
        See *fluxbox-style(5)* for details.
 
1214
 
 
1215
*session.styleOverlay*: 'location'::
 
1216
        Location of the style overlay file.
 
1217
        See *fluxbox-style(5)* for details.
 
1218
 
 
1219
*session.screen0.windowMenu*: 'location':::
 
1220
This optionally specifies the location of a user-defined window menu. If left
 
1221
blank, it will use *\~/.fluxbox/windowmenu*.
 
1222
+
 
1223
Default: *blank*
 
1224
 
 
1225
ENVIRONMENT
 
1226
-----------
 
1227
*HOME*::
 
1228
    fluxbox uses *$HOME* to find the .fluxbox/init file and to resolve style file
 
1229
    and -directory names.
 
1230
 
 
1231
*DISPLAY*::
 
1232
    When no other display was given on the command line, fluxbox will start on
 
1233
    the display specified by this variable.
 
1234
 
 
1235
fluxbox can also take advantage of other environment variables if they are set
 
1236
before fluxbox is started. For example, if $TERM is set, then it will be
 
1237
available whenever fluxbox uses the shell, such as the `keys' file
 
1238
*ExecCommand* or the root menu's *[exec]* tag. See *fluxbox-keys(5)* and
 
1239
*fluxbox-menu(5)* for details.
 
1240
 
 
1241
The `keys' file also provides two commands that can alter the current
 
1242
environment of fluxbox: *SetEnv* and *Export*. Any changes made by these
 
1243
commands will also affect the environment as seen by fluxbox and all child
 
1244
processes started after that point. See *fluxbox-keys(5)* for details.
 
1245
 
 
1246
For more information about environment variables in general, see your shell's
 
1247
manual.
 
1248
 
 
1249
SIGNALS
 
1250
-------
 
1251
fluxbox responds to the following signals:
 
1252
 
 
1253
- SIGHUP   fluxbox loads the configuration.
 
1254
- SIGUSR1  Forces reloading of configuration.
 
1255
- SIGUSR2  Forces reloading of menu file.
 
1256
 
 
1257
AUTHORS
 
1258
-------
 
1259
fluxbox is written and maintained by Henrik Kinnunen <fluxgen at fluxbox org>,
 
1260
Simon Bowden <rathnor at fluxbox org>, Mathias Gumz <akira at fluxbox org>, and
 
1261
Mark Tiefenbruck <mark at fluxbox org>, with contributions and patches merged
 
1262
from many individuals around the world.
 
1263
 
 
1264
Blackbox was written and maintained by Brad Hughes <blackbox at alug org> and
 
1265
Jeff Raven <jraven at psu edu>.
 
1266
 
 
1267
This manpage is the combined work of:
 
1268
 
 
1269
- Jim Ramsay <i.am at jimramsay com> (>fluxbox-1.0.0)
 
1270
- Curt Micol <asenchi at asenchi com> (>fluxbox-0.9.11)
 
1271
- Tobias Klausmann <klausman at users sourceforge net> (<=fluxbox-0.9.11)
 
1272
- Grubert <grubert at users sourceforge net> (fluxbox)
 
1273
- Matthew Hawkins <matt at mh dropbear id au> (blackbox)
 
1274
- Wilbert Berendsen <wbsoft at xs4all nl> (blackbox)
 
1275
 
 
1276
- Numerous other languages could be available if someone jumps in.
 
1277
 
 
1278
ONLINE DOCUMENTATION
 
1279
--------------------
 
1280
The Official fluxbox website: http://www.fluxbox.org
 
1281
 
 
1282
The Official fluxbox wiki: http://www.fluxbox-wiki.org
 
1283
 
 
1284
Many compatible themes: http://tenr.de
 
1285
 
 
1286
BUGS
 
1287
----
 
1288
If you find any bugs, please visit the #fluxbox irc channel on
 
1289
irc.freenode.net or submit them to the bug tracker at
 
1290
http://sf.net/projects/fluxbox . Or you may subscribe to one of the
 
1291
mailinglists. More information can be found on the official website.
 
1292
 
 
1293
SEE ALSO
 
1294
--------
 
1295
fluxbox-apps(5) fluxbox-keys(5) fluxbox-style(5) fluxbox-menu(5)
 
1296
fluxbox-remote(1) fbsetroot(1) fbsetbg(1) fbrun(1) startfluxbox(1)