~ubuntu-branches/ubuntu/precise/fluxbox/precise

« back to all changes in this revision

Viewing changes to doc/fluxbox.1.in

  • Committer: Bazaar Package Importer
  • Author(s): Dmitry E. Oboukhov
  • Date: 2008-07-01 10:38:14 UTC
  • mfrom: (2.1.12 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080701103814-khx2b6il152x9p93
Tags: 1.0.0+deb1-8
* x-dev has been removed from build-depends (out-of-date package).
* Standards-Version bumped to 3.8.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\"
2
 
.\" Man page for Fluxbox
3
 
.\"
4
 
.\" Copyright (c) 2000 by Wilbert Berendsen <wbsoft@xs4all.nl>
5
 
.\" Copyright (c) 2001 by Matthew Hawkins <matt@mh.dropbear.id.au>
6
 
.\"
7
 
.\" Permission to use, copy, modify, and distribute this documentation for
8
 
.\" any purpose with or without fee is hereby granted, provided that the
9
 
.\" above copyright notice and this permission notice appear in all copies.
10
 
.\"
11
 
.\" THE DOCUMENTATION IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
12
 
.\" WARRANTIES WITH REGARD TO THIS DOCUMENTATION INCLUDING ALL IMPLIED
13
 
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
14
 
.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
15
 
.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
16
 
.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
17
 
.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
18
 
.\" PERFORMANCE OF THIS DOCUMENTATION
19
 
.\"
20
 
.\" Parts of the text are taken from website and several README's
21
 
.\" by His Great Hughesness himself. Why reinvent wheels?
22
 
.\"
23
 
.\" Created with NEdit, tested with ``man'' and ``tkman.''
24
 
.\" This manpage uses only standard groff and tmac.an macros.
25
 
.\" To all translators who didn't do manpages earlier (like me ;-):
26
 
.\" Read the Man-Page-Mini-HOWTO and the LDP manpage ``man 7 man''
27
 
.\" There's all I needed to know about these macros.
28
 
.\"
29
 
.\" Updated for bb 0.61 at Sat Sep  9 06:56:04 CEST 2000
30
 
.\"
31
 
.\" Changed to fluxbox  by Henrik Kinnunen (fluxgen@linuxmail.org)
32
 
.\"
33
 
.\" Updated for fluxbox 0.1.5 by Matthew Hawkins <matt@mh.dropbear.id.au>
34
 
.\"
35
 
.\" Updated for version 0.1.6 by Rando Christensen <eyez@babblica.net>
36
 
.\"
37
 
.\" Updated for version 0.1.7.1 by Stanislav Karchebny <berk@madfire.net>
38
 
.\"
39
 
.\" Updated for version 0.1.15 by Tobias Klausmann <klausman@users.sourceforge.net>
40
 
.\"
41
 
.\" Updating for version 0.9.10 by <grubert@users.sourceforge.net>
42
 
.\"
43
 
.\" ..define sort of <blockquote><pre> macro
44
 
.de EX
45
 
.ne 5
46
 
.if n .sp 1
47
 
.if t .sp .5
48
 
.nf
49
 
.in +.5i
50
 
..
51
 
.de EE
52
 
.fi
53
 
.in -.5i
54
 
.if n .sp 1
55
 
.if t .sp .5
56
 
..
57
 
.TH fluxbox 1 "August 16th, 2004" "0.9.9"
58
 
.SH NAME
59
 
fluxbox \- a window manager for X11
60
 
.SH SYNOPSIS
61
 
.BR fluxbox " \-help | \-version"
62
 
.br
63
 
.B fluxbox
64
 
.RI "[ \-rc" " rcfile " "] [ \-display" " display " ]
65
 
.SH DESCRIPTION
66
 
.\"
67
 
.\" Phirst Phew ParagraPhs taken from blackbox.alug.org
68
 
.\"
69
 
Fluxbox is yet another addition to the list of window managers for the Open
70
 
Group's X Window System, Version 11 Release 6 and above.
71
 
Fluxbox is built with C++, based on the sources of Blackbox 0.61.0.
72
 
.BR Fast .
73
 
.PP
74
 
Fluxbox provides configurable window decorations, a root menu to launch
75
 
applications and a toolbar that shows the current workspace name, the focused
76
 
application name and the current time.
77
 
There is also a workspace menu to add or remove workspaces. The `slit' can be
78
 
used to dock small applications, e.g. most of the bbtools can use the slit.
79
 
.PP
80
 
Fluxbox will iconify windows to the toolbar, in addition to adding the window
81
 
to the `Icons' submenu of the workspace menu.  One click and they reappear.
82
 
A double-click on the titlebar of a window will shade it i.e. the window will
83
 
disappear, only the titlebar stays visible.
84
 
.PP
85
 
Fluxbox uses its own graphics class to render its images on the fly.
86
 
By using style files, you can determine at a great level how your desktop looks
87
 
like.  Fluxbox styles are compatible with those of Blackbox, so users migrating
88
 
can still use their current favourite themes.
89
 
.PP
90
 
.\" TODO wmhints support
91
 
.\" TODO KDE2 GNome support
92
 
Currently KDE WM hints are not supported, but Fluxbox is already prepared to
93
 
support the new window manager specification that is now being developed for
94
 
both Gnome and KDE2.0.
95
 
.SH OPTIONS
96
 
Fluxbox supports the following commandline options:
97
 
.TP
98
 
.B \-help
99
 
Display command line options , then exit.
100
 
.TP
101
 
.B \-version
102
 
Display version info and exit.
103
 
.TP
104
 
.BI \-rc \ rcfile
105
 
Use another rcfile than the default
106
 
.IR  "~/.fluxbox/init" .
107
 
.TP
108
 
.BI \-display \ display
109
 
Start Fluxbox on the specified display.
110
 
