Update a few things in the manpage, especially the apps file section.
This commit is contained in:
parent
831daf5876
commit
7b648f53a2
1 changed files with 140 additions and 66 deletions
206
doc/fluxbox.1.in
206
doc/fluxbox.1.in
|
@ -72,8 +72,8 @@ Fluxbox is built with C++, based on the sources of Blackbox 0.61.0.
|
||||||
.BR Fast .
|
.BR Fast .
|
||||||
.PP
|
.PP
|
||||||
Fluxbox provides configurable window decorations, a root menu to launch
|
Fluxbox provides configurable window decorations, a root menu to launch
|
||||||
applications and a toolbar that shows the current workspace name, the focused
|
applications and a toolbar that shows the current workspace name, a set of
|
||||||
application name and the current time.
|
application names and the current time.
|
||||||
There is also a workspace menu to add or remove workspaces. The `slit' can be
|
There is also a workspace menu to add or remove workspaces. The `slit' can be
|
||||||
used to dock small applications, e.g. most of the bbtools can use the slit.
|
used to dock small applications, e.g. most of the bbtools can use the slit.
|
||||||
.PP
|
.PP
|
||||||
|
@ -83,15 +83,13 @@ A double-click on the titlebar of a window will shade it i.e. the window will
|
||||||
disappear, only the titlebar stays visible.
|
disappear, only the titlebar stays visible.
|
||||||
.PP
|
.PP
|
||||||
Fluxbox uses its own graphics class to render its images on the fly.
|
Fluxbox uses its own graphics class to render its images on the fly.
|
||||||
By using style files, you can determine at a great level how your desktop looks
|
By using style files, you can determine at a great level how your desktop looks.Fluxbox styles are compatible with those of Blackbox, so users migrating
|
||||||
like. Fluxbox styles are compatible with those of Blackbox, so users migrating
|
|
||||||
can still use their current favourite themes.
|
can still use their current favourite themes.
|
||||||
.PP
|
.PP
|
||||||
.\" TODO wmhints support
|
.\" TODO wmhints support
|
||||||
.\" TODO KDE2 GNome support
|
.\" TODO KDE2 GNome support
|
||||||
Currently KDE WM hints are not supported, but Fluxbox is already prepared to
|
Fluxbox supports the majority of the Extended Window Manager Hints (EWMH)
|
||||||
support the new window manager specification that is now being developed for
|
specification, as well as numerous other Window Hint standards.
|
||||||
both Gnome and KDE2.0.
|
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
Fluxbox supports the following commandline options:
|
Fluxbox supports the following commandline options:
|
||||||
.TP
|
.TP
|
||||||
|
@ -126,6 +124,9 @@ exec fluxbox
|
||||||
.EE
|
.EE
|
||||||
as the last executed command of the script.
|
as the last executed command of the script.
|
||||||
When Fluxbox terminates, the X session will terminate too.
|
When Fluxbox terminates, the X session will terminate too.
|
||||||
|
Another alternative is to use the
|
||||||
|
.IR startfluxbox (1)
|
||||||
|
script, which adds some more convenience features.
|
||||||
.PP
|
.PP
|
||||||
When started, Fluxbox will try to find a default menufile in
|
When started, Fluxbox will try to find a default menufile in
|
||||||
.IR @pkgdatadir@/menu .
|
.IR @pkgdatadir@/menu .
|
||||||
|
@ -173,7 +174,7 @@ Using the wheel on workspace name or the clock switches the workspace, this
|
||||||
could also be enabled for the whole desktop in the fluxbox menu.
|
could also be enabled for the whole desktop in the fluxbox menu.
|
||||||
.PP
|
.PP
|
||||||
When
|
When
|
||||||
.B desktop warping
|
.B workspace warping
|
||||||
is enabled, dragging a window outside the desktop will change to the next desktop.
|
is enabled, dragging a window outside the desktop will change to the next desktop.
|
||||||
.PP
|
.PP
|
||||||
Using the toolbar menu you can enter a name for the current workspace (when finished,
|
Using the toolbar menu you can enter a name for the current workspace (when finished,
|
||||||
|
@ -185,11 +186,11 @@ workspaces, Workspace Icons, Workspace -- all windows from Workspace, All Window
|
||||||
from all workspaces.
|
from all workspaces.
|
||||||
.SS Layer
|
.SS Layer
|
||||||
Fluxbox manages following layers: Above Dock, Dock, Top, Normal, Bottom, Desktop.
|
Fluxbox manages following layers: Above Dock, Dock, Top, Normal, Bottom, Desktop.
|
||||||
Presumably the list is from top to bottom. Slit and toolbar can be assigned to
|
The list is from top to bottom. Slit and toolbar can be assigned to
|
||||||
a layer with the menu, applications might be assigned to a layer in the apps file.
|
a layer with the menu, applications might be assigned to a layer in the apps file, or by hand in the window menu.
|
||||||
.\" TODO the apps file has numbers for layers
|
.\" TODO the apps file has numbers for layers
|
||||||
.SS Focus Model
|
.SS Focus Model
|
||||||
The window that has the focus is the one that recieves keys and mouse events.
|
The window that has the focus is the one that receives key and mouse events.
|
||||||
The focus model is selectable via the Configuration menu.
|
The focus model is selectable via the Configuration menu.
|
||||||
.P
|
.P
|
||||||
For
|
For
|
||||||
|
@ -210,7 +211,7 @@ Middle clicking on border or titlebar will immediately lower the window.
|
||||||
Right clicking on border or titlebar pops up the window menu,
|
Right clicking on border or titlebar pops up the window menu,
|
||||||
containing these commands:
|
containing these commands:
|
||||||
.TP
|
.TP
|
||||||
.B Send To... (in 0.9.7)
|
.B Send To...
|
||||||
Send window to another workspace.
|
Send window to another workspace.
|
||||||
When you select the workspace with the middle button, Fluxbox will
|
When you select the workspace with the middle button, Fluxbox will
|
||||||
send you along with the application to the selected workspace
|
send you along with the application to the selected workspace
|
||||||
|
@ -221,11 +222,11 @@ Shade the window (display titlebar only)
|
||||||
.B Iconify
|
.B Iconify
|
||||||
Iconify window.
|
Iconify window.
|
||||||
The `icon' can be found in the `Icons' submenu of the workspace menu
|
The `icon' can be found in the `Icons' submenu of the workspace menu
|
||||||
as well as in the toolbar.
|
as well as in the toolbar if a Toolbar mode showing Icons is selected.
|
||||||
.TP
|
.TP
|
||||||
.B Maximize
|
.B Maximize
|
||||||
(Un)Maximize window. Depending on toolbar and slit configuration maximize does
|
(Un)Maximize window. Depending on toolbar and slit configuration maximize
|
||||||
cover slit and toolbar or not.
|
covers the slit and toolbar or not.
|
||||||
.TP
|
.TP
|
||||||
.B Button1
|
.B Button1
|
||||||
(usually left button) Maximize Normal, i.e. Vertical and Horizontal
|
(usually left button) Maximize Normal, i.e. Vertical and Horizontal
|
||||||
|
@ -234,7 +235,7 @@ cover slit and toolbar or not.
|
||||||
(Un)Maximize window only vertically.
|
(Un)Maximize window only vertically.
|
||||||
.TP
|
.TP
|
||||||
.B Button3
|
.B Button3
|
||||||
(Un)Maximize window only horizontal.
|
(Un)Maximize window only horizontally.
|
||||||
.TP
|
.TP
|
||||||
.B Raise
|
.B Raise
|
||||||
Raise window
|
Raise window
|
||||||
|
@ -244,13 +245,13 @@ Lower window
|
||||||
.TP
|
.TP
|
||||||
.B Stick
|
.B Stick
|
||||||
(Un)Stick window.
|
(Un)Stick window.
|
||||||
A stuck window will always be displayed in the current workspace
|
A stuck window will be displayed on all workspaces.
|
||||||
.TP
|
.TP
|
||||||
.B Next Client
|
.B Next Client
|
||||||
Activate next client in this window's group.
|
Activate next client in this window's group.
|
||||||
.TP
|
.TP
|
||||||
.B Prev Client
|
.B Prev Client
|
||||||
Activate prev client in this window's group.
|
Activate previous client in this window's group.
|
||||||
.TP
|
.TP
|
||||||
.B Layer ...
|
.B Layer ...
|
||||||
Change the layer of this window.
|
Change the layer of this window.
|
||||||
|
@ -321,7 +322,7 @@ is needed.
|
||||||
.PP
|
.PP
|
||||||
A menu reload can also be forced by sending SIGUSR2.
|
A menu reload can also be forced by sending SIGUSR2.
|
||||||
.SS Menu behaviour
|
.SS Menu behaviour
|
||||||
The behaviour of the menu can be configured in the
|
The behaviour of submenus in the menu can be configured in the
|
||||||
.I ~/.fluxbox/init
|
.I ~/.fluxbox/init
|
||||||
file, with the following entries:
|
file, with the following entries:
|
||||||
.TP
|
.TP
|
||||||
|
@ -352,14 +353,14 @@ required [begin] tag.
|
||||||
.TP
|
.TP
|
||||||
.B [exec] (label for command) {shell command}
|
.B [exec] (label for command) {shell command}
|
||||||
Inserts a command item into the menu.
|
Inserts a command item into the menu.
|
||||||
When you select the menu item from the menu, Fluxbox runs `shell command.'
|
When you select the menu item from the menu, Fluxbox runs `shell command'.
|
||||||
.TP
|
.TP
|
||||||
.B [exit] (label for exit)
|
.B [exit] (label for exit)
|
||||||
Inserts an item that shuts down and exits Fluxbox.
|
Inserts an item that shuts down and exits Fluxbox.
|
||||||
Any open windows are reparented to the root window before Fluxbox exits.
|
Any open windows are reparented to the root window before Fluxbox exits.
|
||||||
.TP
|
.TP
|
||||||
.B [include] (filename)
|
.B [include] (filename)
|
||||||
Reads the file
|
Reads the file or directory
|
||||||
.I filename
|
.I filename
|
||||||
into the current menu. The file has to start with
|
into the current menu. The file has to start with
|
||||||
.IR [begin]
|
.IR [begin]
|
||||||
|
@ -515,6 +516,7 @@ one of the three extra keys on a pc104 branded with a sickening corporate logo.
|
||||||
# Fluxbox keys file.
|
# Fluxbox keys file.
|
||||||
# Any line starting with a # is a comment.
|
# Any line starting with a # is a comment.
|
||||||
Mod1 Tab :NextWindow
|
Mod1 Tab :NextWindow
|
||||||
|
Mod1 Shift Tab :PrevWindow
|
||||||
Mod1 F1 :Workspace 1
|
Mod1 F1 :Workspace 1
|
||||||
Mod1 F2 :Workspace 2
|
Mod1 F2 :Workspace 2
|
||||||
Mod1 F3 :Workspace 3
|
Mod1 F3 :Workspace 3
|
||||||
|
@ -535,7 +537,7 @@ Control n Mod1 n :NextTab
|
||||||
As you can see from the last line, keybinds can be chained in a fashion similar
|
As you can see from the last line, keybinds can be chained in a fashion similar
|
||||||
to emacs keybindings.
|
to emacs keybindings.
|
||||||
|
|
||||||
Commands are caseinsensitive, workspace numbering starts at "1", some commands
|
Commands are case-insensitive, workspace numbering starts at "1", some commands
|
||||||
have synonyms, the space between the last key and the :Command is mandatory.
|
have synonyms, the space between the last key and the :Command is mandatory.
|
||||||
Possible Operations:
|
Possible Operations:
|
||||||
|
|
||||||
|
@ -616,31 +618,6 @@ SetResourceValue \fIresourcename\fR \fIresource value\fR
|
||||||
BindKey \fIkey string : action\fR - this will append key string and
|
BindKey \fIkey string : action\fR - this will append key string and
|
||||||
action to your keys file and bind the key
|
action to your keys file and bind the key
|
||||||
.EE
|
.EE
|
||||||
.\" --- groups ---
|
|
||||||
.SH GROUPS FILE
|
|
||||||
Since version 0.1.11, Fluxbox has a feature called autogrouping, that is apps are
|
|
||||||
automatically grouped together if they are in the same group.
|
|
||||||
You can create groups simply by editing the
|
|
||||||
.IR ~/.fluxbox/groups
|
|
||||||
file.
|
|
||||||
The file takes the format of:
|
|
||||||
.EX
|
|
||||||
<app1> <app2> <app3> ... <appN>
|
|
||||||
.EE
|
|
||||||
where elements can be found with this command:
|
|
||||||
.EX
|
|
||||||
xprop WM_CLASS
|
|
||||||
.EE
|
|
||||||
Just launch this command in a terminal and click on the desired app after. It will
|
|
||||||
tell you what to write as element.
|
|
||||||
Each line forms a different group, e.g:
|
|
||||||
.EX
|
|
||||||
Navigator nedit
|
|
||||||
xterm
|
|
||||||
.EE
|
|
||||||
This will create two groups, one with netscape and nedit, and one with xterm.
|
|
||||||
The new window will only group itself to other windows on the same workspace
|
|
||||||
and to the last window that was focused.
|
|
||||||
.SH THE SLIT
|
.SH THE SLIT
|
||||||
The slit is a special Fluxbox window frame that can contain dockable
|
The slit is a special Fluxbox window frame that can contain dockable
|
||||||
applications, e.g. the `bbtools.'
|
applications, e.g. the `bbtools.'
|
||||||
|
@ -884,46 +861,96 @@ Sometimes, you want to force an application to have always the same dimensions,
|
||||||
position, and other settings. It is now possible with the new window-submenu
|
position, and other settings. It is now possible with the new window-submenu
|
||||||
called 'Remember...'. Settings are saved in the
|
called 'Remember...'. Settings are saved in the
|
||||||
.I ~/.fluxbox/apps
|
.I ~/.fluxbox/apps
|
||||||
file. You don't have to edit the file yourself as all manipulations can be
|
file. You don't have to edit the file yourself as most manipulations can be
|
||||||
done using the 'Remember...' submenu.
|
done using the 'Remember...' submenu.
|
||||||
|
.PP
|
||||||
|
The format of a line in the apps file is:
|
||||||
|
.PP
|
||||||
|
.nf
|
||||||
|
[app] (app-name) {count - optional}
|
||||||
|
[Property1] {value1}
|
||||||
|
[Property2] {value2}
|
||||||
|
...
|
||||||
|
[end]
|
||||||
|
.fi
|
||||||
|
.PP
|
||||||
|
Each
|
||||||
|
.B app-name
|
||||||
|
can be a string, or a regular expression. By default the name is matched
|
||||||
|
against a windows
|
||||||
|
.B WM_CLASS
|
||||||
|
property (the first string in it, called the "instance"). You can
|
||||||
|
match against the title, instance name (default), class name, or role
|
||||||
|
(WM_WINDOW_ROLE property) by explicitly specifying it. You can also
|
||||||
|
specify multiple matches, which must ALL match for the properties to be applied.
|
||||||
|
If a count is supplied in curly brackets at the end of the app line, then
|
||||||
|
the entry will only match at most count at any time (default is to match all matching windows).
|
||||||
|
Some example
|
||||||
|
.B [app]
|
||||||
|
lines are:
|
||||||
|
.PP
|
||||||
|
.nf
|
||||||
|
# match a standard xterm
|
||||||
|
[app] (xterm)
|
||||||
|
# match an xterm started like: xterm -name myshell
|
||||||
|
[app] (myshell)
|
||||||
|
# match any one Firefox window (the instance name is "Gecko")
|
||||||
|
[app] (class=Firefox-bin) {1}
|
||||||
|
# match the gaim buddy list window
|
||||||
|
[app] (role=buddy_list)
|
||||||
|
# match an rdesktop window to a particular host
|
||||||
|
[app] (title=rdesktop - hostname.*)
|
||||||
|
.fi
|
||||||
|
|
||||||
|
.PP
|
||||||
|
The following are the properties that can be defined in each
|
||||||
|
.B [app]
|
||||||
|
entry. Each name must be enclosed in square brackets, and the value
|
||||||
|
is generally in curly brackets.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
.B Workspace [0-N]
|
.B Workspace {0-N}
|
||||||
Force the workspace of the application to be the current one, even if you launch
|
Force the workspace of the application to be the current one, even if you launch
|
||||||
the application from another workspace.
|
the application from another workspace.
|
||||||
.TP
|
.TP
|
||||||
.B Dimensions [Width Height]
|
.B Dimensions {Width Height}
|
||||||
Remember the current dimensions.
|
Remember the current dimensions.
|
||||||
.TP
|
.TP
|
||||||
.B Position ([WINCENTER|CENTER|UPPERLEFT|UPPERRIGHT|LOWERLEFT|LOWERRIGHT]) [X Y]
|
.B Position ([WINCENTER|CENTER|UPPERLEFT|UPPERRIGHT|LOWERLEFT|LOWERRIGHT]) {X Y}
|
||||||
Remember the current position. X and Y are relative to e.g. WINCENTER .
|
Remember the current position. X and Y are relative to e.g. WINCENTER . Defaults to be relative to UPPERLEFT.
|
||||||
.TP
|
.TP
|
||||||
.B Shaded state [yes|no]
|
.B Layer {Layernum}
|
||||||
|
Specify the layer to open the window on (by number). Each layer has a number. The named ones are:
|
||||||
|
2-AboveDock, 4-Dock, 6-Top, 8-Normal, 10-Bottom, 12-Desktop.
|
||||||
|
.TP
|
||||||
|
.B Shaded {yes|no}
|
||||||
Remember the current shaded state.
|
Remember the current shaded state.
|
||||||
.TP
|
.TP
|
||||||
.B Tab state [yes|no]
|
.B Tab {yes|no}
|
||||||
Remember the current tab state.
|
Remember the current tab state.
|
||||||
.TP
|
.TP
|
||||||
.B IconHidden
|
.B IconHidden {yes|no}
|
||||||
hides the app from the icon bar
|
hides the app from the icon bar
|
||||||
.TP
|
.TP
|
||||||
.B FocusHidden
|
.B FocusHidden {yes|no}
|
||||||
hides the app from the list to be reachable via Next/PrevWindow
|
hides the app from the window cycling list to be reachable via Next/PrevWindow
|
||||||
.TP
|
.TP
|
||||||
.B Hidden
|
.B Hidden
|
||||||
is [IconHidden] + [FocusHidden]
|
is [IconHidden] + [FocusHidden]
|
||||||
.TP
|
.TP
|
||||||
.B Decoration state [NONE|NORMAL|TOOL|TINY]
|
.B Deco {NONE|NORMAL|TOOL|TINY|bitmask}
|
||||||
Remember the current decoration state.
|
Remember the current decoration state. There are several predefined decoration
|
||||||
|
sets, but a bitmask can be used for fine-grained control. The bits are (from "1" to (1<<10): titlebar, handle/grips, border, iconify button, maximize button, close button, menu enabled, sticky button, shade button, tabbing enabled, focus enabled.
|
||||||
.TP
|
.TP
|
||||||
.B Sticky state [yes|no]
|
.B Sticky {yes|no}
|
||||||
Remember the current sticky state.
|
Remember the current sticky state.
|
||||||
.TP
|
.TP
|
||||||
.B Jump to workspace [yes|no]
|
.B Jump {yes|no}
|
||||||
This one is only useful if 'Workspace' is set too. The workspace is changed
|
Jump to workspace - This one is only useful if 'Workspace' is set too. The workspace is changed
|
||||||
to the workspace containing the application being launched.
|
to the workspace containing the application being launched.
|
||||||
.TP
|
.TP
|
||||||
.B Save settings on close [yes|no]
|
.B Close {yes|no}
|
||||||
By default, application settings are not saved when a window is closed. Set
|
Save settings on close - By default, application settings are not saved when a window is closed. Set
|
||||||
this option if you want previous settings to be saved when the window is closed.
|
this option if you want previous settings to be saved when the window is closed.
|
||||||
.PP
|
.PP
|
||||||
The
|
The
|
||||||
|
@ -936,6 +963,18 @@ lines .
|
||||||
could be used to specify the screen, not the workspace, on which
|
could be used to specify the screen, not the workspace, on which
|
||||||
the application should started. startup is not yet setable by menu.
|
the application should started. startup is not yet setable by menu.
|
||||||
|
|
||||||
|
.PP
|
||||||
|
Finally, you can set windows to group together by using the
|
||||||
|
.B apps-file
|
||||||
|
. This is achieved by using a
|
||||||
|
.B [group]
|
||||||
|
tag around several
|
||||||
|
.B [app]
|
||||||
|
tags, with an
|
||||||
|
.B [end]
|
||||||
|
tag to indicate the end of the group. You can also specify dimensions, position
|
||||||
|
etc for the group as for normal app entries.
|
||||||
|
|
||||||
.SS Applications example
|
.SS Applications example
|
||||||
Here is a short example of an apps file:
|
Here is a short example of an apps file:
|
||||||
.PP
|
.PP
|
||||||
|
@ -952,14 +991,49 @@ Here is a short example of an apps file:
|
||||||
[Position] {16 0}
|
[Position] {16 0}
|
||||||
[Jump] {yes}
|
[Jump] {yes}
|
||||||
[end]
|
[end]
|
||||||
[app] (xterm)
|
# start all aterms with no decorations
|
||||||
|
[app] (aterm)
|
||||||
[Deco] {NONE}
|
[Deco] {NONE}
|
||||||
[end]
|
[end]
|
||||||
|
# a group with all windows called "special-term", appears on layer 4 (bottom)
|
||||||
|
[group]
|
||||||
|
[app] (special-term)
|
||||||
|
[Layer] {4}
|
||||||
|
[end]
|
||||||
.fi
|
.fi
|
||||||
|
|
||||||
Parameters in the 'apps' file are case-sensitive. Application names are taken
|
Parameters in the 'apps' file are case-sensitive. Application names are taken
|
||||||
from the first X-Window WM_CLASS attribute. You can see this attribute by using
|
from the first X-Window WM_CLASS attribute by default (WM_NAME = title, WM_WINDOW_ROLE = role). You can see these attributes by using
|
||||||
the xprop command. Transient windows are not affected by application settings.
|
the xprop command. Transient windows are not affected by application settings.
|
||||||
|
.\" --- groups ---
|
||||||
|
.SH GROUPS FILE
|
||||||
|
Since version 0.1.11, Fluxbox has a feature called autogrouping, that is apps are
|
||||||
|
automatically grouped together if they are in the same group.
|
||||||
|
Note that this feature is deprecated since version 0.9.1 in favour
|
||||||
|
of grouping using the apps file, since it is much more powerful.
|
||||||
|
.PP
|
||||||
|
You can create groups by editing the
|
||||||
|
.IR ~/.fluxbox/groups
|
||||||
|
file.
|
||||||
|
The file takes the format of:
|
||||||
|
.EX
|
||||||
|
<app1> <app2> <app3> ... <appN>
|
||||||
|
.EE
|
||||||
|
where elements can be found with this command:
|
||||||
|
.EX
|
||||||
|
xprop WM_CLASS
|
||||||
|
.EE
|
||||||
|
Just launch this command in a terminal and click on the desired app after. It will
|
||||||
|
tell you what to write as element.
|
||||||
|
Each line forms a different group, e.g:
|
||||||
|
.EX
|
||||||
|
Navigator nedit
|
||||||
|
xterm
|
||||||
|
.EE
|
||||||
|
This will create two groups, one with netscape and nedit, and one with xterm.
|
||||||
|
The new window will only group itself to other windows on the same workspace
|
||||||
|
and to the last window that was focused.
|
||||||
|
|
||||||
.SH ENVIRONMENT
|
.SH ENVIRONMENT
|
||||||
.TP
|
.TP
|
||||||
.B HOME
|
.B HOME
|
||||||
|
|
Loading…
Reference in a new issue