Programs started by Fluxbox will have the
111
 
.B DISPLAY
112
 
environment variable set to this value, too.
113
 
.TP
114
 
.B \-info
115
 
Display some useful information (defaults and compiled-in features) and exit.
116
 
.TP
117
 
.B \-log \ filename
118
 
Log output to the specified file.
119
 
.\" ---------------------
120
 
.SH RUNNING FLUXBOX
121
 
This program is usually started by the user's startup script, most times called
122
 
.IR ~/.xinitrc .
123
 
To run fluxbox, modify the script by adding
124
 
.EX 0
125
 
exec fluxbox
126
 
.EE
127
 
as the last executed command of the script.
128
 
When Fluxbox terminates, the X session will terminate too.
129
 
.PP
130
 
When started, Fluxbox will try to find a default menufile in
131
 
.IR @pkgdatadir@/menu .
132
 
You can provide a system-wide menu for your users here.
133
 
.PP
134
 
On exit or restart, Fluxbox will save user defaults in the file
135
 
.I ~/.fluxbox/init
136
 
in the user's home directory.
137
 
Some resources in this file can be edited by hand.
138
 
.\" -----------------------
139
 
.SH USING FLUXBOX
140
 
Fluxbox includes keyboard handling. In order to customize your keybindings,
141
 
edit the file
142
 
.I ~/.fluxbox/keys
143
 
as described below in the section KEYS FILE.
144
 
.SS Root window (background):
145
 
Right click (button 3) will pop up the root menu.
146
 
With this you can launch your applications.
147
 
You can customize this menu for your needs.
148
 
A middle click (button 2) pops up the workspace menu.
149
 
You can add or remove a workspace, view
150
 
applications running on all workspace, inspect your icons, and jump directly to
151
 
any workspace or application.
152
 
.PP
153
 
Left clicking (button 1) on an application in the Workspaces menu will bring
154
 
you to that workspace and raise/focus that application;
155
 
middle clicking (button 2) will warp the application to the current workspace.
156
 
.SS Toolbar:
157
 
The toolbar contains up to eight fields/tools: a workspace name, the iconbar, the systemtray,
158
 
a clock and arrows for previous and next workspace and windows.
159
 
.PP
160
 
The contents can be configured in fluxbox init-file in the entry
161
 
.EX
162
 
session.screen0.toolbar.tools: clock, iconbar, workspacename
163
 
.EE
164
 
or the toolbar can be turned off by
165
 
.EX
166
 
session.screen0.toolbar.visible: false
167
 
.EE
168
 
.\" A left click on the toolbar will bring it to the foreground, a
169
 
.\" middle click will hide it behind other windows (if AlwaysOnTop is not set), and
170
 
.\" the right button brings up a little menu.
171
 
Clicking the workspace name brings up the toolbar menu.
172
 
Using the wheel on workspace name or the clock switches the workspace, this
173
 
could also be enabled for the whole desktop in the fluxbox menu.
174
 
.PP
175
 
When 
176
 
.B desktop warping
177
 
is enabled, dragging a window outside the desktop will change to the next desktop.
178
 
.PP
179
 
Using the toolbar menu you can enter a name for the current workspace (when finished,
180
 
press Enter).
181
 
One can choose the toolbar's position, in which layer it should be see LAYERs below
182
 
and if it should hide when the mouse leaves it.
183
 
The iconbar mode is also set via this menu: None, Icons -- Icons from all
184
 
workspaces, Workspace Icons, Workspace -- all windows from Workspace, All Windows --
185
 
from all workspaces.
186
 
.SS Layer
187
 
Fluxbox manages following layers: Above Dock, Dock, Top, Normal, Bottom, Desktop.
188
 
Presumably the list is from top to bottom. Slit and toolbar can be assigned to
189
 
a layer with the menu, applications might be assigned to a layer in the apps file.
190
 
.\" TODO the apps file has numbers for layers
191
 
.SS Focus Model
192
 
The window that has the focus is the one that recieves keys and mouse events.
193
 
The focus model is selectable via the Configuration menu.
194
 
.P
195
 
For
196
 
.B Click To Focus
197
 
The window must be clicked to get the focus. 
198
 
In
199
 
.B Semi Sloppy Focus 
200
 
the focus is transferred to the window under the mouse, after some delay.
201
 
For
202
 
.B Sloppy Focus
203
 
tabbed windows are activated by moving the mouse into the tab.
204
 
.SS Window Titlebar and Borders:
205
 
A left click on any place of the window's border, will raise it.
206
 
Dragging then moves the window.
207
 
Dragging the resize grips at the left-bottom and right-bottom
208
 
corners resizes the window.
209
 
Middle clicking on border or titlebar will immediately lower the window.
210
 
Right clicking on border or titlebar pops up the window menu,
211
 
containing these commands:
212
 
.TP
213
 
.B Send To... (in 0.9.7)
214
 
Send window to another workspace.
215
 
When you select the workspace with the middle button, Fluxbox will
216
 
send you along with the application to the selected workspace
217
 
.TP
218
 
.B Shade
219
 
Shade the window (display titlebar only)
220
 
.TP
221
 
.B Iconify
222
 
Iconify window.
223
 
The `icon' can be found in the `Icons' submenu of the workspace menu
224
 
as well as in the toolbar.
225
 
.TP
226
 
.B Maximize
227
 
(Un)Maximize window. Depending on toolbar and slit configuration maximize does
228
 
cover slit and toolbar or not.
229
 
.TP
230
 
.B Button1
231
 
(usually left button) Maximize Normal, i.e. Vertical and Horizontal
232
 
.TP
233
 
.B Button2
234
 
(Un)Maximize window only vertically.
235
 
.TP
236
 
.B Button3
237
 
(Un)Maximize window only horizontal.
238
 
.TP
239
 
.B Raise
240
 
Raise window
241
 
.TP
242
 
.B Lower
243
 
Lower window
244
 
.TP
245
 
.B Stick
246
 
(Un)Stick window.
247
 
A stuck window will always be displayed in the current workspace
248
 
.TP
249
 
.B Next Client
250
 
Activate next client in this window's group.
251
 
.TP
252
 
.B Prev Client
253
 
Activate prev client in this window's group.
254
 
.TP
255
 
.B Layer ...
256
 
Change the layer of this window.
257
 
.TP
258
 
.B Remember ...
259
 
Specify which window settings should be stored in the apps file.
260
 
.TP
261
 
.B Close
262
 
Close the application cleanly
263
 
.PP
264
 
When you doubleclick on the titlebar of a window, it will `shade', so
265
 
that only the titlebar stays visible.
266
 
Another double click will redisplay the window contents.
267
 
.SS Window Buttons:
268
 
In fluxbox, the window button's configuration is controlled by \ init
269
 
file entries. The default is:
270
 
.EX 0
271
 
session.titlebar.left:  Stick
272
 
session.titlebar.right: Minimize Maximize Close
273
 
.EE
274
 
Clicking the minimize button with any button causes the window to be iconified.
275
 
Clicking the close button with any button closes the application.
276
 
The maximize button (if present) maximizes the window in three ways:
277
 
Button 1 causes full screen maximization, button 2 maximizes the window only
278
 
vertically, and button 3 only horizontally.
279
 
The Sticky button sets has the same meaning as the
280
 
.I (Un)Stick window
281
 
menu option.
282
 
.SS Any menu:
283
 
Clicking button 3 in a menu will popdown the menu.
284
 
Clicking button 1 on the titlebar of any (sub)menu and then dragging it somewhere
285
 
else will cause the menu to stay visible and not disappear when you click on
286
 
a menu item.
287
 
.SS Miscellaneous:
288
 
When you want to drag a window, but cannot see either the bottom handle or its
289
 
titlebar, you can press Alt + button 1 anywhere in the window and then
290
 
drag it around.
291
 
You can also use Alt + button 1 to raise a partially visible window.
292
 
Finally, Alt + button 2 lowers a window, and Alt + button 3 resizes the window.
293
 
.PP
294
 
This can be disabled in the resource file
295
 
.I ~/.fluxbox/init
296
 
with 
297
 
.TP
298
 
session.useMod1: \fItrue\fR or \fIfalse\fR
299
 
.SH MENU FILE
300
 
A default menu file is installed in
301
 
.IR @pkgdatadir@/menu .
302
 
Of course this system-wide menu can be customized for all users at once.
303
 
But it is also possible to create a personal menu.
304
 
It is a convention to create a directory
305
 
.IR "~/.fluxbox/" " (or " "~/fluxbox/" ")"
306
 
in your home directory, and to create a menu file, e.g.
307
 
.I menu
308
 
in this directory, or copy the system-wide menu file to this location.
309
 
Next, we have to tell Fluxbox to load our menu file instead of the default.
310
 
This is accomplished by adding (or changing) a resource value in the
311
 
.I ~/.fluxbox/init
312
 
file e.g.:
313
 
.EX
314
 
session.menuFile:       ~/.fluxbox/menu
315
 
.EE
316
 
For this change to take effect, Fluxbox has to be restarted.
317
 
Be sure that your menu is usable, then choose `Restart' from the default
318
 
Fluxbox root menu. If only the contents of the menu file changed, only
319
 
.I reload config
320
 
is needed.
321
 
.PP
322
 
A menu reload can also be forced by sending SIGUSR2.
323
 
.SS Menu behaviour
324
 
The behaviour of the menu can be configured in the 
325
 
.I ~/.fluxbox/init
326
 
file, with the following entries:
327
 
.TP
328
 
session.screen0.menuMode:  can be either Click or Delay (default: Delay)
329
 
.TP
330
 
session.screen0.menuDelay:  in msec  (default: 0 )
331
 
.TP
332
 
session.screen0.menuDelayClose: in msec (default: 0 )
333
 
.EE
334
 
.SS Menu syntax
335
 
There are up to four fields in a menu line.
336
 
They are of the form:
337
 
.EX
338
 
[tag] (label or filename) {command or filename} <icon filename>
339
 
.EE
340
 
The supported tags are as follows:
341
 
.TP
342
 
.B [begin] (label for root menu)
343
 
This tells Fluxbox to start parsing the menu file.
344
 
This tag is required for Fluxbox to parse your menu file.
345
 
If it cannot find it, the system default menu is used instead.
346
 
.TP
347
 
.B [end]
348
 
This tells Fluxbox that it is at the end of a menu.
349
 
This can either be a submenu or the main root menu.
350
 
There must be at least one of these tags in your menu to correspond to the
351
 
required [begin] tag.
352
 
.TP
353
 
.B [exec] (label for command) {shell command}
354
 
Inserts a command item into the menu.
355
 
When you select the menu item from the menu, Fluxbox runs `shell command.'
356
 
.TP
357
 
.B [exit] (label for exit)
358
 
Inserts an item that shuts down and exits Fluxbox.
359
 
Any open windows are reparented to the root window before Fluxbox exits.
360
 
.TP
361
 
.B [include] (filename)
362
 
Reads the file 
363
 
.I filename
364
 
into the current menu. The file has to start with
365
 
.IR [begin]
366
 
and end with
367
 
.IR [end].
368
 
The 
369
 
.I filename
370
 
can be the full path to a file or it can begin with
371
 
.IR ~/ ,
372
 
which will be expanded into your home directory (e.g.
373
 
.EX
374
 
[include] (~/fluxbox/stylesmenu)
375
 
.EE
376
 
will include
377
 
.I /home/yourusername/fluxbox/stylesmenu
378
 
in my menu).
379
 
If the parameter to include directive is a directory, every file in this
380
 
path will be included.
381
 
.TP
382
 
.B [nop] (label - optional)
383
 
Insert a non-operational item into the current menu.
384
 
This can be used to help format the menu into blocks or sections
385
 
if so desired.
386
 
.B [nop]
387
 
does accept a label, but it is not required, and a blank item will be used
388
 
if none is supplied.
389
 
.TP
390
 
.B [separator]
391
 
will create a nice separator line.
392
 
.TP
393
 
.B [style] (label) {filename}
394
 
This tells Fluxbox to insert an item that, when selected, reads style file
395
 
named
396
 
.I filename
397
 
and apply the new textures, colors and fonts to the current
398
 
running session.
399
 
.TP
400
 
.B [stylesdir] (directory name)
401
 
Reads all filenames from the specified directory, assuming that they are all
402
 
valid style files (directories are ignored), and creates menu items in the
403
 
current menu for every filename, that, when selected by the user, apply the
404
 
selected style file to the current session.
405
 
The labels that are created in the menu are the filenames of the style files.
406
 
.TP
407
 
.B [stylesmenu] (label) {directory name}
408
 
Creates a submenu entry with
409
 
.I label
410
 
(that is also the title of the new submenu), and inserts in that submenu all
411
 
filenames in the specified directory, assuming that they are all valid style
412
 
files (directories are ignored) in the same way as the
413
 
.B [stylesdir]
414
 
command does.
415
 
.IP
416
 
.RB Both\  [stylesdir] \ and\  [stylesmenu]
417
 
commands make it possible to install style files without editing your menu file.
418
 
.TP
419
 
.B [submenu] (label) {title for menu - optional}
420
 
This tells Fluxbox to create and parse a new menu.
421
 
This menu is inserted as a submenu into the parent menu.
422
 
These menus are parsed recursively, so there is no limit to the number of levels
423
 
or nested submenus you can have.
424
 
The title for the new menu is optional, if none is supplied,
425
 
the new menu's title is the same as the item label.
426
 
An
427
 
.B [end]
428
 
tag is required to end the submenu.
429
 
.TP
430
 
.B [reconfig] (label)
431
 
When selected, this item rereads the current style and menu files and
432
 
apply any changes.
433
 
This is useful for creating a new style or theme, as you don't have to
434
 
constantly restart Fluxbox every time you save your style.
435
 
However, Fluxbox automagically rereads the menu whenever it changes.
436
 
.TP
437
 
.B [restart] (label) {shell command - optional}
438
 
This tells Fluxbox to restart.
439
 
If `shell command' is supplied, it shuts down and runs the command (which is
440
 
commonly the name of another window manager).
441
 
If the command is omitted, Fluxbox restarts itself.
442
 
.TP
443
 
.B [config] (label)
444
 
Inserts a Fluxbox native submenu item, containing numerous configuration
445
 
options concerning window placement, focus style, window moving style etc.
446
 
.TP
447
 
.B [workspaces] (label)
448
 
This tells Fluxbox to insert a link to the workspaces menu directly
449
 
into your menu.
450
 
This is handy for those users who can't access the
451
 
workspace menu directly (e.g. if you don't have a 3 button mouse, it's
452
 
rather hard to middle click to show the workspace menu).
453
 
.PP
454
 
Any line that starts with a `#' is considered a comment and ignored by Fluxbox.
455
 
Also, in the labels/commands/filenames fields,
456
 
you can escape any character like so:
457
 
.EX
458
 
[exec] (\\(my cool\\) \\{XTERM\\}) {xterm -T \\"cool XTERM\\"}
459
 
.EE
460
 
Using `\\\\' inserts a literal back-slash into the label/command/filename field.
461
 
.SS Menu example
462
 
Now let's put together some things.
463
 
Here is a short example of a menu file:
464
 
.PP
465
 
.nf
466
 
# Fluxbox menu file
467
 
[begin] (Fluxbox)
468
 
  [exec] (rxvt) {rxvt -ls} </usr/X11R6/share/icons/terminal.xpm>
469
 
  [exec] (netscape) {netscape -install}
470
 
  [exec] (The GIMP) {gimp}
471
 
  [exec] (XV) {xv}
472
 
  [exec] (Vim) {rxvt -geometry 132x60 -name VIM -e screen vim}
473
 
  [exec] (Mutt) {rxvt -name mutt -e mutt}
474
 
  [submenu] (mozilla)
475
 
    [exec] (browser) {mozilla -browser}
476
 
    [exec] (news) {mozilla -news}
477
 
    [exec] (mail) {mozilla -mail}
478
 
    [exec] (edit) {mozilla -edit}
479
 
    [exec] (compose) {mozilla -compose}
480
 
  [end]
481
 
  [submenu] (Window Manager)
482
 
    [exec] (Edit Menus) {nedit ~/.fluxbox/menu}
483
 
    [submenu] (Style) {Which Style?}
484
 
      [stylesdir] (~/.fluxbox/styles)
485
 
      [stylesmenu] (Fluxbox Styles) {@pkgdatadir@/styles}
486
 
    [end]
487
 
    [config] (Config Options)
488
 
    [reconfig] (Reconfigure)
489
 
    [restart] (Restart)
490
 
  [end]
491
 
  [exit] (Log Out)
492
 
[end]
493
 
# end of menu file
494
 
.fi
495
 
.\" --- styles ---
496
 
.SH STYLES
497
 
Fluxbox enables you to use specialized files that contain
498
 
.IR X (1)
499
 
resources to specify colors, textures, pixmaps and fonts, and thus
500
 
the overall look of your window borders, menus and the toolbar.
501
 
.PP
502
 
The default installation of Fluxbox provides some of these style files.
503
 
See fluxstyle(1) to accomodate the growing number of style components.
504
 
.\" --- keys ---
505
 
.SH KEYS FILE
506
 
You can customise Fluxbox' key handling through the
507
 
.IR ~/.fluxbox/keys
508
 
file.  The file takes the format of :
509
 
.EX
510
 
<modifier> <key> [...] :<operation>
511
 
.EE
512
 
In the example below, Mod1 is the 'Alt' key on the PC keyboard and Mod4 is
513
 
one of the three extra keys on a pc104 branded with a sickening corporate logo.
514
 
.EX
515
 
# Fluxbox keys file.
516
 
# Any line starting with a # is a comment.
517
 
Mod1 Tab :NextWindow
518
 
Mod1 F1 :Workspace 1
519
 
Mod1 F2 :Workspace 2
520
 
Mod1 F3 :Workspace 3
521
 
Mod1 F4 :Workspace 4
522
 
Mod1 F5 :Workspace 5
523
 
Mod1 F6 :Workspace 6
524
 
Mod1 F7 :Workspace 7
525
 
Mod1 F8 :Workspace 8
526
 
Mod1 F9 :Workspace 9
527
 
Mod4 b :PrevWorkspace
528
 
Mod4 c :Minimize
529
 
Mod4 r :ExecCommand rxvt
530
 
Mod4 v :NextWorkspace
531
 
Mod4 x :Close
532
 
Mod4 m :RootMenu
533
 
Control n Mod1 n :NextTab
534
 
.EE
535
 
As you can see from the last line, keybinds can be chained in a fashion similar
536
 
to emacs keybindings.
537
 
 
538
 
Commands are caseinsensitive, workspace numbering starts at "1", some commands
539
 
have synonyms, the space between the last key and the :Command is mandatory.
540
 
Possible Operations:
541
 
 
542
 
.B window manager commands
543
 
.EX
544
 
Restart \fIargument\fR
545
 
Quit
546
 
Reconfigure
547
 
SetStyle \fIargument\fR
548
 
ExecCommand, Execute or Exec \fIcommand\fR
549
 
.EE
550
 
.B commands to currently focused window
551
 
.EX
552
 
Minimize, MinimizeWindow or Iconify
553
 
Maximize, MaximizeWindow
554
 
Fullscreen
555
 
MaximizeVertical
556
 
MaximizeHorizontal
557
 
ResizeTo \fIwidth\fR \fIheight\fR
558
 
Resize \fIdelta-width\fR \fIdelta-height\fR
559
 
ResizeHorizontal \fIdelta-width\fR
560
 
ResizeVertical \fIdelta-height\fR
561
 
MoveTo \fIx\fR \fIy\fR
562
 
Move \fIdelta-x\fR \fIdelta-y\fR
563
 
MoveRight \fIdelta-x\fR
564
 
MoveLeft \fIdelta-x\fR
565
 
MoveUp \fIdelta-y\fR
566
 
MoveDown \fIdelta-y\fR
567
 
Raise
568
 
Lower
569
 
Close
570
 
Shade, ShadeWindow
571
 
Stick, StickWindow
572
 
ToggleDecor
573
 
SendToWorkspace \fInumber\fR : Sends the current window and takes you with it.
574
 
KillWindow
575
 
NextTab
576
 
PrevTab
577
 
MoveTabLeft
578
 
MoveTabRight
579
 
DetachClient
580
 
.EE
581
 
.B workspace commands
582
 
.EX
583
 
NextWorkspace
584
 
PrevWorkspace
585
 
RightWorkspace \fIby-number\fR
586
 
LeftWorkspace \fIby-number\fR
587
 
Workspace \fInumber\fR
588
 
NextWindow \fIby-number\fR
589
 
PrevWindow \fIby-number\fR
590
 
NextGroup \fIby-number\fR
591
 
PrevGroup \fIby-number\fR
592
 
ArrangeWindows
593
 
ShowDesktop - Iconifies all windows.
594
 
RootMenu
595
 
WorkspaceMenu
596
 
WindowMenu
597
 
WorkspaceNameDialog - edit workspaces name dialog (old SetWorkspaceName)
598
 
SetWorkspaceName \fIname\fR
599
 
.EE
600
 
.B Prev/NextWindow Parameter
601
 
NextWindow and PrevWindow take an integer parameter.
602
 
.EX
603
 
0 or unspecified = Default/current behavior - no skipping
604
 
1 = Skip lower tabs
605
 
2 = Skip stuck windows
606
 
3 = Skip lower tabs/stuck windows
607
 
4 = Skip shaded windows
608
 
5 = Skip lower tabs/shaded windows
609
 
6 = Skip stuck windows/shaded windows
610
 
7 = Skip lower tabs/stuck windows/shaded windows
611
 
.EE
612
 
.B special commands
613
 
.EX
614
 
MacroCmd
615
 
ReloadStyle
616
 
SetResourceValue \fIresourcename\fR \fIresource value\fR
617
 
BindKey \fIkey string : action\fR   - this will append key string and 
618
 
    action to your keys file and bind the key
619
 
.EE
620
 
.\" --- groups ---
621
 
.SH GROUPS FILE
622
 
Since version 0.1.11, Fluxbox has a feature called autogrouping, that is apps are
623
 
automatically grouped together if they are in the same group.
624
 
You can create groups simply by editing the
625
 
.IR ~/.fluxbox/groups
626
 
file.
627
 
The file takes the format of:
628
 
.EX
629
 
<app1> <app2> <app3> ... <appN>
630
 
.EE
631
 
where elements can be found with this command:
632
 
.EX
633
 
xprop WM_CLASS
634
 
.EE
635
 
Just launch this command in a terminal and click on the desired app after. It will
636
 
tell you what to write as element.
637
 
Each line forms a different group, e.g:
638
 
.EX
639
 
Navigator nedit
640
 
xterm
641
 
.EE
642
 
This will create two groups, one with netscape and nedit, and one with xterm.
643
 
The new window will only group itself to other windows on the same workspace
644
 
and to the last window that was focused.
645
 
.SH THE SLIT
646
 
The slit is a special Fluxbox window frame that can contain dockable
647
 
applications, e.g. the `bbtools.'
648
 
When applications are run in the slit they have no window borders of their own;
649
 
instead they are framed in the slit, and they are always visible in the current
650
 
workspace.
651
 
You can click button 3 on the edge of the slit window to get a menu to
652
 
determine its position, whether its contained applications should be grouped
653
 
horizontally or vertically and whether the slit should hide itself when the
654
 
mouse moves away.
655
 
.PP
656
 
Most dockable applications use the
657
 
.B -w
658
 
option to run in the slit.
659
 
For example, you could put in your
660
 
.IR ~/.xinitrc :
661
 
.EX
662
 
bbmail -w &
663
 
bbpager -w &
664
 
exec fluxbox
665
 
.EE
666
 
Of course to use the slit you must have slit support compiled in.
667
 
.\" --- slitlist ---
668
 
.SH SLITLIST FILE
669
 
Since version 0.1.10, Fluxbox has the capacity to launch dockapps in the order told
670
 
by the
671
 
.IR ~/.fluxbox/slitlist
672
 
file.
673
 
.PP
674
 
A simple procedure for getting the slit sequences the way you like it is:
675
 
.EX
676
 
1) Run fluxbox with no pre-loaded dockapps.
677
 
2) Run dockapps individually in the order you want them.
678
 
3) Re-add dockapps to your auto-run script, e.g. .xinitrc or .xsession. Order doesn't matter here!
679
 
.EE
680
 
This sequence will be saved by default to
681
 
.IR ~/.fluxbox/slitlist
682
 
and will be maintained in future fluxbox sessions.
683
 
.PP
684
 
Users are free to manually edit the slitlist file. It is a simple list of window names,
685
 
one per dockapp. Similar to the init file it should be edited while not running fluxbox.
686
 
Otherwise changes may get overwritten.
687
 
.PP
688
 
The user also has the option of choosing a different path for the slit list file.
689
 
The following example
690
 
.B init
691
 
file entry changes the path:
692
 
.EX
693
 
session.slitlistFile: /home/me/etc/slitsort
694
 
.EE
695
 
.SH CONFIGURATION MENU
696
 
Fluxbox has a few options that are configured by a configure menu.
697
 
Most are self-explanatory, but here are a few notes:
698
 
.TP
699
 
.B Sloppy Window Grouping
700
 
This option allows you to drop a window-title anywhere on the target window to group it,
701
 
instead of only on the target window's window-title.
702
 
.TP
703
 
.B Maximize Over Slit
704
 
This option makes maximized windows cover the Slit when they get maximized.
705
 
Turn this option off if you want your slit to stay visible at all times.
706
 
.SH RESOURCE FILE
707
 
Usually the
708
 
.I ~/.fluxbox/init
709
 
resource file is created and maintained by Fluxbox itself.
710
 
All options from the
711
 
.B [config]
712
 
menu, the last selected style file, your workspace names and
713
 
so on are saved into this file.
714
 
However, there are some resources in it you might want to edit yourself:
715
 
.TP
716
 
.B session.menuFile:
717
 
This tells Fluxbox where to look for its menu file.
718
 
.EX
719
 
session.menuFile: /home/myself/.fluxbox/menu
720
 
.EE
721
 
.TP
722
 
.B session.keyFile:
723
 
This tells Fluxbox where to find the file describing the keybindings.
724
 
.EX
725
 
session.keyFile: /home/myself/.fluxbox/keys
726
 
.EE
727
 
.TP
728
 
.B session.styleFile:
729
 
This tells Fluxbox where to find the style (theme) file for this session.
730
 
.EX
731
 
session.styleFile: @pkgdatadir@/styles/Flux
732
 
.EE
733
 
.TP
734
 
.B session.groupFile:
735
 
This tells Fluxbox where to find the file for the autogrouping feature.
736
 
.EX
737
 
session.groupFile: /home/myself/.fluxbox/groups
738
 
.EE
739
 
.TP
740
 
.B session.slitlistFile:
741
 
This tells Fluxbox where to find the file that contains the order in which the apps are loaded in the slit.
742
 
.EX
743
 
session.slitlistFile: /home/myself/.fluxbox/slitlist
744
 
.EE
745
 
.TP
746
 
.B session.screen0.toolbar.tools:
747
 
This specifies the tools plugged into the toolbar.
748
 
Possible tools:
749
 
workspacename, prevworkspace, nextworkspace, iconbar, systemtray, prevwindow, nextwindow,
750
 
clock
751
 
e.g. :
752
 
.EX
753
 
session.screen0.toolbar.tools: clock, iconbar, workspacename
754
 
.EE
755
 
.TP
756
 
.B session.screen0.strftimeFormat:
757
 
This adjusts the way the current time is displayed in the toolbar.
758
 
The
759
 
.IR strftime (3)
760
 
format is used.
761
 
The default value is:
762
 
.IR "%I:%M %p" .
763
 
.TP
764
 
.B session.screen0.rootCommand:
765
 
This overrides the style's rootCommand. When this value is set, it will keep
766
 
your background the same, regardless of what any style would like your
767
 
background to be.
768
 
.TP
769
 
.B session.autoRaiseDelay:
770
 
Adjusts the delay (in ms) before focused windows will raise when using the
771
 
Autoraise option.
772
 
The default value is:
773
 
.IR 250 .
774
 
.TP
775
 
.B session.doubleClickInterval:
776
 
Adjust the delay (in ms) between mouse clicks for Fluxbox to consider a double click.
777
 
Default value is:
778
 
.IR 250 .
779
 
.TP
780
 
.B session.screen0.edgeSnapThreshold:
781
 
When moving a window across your screen, Fluxbox is able to have it `snap' to
782
 
the edges of the screen for easy placement.
783
 
This variable tells Fluxbox the distance (in pixels) at which the window will
784
 
jump to the edge.
785
 
Default value is:
786
 
.IR 0 .
787
 
.TP
788
 
.B session.cacheMax:
789
 
This tells Fluxbox how much memory (in Kb) it may use to store cached pixmaps on
790
 
the X server.
791
 
If your machine runs short of memory, you may lower this value.
792
 
Default value is
793
 
.IR 200 .
794
 
.TP
795
 
.B session.cacheLife:
796
 
This tells Fluxbox how long (in minutes) unused pixmaps may stay in the X
797
 
server's memory.
798
 
Default value is
799
 
.IR 5 .
800
 
.TP
801
 
.B session.opaqueMove:
802
 
When moving a window, setting this to
803
 
.IR True
804
 
will draw the window contents as it moves (nasty on slow systems), if
805
 
.IR False
806
 
it will only draw an outline of the window border.
807
 
.TP
808
 
.B session.imageDither:
809
 
.IR True
810
 
or
811
 
.IR False
812
 
to, respectively, enable or disable dithering of images.  Only necessary
813
 
on systems with small colour depths (8bpp or less)
814
 
.TP
815
 
.B session.colorsPerChannel:
816
 
This tells Fluxbox how many colors to take from the X server on pseudocolor
817
 
displays.  A channel would be red, green, or blue.
818
 
Fluxbox will allocate this variable ^ 3 colors and make them always available.
819
 
Value must be between 2 and 6.
820
 
When you run Fluxbox on an 8-bit display, you must set this resource to 4.
821
 
Default value is
822
 
.IR 4.
823
 
.TP
824
 
.\" session.iconbar
825
 
.B session.iconbar:
826
 
.IR True
827
 
or
828
 
.IR False
829
 
to enable or disable Fluxbox using the toolbar to display iconified windows.
830
 
.TP
831
 
.B session.*.iconbar.alignment:
832
 
.IR LEFT , 
833
 
.IR RELATIVE or
834
 
.IR RIGHT
835
 
can be changed in the iconbar mode menu. If LEFT or RIGHT is specified the
836
 
iconbar buttons have a fixed with and are left/right aligned.
837
 
.TP
838
 
.B session.*.iconbar.clientWidth: 
839
 
.IR Integer
840
 
is used to specify the iconbar button width for LEFT/RIGHT alignment.
841
 
.TP
842
 
.B session.*.iconbar.wheelMode: 
843
 
.IR On ,
844
 
.IR Off or
845
 
.IR Screen
846
 
.EX
847
 
On     - enable mousewheeling on the iconbuttons
848
 
Off    - disables mousewheeling on the iconbuttons
849
 
Screen - uses the settings of desktopWheeling
850
 
.EE
851
 
.TP
852
 
.B session.*.iconbar.deiconifyMode:
853
 
.IR Current ,
854
 
.IR Follow or
855
 
.IR SemiFollow
856
 
.EX
857
 
      Current    - deiconifies the window on current workspace
858
 
      Follow     - deiconifies the window on the workspace it
859
 
                   was iconified from and jumps to that workspace
860
 
      SemiFollow - acts as 'Current' for windows that were actually
861
 
                   iconified, and as 'follow' for the others
862
 
.EE
863
 
.TP
864
 
.\" session.tabs
865
 
.B session.tabs:
866
 
.IR True
867
 
or
868
 
.IR False
869
 
to enable/disable Fluxbox's PWM-like window tabs.  Tabs let you group windows
870
 
together, they will take up identical desktop space (windows smaller or larger
871
 
than the existing group size get resized automatically) and can be moved as a
872
 
group around the desktop or to a different workspace.
873
 
Default value is
874
 
.IR True .
875
 
.PP
876
 
When running Fluxbox in a multiple desktop environment the
877
 
.B screen0
878
 
key can also be
879
 
.B screen1, 2
880
 
etc. for any appropriate desktop, and you can customise the behaviour of
881
 
Fluxbox on each desktop accordingly.  A favourite of the man page author
882
 
with a dual-head Matrox G450 was to autohide the slit and toolbar on
883
 
screen0 and set it alwaysontop and not autohidden on screen1, with a
884
 
larger date format on screen1
885
 
.EX
886
 
session.screen0.toolbar.onTop: False
887
 
session.screen0.toolbar.autoHide: True
888
 
session.screen0.toolbar.placement: BottomCenter
889
 
session.screen0.toolbar.widthPercent: 42
890
 
session.screen0.slit.onTop: False
891
 
session.screen0.slit.autoHide: True
892
 
session.screen0.slit.placement: TopLeft
893
 
session.screen0.slit.direction: Vertical
894
 
session.screen0.strftimeFormat: %I:%M %p
895
 
session.screen1.toolbar.onTop: True
896
 
session.screen1.toolbar.autoHide: False
897
 
session.screen1.toolbar.placement: BottomCenter
898
 
session.screen1.toolbar.widthPercent: 69
899
 
session.screen1.slit.onTop: True
900
 
session.screen1.slit.autoHide: False
901
 
session.screen1.slit.placement: CenterRight
902
 
session.screen1.slit.direction: Vertical
903
 
session.screen1.strftimeFormat: %a %d %R [%s]
904
 
.EE
905
 
This way the main workspace (screen0) has the maximum amount of space available
906
 
and the secondary workspace could show the time and run some withdrawn apps like
907
 
gkrellm in the slit, always visible yet out of the way of real work.
908
 
.\" -- apps file
909
 
.SH APPLICATIONS SETTINGS
910
 
Sometimes, you want to force an application to have always the same dimensions,
911
 
position, and other settings.  It is now possible with the new window-submenu
912
 
called 'Remember...'.  Settings are saved in the
913
 
.I ~/.fluxbox/apps
914
 
file.  You don't have to edit the file yourself as all manipulations can be
915
 
done using the 'Remember...' submenu.
916
 
.TP
917
 
.B Workspace [0-N]
918
 
Force the workspace of the application to be the current one, even if you launch
919
 
the application from another workspace.
920
 
.TP
921
 
.B Dimensions [Width Height]
922
 
Remember the current dimensions.
923
 
.TP
924
 
.B Position ([WINCENTER|CENTER|UPPERLEFT|UPPERRIGHT|LOWERLEFT|LOWERRIGHT]) [X Y]
925
 
Remember the current position. X and Y are relative to e.g. WINCENTER .
926
 
.TP
927
 
.B Shaded state [yes|no]
928
 
Remember the current shaded state.
929
 
.TP
930
 
.B Tab state [yes|no]
931
 
Remember the current tab state.
932
 
.TP
933
 
.B IconHidden 
934
 
hides the app from the icon bar
935
 
.TP
936
 
.B FocusHidden
937
 
hides the app from the list to be reachable via Next/PrevWindow
938
 
.TP
939
 
.B Hidden
940
 
is [IconHidden] + [FocusHidden]
941
 
.TP
942
 
.B Decoration state [NONE|NORMAL|TOOL|TINY]
943
 
Remember the current decoration state.
944
 
.TP
945
 
.B Sticky state [yes|no]
946
 
Remember the current sticky state.
947
 
.TP
948
 
.B Jump to workspace [yes|no]
949
 
This one is only useful if 'Workspace' is set too.  The workspace is changed
950
 
to the workspace containing the application being launched.
951
 
.TP
952
 
.B Save settings on close [yes|no]
953
 
By default, application settings are not saved when a window is closed.  Set
954
 
this option if you want previous settings to be saved when the window is closed.
955
 
.PP
956
 
The 
957
 
.B apps-file
958
 
also allows to specify applications that should be started on fluxbox start
959
 
using
960
 
.B [startup] (options) {application}
961
 
lines . 
962
 
.B options
963
 
could be used to specify the screen, not the workspace, on which
964
 
the application should started. startup is not yet setable by menu.
965
 
 
966
 
.SS Applications example
967
 
Here is a short example of an apps file:
968
 
.PP
969
 
.nf
970
 
[startup] {xterm}
971
 
[app] (kate)
972
 
  [Dimensions]  (WINCENTER) {1022 747}
973
 
  [Position]    {0 0}
974
 
  [Close]       {yes}
975
 
[end]
976
 
[app] (konqueror)
977
 
  [Workspace]   {1}
978
 
  [Dimensions]  {1006 749}
979
 
  [Position]    {16 0}
980
 
  [Jump]        {yes}
981
 
[end]
982
 
[app] (xterm)
983
 
  [Deco]        {NONE}
984
 
[end]
985
 
.fi
986
 
 
987
 
Parameters in the 'apps' file are case-sensitive.  Application names are taken
988
 
from the first X-Window WM_CLASS attribute.  You can see this attribute by using
989
 
the xprop command.  Transient windows are not affected by application settings.
990
 
.SH ENVIRONMENT
991
 
.TP
992
 
.B HOME
993
 
Fluxbox uses
994
 
.RB $ HOME
995
 
to find its
996
 
.I .fluxbox/init
997
 
file, and to resolve stylefile and \-directory names.
998
 
.TP
999
 
.B DISPLAY
1000
 
When no other display was given on the command line, Fluxbox will start on the
1001
 
display specified by this variable.
1002
 
.SH SIGNALS
1003
 
Upon receipt of 
1004
 
.B SIGUSR1
1005
 
fluxbox loads the configuration, 
1006
 
.B SIGUSR2
1007
 
forces reloading of configuration and 
1008
 
.B SIGHUP
1009
 
restarts itself.
1010
 
.SH AUTHOR and CREDITS
1011
 
Blackbox was written and maintained by Brad Hughes
1012
 
.nh \" hyphenation off
1013
 
<blackbox@alug.org>
1014
 
.hy \" on again
1015
 
and Jeff Raven
1016
 
.nh
1017
 
<jraven@psu.edu>,
1018
 
.hy
1019
 
Fluxbox is written and maintained by Henrik Kinnunen
1020
 
.nh
1021
 
<fluxgen@linuxmail.org>
1022
 
.hy
1023
 
with contributions and patches merged from
1024
 
many individuals around the world.
1025
 
.PP
1026
 
The Official Fluxbox website:
1027
 
.nh
1028
 
.B http://fluxbox.sf.net/
1029
 
.hy
1030
 
.br
1031
 
Many compatible themes:
1032
 
.nh
1033
 
.B http://themes.freshmeat.net/
1034
 
.hy
1035
 
.PP
1036
 
This manpage was put together by Matthew Hawkins
1037
 
.nh
1038
 
<matt@mh.dropbear.id.au>
1039
 
.hy
1040
 
from the original Blackbox man page by Wilbert Berendsen
1041
 
.nh
1042
 
<wbsoft@xs4all.nl>
1043
 
.hy
1044
 
and subsequently hacked upon by Tobias Klausmann
1045
 
.nh
1046
 
<klausman@users.sourceforge.net>
1047
 
,
1048
 
<grubert@users.sourceforge.net>
1049
 
,
1050
 
<asenchi@asenchi.com>
1051
 
.hy
1052
 
.PP
1053
 
Numerous other languages could be available if someone jumps in.
1054
 
.SH SEE ALSO
1055
 
.IR bsetroot (1) 
1056
 
.IR fbrun(1)
1057
 
.IR fbsetbg(1)
1058
 
.IR fluxstyle(1) 
1059