nilix/fluxbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added new `fluxbox-keys' man page

Browse source
This commit is contained in:
Jim Ramsay 2008-08-04 22:02:52 -07:00 committed by Mark Tiefenbruck
parent a2cd78563f
commit 0bdf33c1e5
7 changed files with 2633 additions and 1878 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
ChangeLog
View file

@ -1,6 +1,8 @@
(Format: Year/Month/Day)
Changes for 1.1
*08/08/05:
* Created new `fluxbox-keys' man page (thanks Jim Ramsay)
doc/asciidoc/fluxbox-keys.txt
* Make resize cursors consistent (thanks Dmitry E. Oboukhov)
FbWinFrameTheme.cc
*08/08/04:

2
doc/Makefile.am
View file

@ -5,7 +5,7 @@ SUBDIRS = ru
CLEANFILES = fluxbox.1 fluxstyle.1
MAINTAINERCLEANFILES = Makefile.in
man_MANS = fluxbox.1 fbsetroot.1 fbrun.1 fbsetbg.1 \
startfluxbox.1 fluxstyle.1 fbrun.1
startfluxbox.1 fluxstyle.1 fbrun.1 fluxbox-keys.5
EXTRA_DIST=fluxbox.1.in fbsetroot.1 fbrun.1 startfluxbox.1 fbsetbg.1 \
fluxstyle.1.in CODESTYLE
distclean-local:

677
doc/asciidoc/fluxbox-keys.txt Normal file
View file

@ -0,0 +1,677 @@
fluxbox-keys(5)
===============
Jim Ramsay <i.am@jimramsay.com>
v1.1.0, 22 July, 2008
NAME
----
fluxbox-keys - keyboard shortcuts configuration for fluxbox(1)
SYNOPSIS
--------
~/.fluxbox/keys
SYNTAX
------
Variable parameters are shown in emphasis: 'argument'
Optional parameters are shown in square brackets: ['argument']
All other characters shown are required verbatim. Whitespace is required
where shown, but it is fine to add more whitespace.
DESCRIPTION
-----------
The keys file defines the keyboard shortcuts for 'fluxbox(1)'.
You can customize fluxbox's key handling through the ~/.fluxbox/keys file. The
file consists of lines of the basic format:
*['modifiers'] 'key' :'command' ['arguments' '...']*
The space between the 'key' and the *:* before the 'command' is mandatory.
All modifiers and commands are case-insensitive. Some command arguments
(especially those that will be passed to the shell) are case-sensitive. Some
key names are case-sensitive.
Lines beginning with a '#' or '!' are considered comments and are unread by
fluxbox.
MODIFIERS
---------
You can get a list of possible modifiers by calling `xmodmap -pm'. This also
shows you to which keys the modifiers are mapped, but the following modifiers
are most commonly used:
*Shift Control Mod1 Mod4*
where *Mod1* is the Alt key on the PC keyboard and *Mod4* is usually a key
branded with a familiar company logo.
There are also some special modifiers that refer to mouse button presses:::
*OnDesktop*;;
The mouse cursor is over the desktop (root window), and not any
window.
*OnToolbar*;;
The mouse cursor is over the toolbar (which is normally at the bottom
of the screen).
*OnWindow*;;
The mouse cursor is over a window.
*OnTitlebar*;;
The mouse cursor is over a window's titlebar.
*Double*;;
Limits this action to double-clicks only.
Combining Modifiers
~~~~~~~~~~~~~~~~~~~
To combine two or more modifiers, just list them (space-delimited) in any
order.
KEYS
----
You may specify a key by its key name (for example, *a* or *space*) or by its
numeric keycode (for example, *38* or *0xf3*).
If you don't know the name of a key, you can run 'xev(1)' in a terminal, push
the key, and see the name in the output. If you have some "special" keys that
do not produce a key name in the output of 'xev(1)', you can just use the
keycode (NOT the keysym!) in your keys file.
Commands can also be bound to mouse button presses, for which the proper "key"
name is *Mouse*'n' where 'n' is the number of the mouse button. For example,
*Mouse1* is the primary button, and *Mouse4* / *Mouse5* are the scroll wheel
events, in normal configurations. 'xev(1)' can also be used to tell the button
number.
////////////////
There are some special "keys" that let you bind events to non-keyboard events:::
*ChangeWorkspace*;;
Fires when the workspace changes
TODO: Advanced users only?
*FocusIn* / *FocusOut*;;
Fires when the focus is given to or removed from a window. It may be
useful to combine this with the 'If' command, in the section *Special
Commands* below.
*MouseOver* / *MouseOut*;;
Fires when the mouse cursor enters or leaves a specific area of the
screen. It may be useful to combine this with the 'On*' modifiers
detailed above and/or the 'If' command.
////////////////
CHAINING
--------
Key bindings can be chained in a fashion similar to Emacs key bindings using the
syntax:
*'modifiers-1' 'key-1' 'modifiers-2' 'key-2' :'command' ['arguments ...']*
.To Bind CTRL+C CTRL+X (Which means, press CTRL+C then CTRL+X) to quit fluxbox
........
Control c Control x :Quit
........
KEYMODES
--------
A specific set of key mappings can be activated and de-activated on-the-fly
using what are called keymodes. The syntax to define a mapping in a keymode
is:
*'keymode': 'modifiers' 'key' :'command' ['arguments' '...']*
Where 'keymode' is any alpha-numeric string name.
When this keymode is activated (see the *KeyMode* command below), all bindings
prefaced by that keymode name become active (and all other keybindings will be
deactivated) until the keymode changes again.
COMMANDS
--------
Some commands have multiple names which are shown below as:::
CMD1 | CMD2
Related commands have been grouped below as:::
CMD1 / CMD2
The commands are broken up into sections as follows:::
- Mouse Commands
- Window Commands
- Workspace Commands
- Menu Commands
- Window Manager Commands
- Special Commands
Mouse Commands
~~~~~~~~~~~~~~
These commands may only be bound to mouse buttons (plus modifiers), not
keystrokes. In all cases, the action finishes when the mouse button is
released.
*StartMoving*::
Start dragging to move the window.
*StartResizing* ['corner']::
Start dragging to resize the window as if you had grabbed the window
at the specified 'corner'.
+
By default 'corner' is *BottomRight*, but may be overridden with one of:;;
*NearestCorner NearestEdge Center TopLeft Top TopRight Left Right BottomLeft
BottomRight*
*StartTabbing*::
Start dragging to add this window to another's tabgroup.
Window Commands
~~~~~~~~~~~~~~~
These commands affect only the currently focused window.
*Activate* | *Focus*::
Set the focus to the window matching the argument, and raise it.
*Minimize* | *MinimizeWindow* | *Iconify*::
Minimize the current window, equivalent to the window button.
*Maximize* | *MaximizeWindow*::
Maximize the current window, equivalent to the window button.
*MaximizeHorizontal* / *MaximizeVertical*::
Maximize the current window in one direction only, leaving the other
dimension unchanged.
*Raise* / *Lower*::
Reorder this window to the top or bottom of the window stack, within
its current layer. See 'fluxbox(1)' for a discussion of layers.
*RaiseLayer* / *LowerLayer*::
Raise the window up to the layer above, or lower it to the layer
below. See 'fluxbox(1)' for a discussion of layers.
*Close*::
Close the current window, equivalent to the window button.
*Kill* | *KillWindow*::
Close a window that's not responding to *Close*, like using `xkill`.
*Shade* | *ShadeWindow*::
Toggle the *shaded* state of the current window, equivalent to the
window button. A *shaded* window appears as only the title bar.
*ShadeOn* / *ShadeOff*::
Set the *shaded* state of the window to On / Off.
*Stick* | *StickWindow*::
Toggle the *sticky* state of the current window, equivalent to the
window button. A *sticky* window is visible on all workspaces.
*ToggleDecor*::
Toggles the presence of the window decorations (title bar, window
buttons, and resize bar).
*NextTab* / *PrevTab*::
Cycle to the next / previous tab in the current tab group.
*Tab* 'number'::
Cycle to the given tab in the current tab group, where *1* is the
first tab. A negative 'number' counts from the end of the tab group
(*-1* is the last tab, *-2* is the next-to-last, etc.).
*MoveTabRight* / *MoveTabLeft*::
Reorder the tabs in the current tab group, swapping the current tab
with the one to the right / left.
*DetachClient*::
Remove the current tab from the tab group, placing it in its own window.
*ResizeTo* 'width' 'height'::
Resizes the window to the given width and height.
*Resize* 'delta-width' 'delta-height'::
Resizes the window relative to the current width and height.
*ResizeHorizontal* 'delta-width' / *ResizeVertical* 'delta-height'::
Resizes the window in one dimension only
*MoveTo* 'x' 'y' ['anchor']::
Moves the window to the given coordinates, given in pixels.
+
If either 'x' or 'y' is set to *\**, that coordinate will be ignored, and the
movement will only take place in one dimension.
+
The default 'anchor' is the upper left corner, but this may be overridden with one of:;;
*UpperLeft LowerLeft UpperRight LowerRight*
*Move* 'delta-x' 'delta-y'::
Moves the window relative to its current position. Positive numbers
refer to right and down, and negative to left and up, respectively.
*MoveRight* 'd' / *MoveLeft* 'd' / *MoveUp* 'd' / *MoveDown* 'd'::
Moves the window relative to its current position by the number of
pixels specified in 'd'. If the number is negative, it moves in the
opposite direction.
*TakeToWorkspace* 'workspace' / *SendToWorkspace* 'workspace'::
Sends you along with the current window to the selected workspace.
SendToWorkspace just sends the window. The first workspace is number
*1*, not 0.
*TakeToNextWorkspace* ['offset'] / *TakeToPrevWorkspace* ['offset']::
Sends you along with the current window to the next or previous
workspace. If you set 'offset' to a value greater than the default of
*1*, it will move you that number of workspaces ahead or behind. If
you go beyond the end of the currently defined workspaces, it will
wrap around to the other end automatically.
*SendToNextWorkspace* ['offset'] / *SendToPrevWorkspace* ['offset']::
Identical to the "TakeTo..." commands, but again this sends only the
window, and does not move you away from your current workspace.
*SetAlpha* ['alpha' ['unfocused-alpha']]::
Sets the alpha value of a window.
+
Putting a *+* or *-* in front of
the value adds or subtracts from the current value. A plain integer
sets the value explicitly.
+
no arguments;;
Resets both focused and unfocused settings to default opacity.
one argument;;
Changes both focused and unfocused alpha settings.
two arguments;;
First value becomes the focused alpha, second becomes the unfocused
alpha value.
*SetHead* 'number'::
Moves the window to the given display head. Only available when fluxbox
has been compiled with Xinerama support.
Workspace Commands
~~~~~~~~~~~~~~~~~~
These commands affect the entire workspace (or "desktop" as it is sometimes
called).
*AddWorkspace* / *RemoveLastWorkspace*::
Adds or removes a workspace from the end of the list of workspaces.
*NextWorkspace* ['n'] / *PrevWorkspace* ['n'] / *RightWorkspace* ['n'] / *LeftWorkspace* ['n']::
Switch to the Next / Previous workspace. All versions accept an
offset value 'n', which defaults to *1* and refers to the number of
workspaces to move at one time. {Next,Prev}Workspace wrap around when
going past the last workspace, whereas {Right,Left}Workspace do not.
*Workspace* 'number'::
Jumps to the given workspace 'number'. The first workspace is *1*.
*NextWindow* [{'options'}] ['pattern'] / *PrevWindow* [{'options'}] ['pattern']::
Focuses and activates the next / previous window in the focus list.
+
'options' is one or more of the following, space delimited:;;
+
--
*static*;;
Instead of moving in order of most-recent focus, move in
order of when the window was opened (or, the order shown in
the iconbar).
*groups*;;
Only include the current tab in windows with multiple tabs.
--
+
If 'pattern' arguments are supplied, only windows that match all the
patterns are considered - all others are skipped. See the section *CLIENT
PATTERNS* below for more information.
+
This pair of commands has a special side-effect when the keybinding used has a
modifier - It will temporarily raise the cycled window to the front so you can
see it, but if you continue holding down the modifier and press the key again
(For example, keep holding "Alt" while you tap the "Tab" key a few times),
fluxbox will lower the window again when you move on to the next one. This
allows you to preview the windows in order, but does not change the order in
doing so.
*NextGroup* [{'options'}] ['pattern'] / *PrevGroup* [{'options'}] ['pattern']::
Equivalent to NextWindow / PrevWindow above, but with the *groups*
option forced on.
*GotoWindow* 'number' [{'options'}] ['pattern']::
Focuses and activates the window at position 'number' in the focus
list. The 'options' and 'pattern' arguments have the same meaning as
*NextWindow* above.
*Attach* 'pattern'::
Combines all windows that match the 'pattern' into a single tab group.
See *CLIENT PATTERNS* for more about the 'pattern' arguments.
*FocusLeft* / *FocusRight* / *FocusUp* / *FocusDown*::
Focus to the next window which is located in the direction specified.
*ArrangeWindows* 'pattern'::
Tries to arrange all windows on the current workspace so that they
overlap the least amount possible. See *CLIENT PATTERNS* for more about
the 'pattern' arguments.
*ShowDesktop*::
Iconifies all windows.
*Deiconify* 'mode' 'destination'::
Deiconifies windows (or, restores from a minimized state).
+
Where 'mode' may be one of:;;
+
--
*All*;;
All icons across all workspaces.
*AllWorkspace*;;
All icons on the current workspace.
*Last*;;
The last icon across all workspaces.
*LastWorkspace* (default);;
The last icon on the current workspace.
--
+
And 'destination' may be one of:;;
+
--
*Current* (default);;
Deiconify to the current workspace.
//////
TODO: Leave this out until it is stable!
*Origin*;;
Deiconify to the window's original workspace, and moves you
there.... sometimes?
//////
*OriginQuiet*;;
Deiconify to the window's original workspace, but does so in
the background, without moving you there.
--
*SetWorkspaceName* 'name' / *SetWorkspaceNameDialog*::
Sets the name of the current workspace.
*CloseAllWindows*::
Closes all windows on all desktops.
Menu Commands
~~~~~~~~~~~~~
These commands open or close fluxbox popup menus. For more information on
what these menus contain or how to configure them, see 'fluxbox(1)'.
*RootMenu* / *WorkspaceMenu* / *WindowMenu*::
Opens the specified menu. See fluxbox(1) for more details on what
these menus contain.
*ClientMenu* ['pattern']::
Opens a menu that contains all windows. If you specify a 'pattern',
only matching windows will be in the menu. See *CLIENT PATTERNS*
below for more details on the 'pattern' argument.
*CustomMenu* 'path'::
Opens a custom menu file.
*HideMenus*::
Hide all fluxbox popup menus.
Window Manager Commands
~~~~~~~~~~~~~~~~~~~~~~~
These commands affect the Window Manager, or more than one window.
*Restart* ['path']::
Restarts fluxbox. This does not close any running applications. If
the optional 'path' is a path to an executable window manager, that
manager is started in place of fluxbox.
*Quit* | *Exit*::
Exits fluxbox. This will normally cause X to stop as well and
terminate all existing applications, returning you to the login
manager or console.
*Reconfig* | *Reconfigure*::
Reloads all fluxbox configuration files including the keys file, apps
file, and init file, if they have changed.
*SetStyle* 'path'::
Sets the current style to that given in 'path', which must be the full
path to a fluxbox style.
*ReloadStyle*::
Reloads only the current style. Useful after editing a style which is
currently in use.
*ExecCommand* 'args ...' | *Exec* 'args ...' | *Execute* 'args ...'::
Probably the most-used binding of all. Passes all the arguments to
your *$SHELL* (or /bin/sh if $SHELL is not set). You can use this to
launch applications, run shell scripts, etc. Since all arguments are
passed verbatim to the shell, you can use environment variables,
pipes, or anything else the shell can do. Note that processes only
see environment variables that were set before fluxbox started (such
as in ~/.fluxbox/startup), or any that are set via the Export or
SetEnv commands, below.
*CommandDialog*::
Pops up a dialog box that lets you type in any of these commands
manually.
*SetEnv* 'name' 'value' | *Export* 'name'='value'::
Sets an environment variable in Fluxbox. It will be passed to any
applications spawned by any future ExecCommand commands.
*SetResourceValue* 'resourcename' 'resourcevalue' | *SetResourceValueDialog*::
Sets a fluxbox resource value, which are normally stored in the init
file. See 'fluxbox(1)' for more details on available resources and
allowed values.
Special Commands
~~~~~~~~~~~~~~~~
These commands have special meanings or behaviors.
*MacroCmd* {'command1'} {'command2'} {'command3'} '...'::
Allows you to execute more than one command with one keybinding. The
commands will be executed in series. The *{* *}* brackets are
literally required, as in the following example:
MacroCmd {MoveTo 0 0} {ResizeTo 1280 800}
*Delay* {'command'} ['microseconds']::
Delays running 'command' for the given amount of time. If the same
key binding is activated again, the timer will be restarted.
*ToggleCmd* {'command1'} {'command2'} '...'::
Alternates between the commands. On the first press of the bound
key, runs 'command1'. On the next press, runs 'command2'.
*BindKey* 'keybinding'::
Adds the given 'keybinding' (which must be a valid key binding as
defined in the DESCRIPTION section above) to your keys file.
*KeyMode* 'keymode' ['return-keybinding']::
Activates the named 'keymode' (or, all key binding lines prefaced
with the same 'keymode':) and deactivates all others until the
'return-keybinding' (by default *Escape*) is pressed. The default
keymode is named 'default'.
*ForEach* {'command'} [{'condition'}] | *Map* {'command'} [{'condition'}]::
Runs the given 'command' (normally one from the *Window Commands*
section above) on each window. If you specify a 'condition' (See
*Conditions*, below) the action will be limited to matching windows.
*If* {'condition'} {'then-command'} [{'else-command'}] | *Cond* {'condition'} {'then-command'} [{'else-command'}]::
If the 'condition' command returns *true*, then run the
'then-command', otherwise run the optional 'else-command'. See
*Conditions* below for more information on the 'condition' argument.
Conditions
~~~~~~~~~~
These special commands are used to match windows conditionally. They are
commonly used by the *If* and *ForEach* command.
*Matches* 'pattern'::
Returns *true* if the current window matches the given 'pattern'. See *CLIENT
PATTERNS* below for details on the 'pattern' syntax.
+
If your key binding uses the *OnWindow* modifier, it matches against the window
you clicked, not the currently focused window.
+
To check other windows besides the currently focused one, see the *Every* and
*Some* conditions below.
*Some* 'condition'::
Retuns *true* if any window on any workspace (not just the currently
focused one) matches the 'condition'.
*Every* 'condition'::
Retuns *true* if every window on every workspace (not just the
current one) matches the 'condition'.
*Not* 'condition'::
Returns *true* if 'condition' returns *false*, and vice-versa.
*And* {'condition1'} {'condition2'} [{'condition3'} ...]::
Returns *true* if and only if all given conditions return *true*.
*Or* {'condition1'} {'condition2'} [{'condition3'} ...]::
Returns *true* if any of the listed conditions return *true*.
*Xor* {'condition1'} {'condition2'} [{'condition3'} ...]::
Returns the boolean *xor* of the truth values for all conditions
listed.
CLIENT PATTERNS
---------------
Many of the more advanced commands take a 'pattern' argument, which allows you
to direct the action at a specific window or set of windows which match the
properties specified in the 'pattern'. A 'pattern' looks like this:
(['propertyname'[!]=]'regexp') ...
That is, one or more match definitions, followed by an optional limit on the
number of windows to match.
Match definitions are enclosed in parentheses *(*...*)*, and if no
'propertyname' is given then *Name* is assumed. The 'regexp' can contain any
regular expression, or the special value *[current]*, which matches the
corresponding value of the currently focused window. See 'regex(7)' for more
information on acceptable regular expressions.
You can use *=* to test for equality or *!=* to test for inequality.
The following values are accepted for 'propertyname':::
*Name*;;
A string, corresponding to the CLASSNAME property.
*Class*;;
A string, corresponding to the CLASSCLASS property.
*Title*;;
A string, corresponding to the window title.
*Role*;;
A string, corresponding to the ROLE property.
*Transient*;;
Either *yes* or *no*, depending on whether the window is transient
(typically, a popup dialog) or not.
*Maximized*;;
Either *yes* or *no*, depending on whether the window is maximized or
not.
*Minimized*;;
Either *yes* or *no*, depending on whether the window is minimized
(iconified) or not.
*Shaded*;;
Either *yes* or *no*, depending on whether the window is shaded or
not.
*Stuck*;;
Either *yes* or *no*, depending on whether the window is sticky (on
all workspaces) or not.
*FocusHidden*;;
Either *yes* or *no*, depending on whether the window has asked to be
left off the focus list (or, the alt-tab list), or not.
*IconHidden*;;
Either *yes* or *no*, depending on whether the window has asked to be
left off the icon list (or, the taskbar), or not.
*Urgent*;;
Either *yes* or *no*, depending on whether the window has the urgent
hint set.
*Workspace*;;
A number corresponding to the workspace number to which the window is
attached. The first workspace here is *0*.
*WorkspaceName*;;
A string corresponding to the name of the workspace to which the
window is attached.
*Head*;;
The number of the display head to which the window is attached. You
may match this against the special value *[mouse]* which refers to the
head where the mouse pointer currently resides.
*Layer*;;
The string name of the window's layer, which is one of
*Above Dock*, *Dock*, *Top*, *Normal*, *Bottom*, *Desktop*
.Matches any windows with the CLASSNAME of "xterm"
..........
(xterm)
..........
.Matches any windows with the same CLASSNAME as the currently focused window
..........
(Name=[current])
..........
.Matches any windows on the same head as the mouse but on a different layer than the currently focused window
...........
(Head=[mouse]) (Layer!=[current])
...........
FILES
-----
~/.fluxbox/keys::
This is the default location for the keybinding definitions.
/usr/X11R6/include/X11/keysymdef.h::
X key names are in this file.
/usr/X11R6/lib/X11/XKeysymDB::
X key names are also in this file.
RESOURCES
---------
session.keyFile: <location>::
This may be set to override the location of the keybinding definitions.
ENVIRONMENT
-----------
Remember that *ExecCommand* command can take advantage of other environment
variables if they are set before fluxbox is started, or via the *Export* or
*SetEnv* commands. For example, if *$TERM* is set, it could be use like this:
...........................
Mod1 x :ExecCommand $TERM
...........................
For more information about environment variables, see your shell's manual.
EXAMPLES
--------
Here are some interesting and/or useful examples you can do with your keys
file.
..................
# Mod4+drag moves a window
OnWindow Mod4 Mouse1 :StartMoving
# If any xterm windows are open, cycle through them. If none are open, open
# one:
Mod4 t :If {Some Matches (xterm)} {NextWindow (xterm)} {Exec xterm}
# Set a different wallpaper on every workspace:
ChangeWorkspace :Exec fbsetbg ~/.fluxbox/bg$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}').png
..................
AUTHOR and CREDITS
------------------
This manpage is the combined work of:
- Jim Ramsay <i.am at jimramsay com> (>fluxbox-1.0.0)
- Curt Micol <asenchi at asenchi com> (>fluxbox-0.9.11)
- Tobias Klausmann <klausman at users sourceforge net> (<=fluxbox-0.9.11)
- Grubert <grubert at users sourceforge net> (fluxbox)
- Matthew Hawkins <matt at mh dropbear id au> (blackbox)
- Wilbert Berendsen <wbsoft at xs4all nl> (blackbox)
- Numerous other languages could be available if someone jumps in.
SEE ALSO
--------
fluxbox(1), xev(1), xkill(1), regex(7)

459
doc/asciidoc/fluxbox.1
View file

@ -1,11 +1,11 @@
.\" Title: fluxbox
.\" Author:
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\" Date: 06/03/2008
.\" Date: 08/04/2008
.\" Manual:
.\" Source:
.\"
.TH "FLUXBOX" "1" "06/03/2008" "" ""
.TH "FLUXBOX" "1" "08/04/2008" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@ -1091,457 +1091,8 @@ session\.titlebar\.right: Minimize Maximize Close
.fi
.RE
.SH "KEYS"
You can customize fluxbox\'s key handling through the ~/\.fluxbox/keys file\. The file takes the format of:
You can customize fluxbox\'s key handling through the ~/\.fluxbox/keys file\. See \fIfluxbox\-keys(5)\fR for more information on the syntax of this file\.
.sp
.sp
.RS 4
.nf
[keymode:] <modifier> <key> :<command> <operation>
.fi
.RE
In the example below, Mod1 is the \fIALT\fR key on the PC keyboard and Mod4 is one of the three extra keys on a pc104 branded with a familiar company logo\. Lines beginning with a \fI#\fR or \fI!\fR are considered comments and unread by fluxbox\.
.sp
You can get a list of possible modifiers by calling \fIxmodmap \-pm\fR\. This also shows you to which keys the modifiers are mapped\. Additionally there is the \fIOnDesktop\fR modifier\. To find valid keynames check the following files:
.sp
.sp
.RS 4
.nf
/usr/X11R6/include/X11/keysymdef\.h
/usr/X11R6/lib/X11/XKeysymDB
.fi
.RE
Furthermore you can use Mouse1, Mouse2, etc to define actions for your mouse buttons\.
.sp
.sp
.RS 4
.nf
# fluxbox keys file\.
Mod1 Tab :NextWindow
Mod1 Shift Tab :PrevWindow
Mod1 F1 :Workspace 1
Mod1 F2 :Workspace 2
Mod1 F3 :Workspace 3
Mod1 F4 :Workspace 4
Mod1 F5 :Workspace 5
Mod1 F6 :Workspace 6
Mod1 F7 :Workspace 7
Mod1 F8 :Workspace 8
Mod1 F9 :Workspace 9
Mod4 b :PrevWorkspace
Mod4 c :Minimize
Mod4 r :ExecCommand rxvt
Mod4 v :NextWorkspace
Mod4 x :Close
Mod4 m :RootMenu
Control n Mod1 n :NextTab
.fi
.RE
As you can see from the last line, keybindings can be chained in a fashion similar to Emacs keybindings\.
.sp
Some things to know: \- Commands are case\-insensitive\. \- Workspace numbering starts at "1"\. \- Some commands have synonyms\. \- The space between the last key and the :Command is mandatory\.
.sp
Here are fluxbox key commands to use:
.sp
.SS "Window Manager Commands"
.sp
.RS 4
\h'-04'\(bu\h'+03'Restart <argument>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Quit
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Reconfigure
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'SetStyle <argument>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'ExecCommand <argument>
.RE
.SS "Currently Focused Window Commands"
.sp
.RS 4
\h'-04'\(bu\h'+03'Minimize
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'MinimizeWindow
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Iconify
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Maximize
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'MaximizeWindow
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'MaximizeHorizontal
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'MaximizeVertical
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'ResizeTo <width> <height>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Resize <delta\-width> <delta\-height>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'ResizeHorizontal <delta\-width>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'ResizeVertical <delta\-height>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'MoveTo <x> <y>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Move <delta\-x> <delta\-y>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'MoveRight <delta\-x>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'MoveLeft <delta\-x>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'MoveUp <delta\-y>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'MoveDown <delta\-y>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Raise
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Lower
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Close
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Shade
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'ShadeWindow
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Stick
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'StickWindow
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'ToggleDecor
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'TakeToWorkspace <number>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'TakeToNextWorkspace <offset>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'TakeToPrevWorkspace <offset>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'SendToWorkspace <number>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'SendToNextWorkspace <offset>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'SendToPrevWorkspace <offset>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'KillWindow
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'NextTab
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'PrevTab
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'MoveTabLeft
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'MoveTabRight
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'DetachClient
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'SetAlpha [[\-]<int> [[\-]<int>]]
.RE
.SS "Workspace Commands"
.sp
.RS 4
\h'-04'\(bu\h'+03'NextWorkspace
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'PrevWorkspace
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'RightWorkspace <by\-number>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'LeftWorkspace <by\-number>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Workspace <number>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'NextWindow <bitmask>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'PrevWindow <bitmask>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'NextGroup <by\-number>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'PrevGroup <by\-number>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'FocusLeft
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'FocusRight
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'FocusUp
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'FocusDown
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'ArrangeWindows
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'ShowDesktop (Iconifies all windows)
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Deiconify all|allworkspace|last|lastworkspace current|origin|originquiet
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'RootMenu
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'WorkspaceMenu
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'WindowMenu
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'HideMenu
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'CustomMenu <path_to_file>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'SetWorkspaceName <name>
.RE
.SS "Special Commands"
.sp
.RS 4
\h'-04'\(bu\h'+03'MacroCmd
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'ToggleCmd
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'ReloadStyle
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'SetResourceValue <resourcename> <resource> value
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'BindKey <key><value>: <action>
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'KeyMode <keymode name> <return key sequence>
.RE
.SS "Couple of things"
.sp
.RS 4
\h'-04'\(bu\h'+03'Exec: fluxbox utilizes /bin/sh to start the commands\. This means, that you can use environment variables to do some tricks here\. E\.g: :Exec $XTERM This would fire up the term of your choice, if you set XTERM to something usefull
\fIbefore\fR
fluxbox starts, e\.g\. in the \.fluxbox/startup file\.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'TakeToWorkspace: Will send you along with the window to the selected workspace\. SendToWorkspace just sends the window\.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'TakeToNextWorkspace <offset>: Will send you and the window to workspace number <current offset>; that is, move you and the window <offset> spaces to the right (offset defaults to 1)\. SendToNextWorkspace does the same, except that it only sends the window (as for SendToWorkspace)\. TakeToPrevWorkspace and SendToPrevWorkspace work similarly, except moving to the previous workspaces, not the next ones\.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'PrevWindow/NextWindow parameters take an integer: 0 or unspecified = Default/current behavior \- most recently used\. 1 = Groups instead of Windows \- only visit one tab in each group 2 = Skip stuck windows 4 = Skip shaded windows 8 = Switch between windows `linearly\'; that is, if you repeatedly press the NextWindow key, you will walk through all windows in the, order that they were opened, instead of switching back and forth between the most recently focused windows\. 16 = Skip iconified windows
.sp
.RS 4
.nf
To combine any of these effects, add the corresponding numbers\.
For instance, 14 means switch linearly, skipping stuck and shaded
windows, since 14 = 8 + 4 + 2\.
.fi
.RE
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Bindkey will append key string and action to your keys file and bind the key\.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'KeyMode allows you to have different keybindings that aren\'t all active at the same time\. For instance, you can use `KeyMode Xnest\' to switch to the `Xnest\' key mode, which will disable all of your key bindings that don\'t have `Xnest:
\fI before them and will enable all the ones that do\. <return key sequence> will then return you to the `default\fR
key mode\. If not provided, this defaults to the escape key\.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'The
\fIdelta\fR
value means the difference between the current setting and the requested setting\. So if you have a window that is 100 pixels wide, you could set
.RE
.sp
.RS 4
.nf
Mod1 r :ResizeHorizontal 10
.fi
.RE
and when you use that key it would increase the size of your window to 110 pixels\. If you had used
.sp
.sp
.RS 4
.nf
Mod1 R :ResizeHorizontal \-10
.fi
.RE
then it would have decreased the size by 10, setting it to 90 pixels\.
.sp
.sp
.RS 4
\h'-04'\(bu\h'+03'Resize commands do not necessarily change the number of pixels\. For instance, many terminals will use the size of a character as the resize unit\. Most applications, however, use pixels\.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'MacroCmd:
.RE
.sp
.RS 4
.nf
Mod1 r :MacroCmd {command1} {command2}
.fi
.RE
.sp
.RS 4
.nf
allows you to execute more than one command with one keybinding\. The commands
will be executed in serial\.
.fi
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'ToggleCmd:
.RE
.sp
.RS 4
.nf
Mod1 t :ToggleCmd {command1} {command2}
.fi
.RE
.sp
.RS 4
.nf
alternates between the given commands each time you press Mod1 + t\.
.fi
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'SetAlpha [[\-]<int> [[\-]<int>]]: Works on the currently focussed window\. Given
.sp
.RS 4
\h'-04'\(bu\h'+03'no arguments: reset to default alpha settings
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'one argument: changes both focused and unfocused alpha settings
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'two arguments: first value becomes the focused alpha, second becomes the unfocused alpha value\. E\.g: SetAlpha 127 +5 will set the focused alpha to 127 and increment the unfocused alpha by 5 (until it reaches 255)
.RE
.RE
.SH "LAYERS"
Layers affect the way that windows will overlap each other on the screen\. Windows on a higher layer will always appear above those on a lower one, whether they are focused or not\. By default, fluxbox uses 13 layers, starting from 1 (highest)\. The number of layers can be changed by using the following resource:
.sp
@ -2044,7 +1595,7 @@ This manpage is the combined work of:
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Tobias Klausmann <klausman at users sourceforge net> (<=fluxbox\-0\.9\.11)
\h'-04'\(bu\h'+03'Tobias Klausmann <klausman at users sourceforge net> (⇐fluxbox\-0\.9\.11)
.RE
.sp
.RS 4
@ -2066,5 +1617,5 @@ This manpage is the combined work of:
If you find any bugs, please visit the #fluxbox irc channel on irc\.freenode\.net or submit them to the bug tracker at http://sf\.net/projects/fluxbox \. Or you may subscribe to one of the mailinglists\. More information can be found on the official website\.
.sp
.SH "SEE ALSO"
bsetroot(1) fbsetbg(1) fbrun(1) fluxstyle(1)
fluxbox\-keys(5) bsetroot(1) fbsetbg(1) fbrun(1) fluxstyle(1)
.sp

232
doc/asciidoc/fluxbox.txt
View file

@ -1015,234 +1015,8 @@ session.titlebar.right: Minimize Maximize Close
KEYS
----
You can customize fluxbox's key handling through the ~/.fluxbox/keys file. The
file takes the format of:
[keymode:] <modifier> <key> :<command> <operation>
In the example below, Mod1 is the 'ALT' key on the PC keyboard and Mod4 is one
of the three extra keys on a pc104 branded with a familiar company logo. Lines
beginning with a '#' or '!' are considered comments and unread by fluxbox.
You can get a list of possible modifiers by calling 'xmodmap -pm'. This also
shows you to which keys the modifiers are mapped. Additionally there is the
'OnDesktop' modifier. To find valid keynames check the following files:
/usr/X11R6/include/X11/keysymdef.h
/usr/X11R6/lib/X11/XKeysymDB
Furthermore you can use Mouse1, Mouse2, etc to define actions for your mouse
buttons.
............................
# fluxbox keys file.
Mod1 Tab :NextWindow
Mod1 Shift Tab :PrevWindow
Mod1 F1 :Workspace 1
Mod1 F2 :Workspace 2
Mod1 F3 :Workspace 3
Mod1 F4 :Workspace 4
Mod1 F5 :Workspace 5
Mod1 F6 :Workspace 6
Mod1 F7 :Workspace 7
Mod1 F8 :Workspace 8
Mod1 F9 :Workspace 9
Mod4 b :PrevWorkspace
Mod4 c :Minimize
Mod4 r :ExecCommand rxvt
Mod4 v :NextWorkspace
Mod4 x :Close
Mod4 m :RootMenu
Control n Mod1 n :NextTab
............................
As you can see from the last line, keybindings can be chained in a fashion
similar to Emacs keybindings.
Some things to know:
- Commands are case-insensitive.
- Workspace numbering starts at "1".
- Some commands have synonyms.
- The space between the last key and the :Command is mandatory.
Here are fluxbox key commands to use:
Window Manager Commands
~~~~~~~~~~~~~~~~~~~~~~~
- Restart <argument>
- Quit
- Reconfigure
- SetStyle <argument>
- ExecCommand <argument>
Currently Focused Window Commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Minimize
- MinimizeWindow
- Iconify
- Maximize
- MaximizeWindow
- MaximizeHorizontal
- MaximizeVertical
- ResizeTo <width> <height>
- Resize <delta-width> <delta-height>
- ResizeHorizontal <delta-width>
- ResizeVertical <delta-height>
- MoveTo <x> <y>
- Move <delta-x> <delta-y>
- MoveRight <delta-x>
- MoveLeft <delta-x>
- MoveUp <delta-y>
- MoveDown <delta-y>
- Raise
- Lower
- Close
- Shade
- ShadeWindow
- Stick
- StickWindow
- ToggleDecor
- TakeToWorkspace <number>
- TakeToNextWorkspace <offset>
- TakeToPrevWorkspace <offset>
- SendToWorkspace <number>
- SendToNextWorkspace <offset>
- SendToPrevWorkspace <offset>
- KillWindow
- NextTab
- PrevTab
- MoveTabLeft
- MoveTabRight
- DetachClient
- SetAlpha [[+-]<int> [[+-]<int>]]
Workspace Commands
~~~~~~~~~~~~~~~~~~
- NextWorkspace
- PrevWorkspace
- RightWorkspace <by-number>
- LeftWorkspace <by-number>
- Workspace <number>
- NextWindow <bitmask>
- PrevWindow <bitmask>
- NextGroup <by-number>
- PrevGroup <by-number>
- FocusLeft
- FocusRight
- FocusUp
- FocusDown
- ArrangeWindows
- ShowDesktop (Iconifies all windows)
- Deiconify all|allworkspace|last|lastworkspace current|origin|originquiet
- RootMenu
- WorkspaceMenu
- WindowMenu
- HideMenu
- CustomMenu <path_to_file>
- SetWorkspaceName <name>
Special Commands
~~~~~~~~~~~~~~~~
- MacroCmd
- ToggleCmd
- ReloadStyle
- SetResourceValue <resourcename> <resource> value
- BindKey <key><value>: <action>
- KeyMode <keymode name> <return key sequence>
Couple of things
~~~~~~~~~~~~~~~~
- Exec:
fluxbox utilizes /bin/sh to start the commands. This means, that
you can use environment variables to do some tricks here. E.g:
:Exec $XTERM
This would fire up the term of your choice, if you set XTERM to
something usefull _before_ fluxbox starts, e.g. in the .fluxbox/startup
file.
- TakeToWorkspace:
Will send you along with the window to the selected workspace.
SendToWorkspace just sends the window.
- TakeToNextWorkspace <offset>:
Will send you and the window to workspace number <current +
offset>; that is, move you and the window <offset> spaces to the
right (offset defaults to 1). SendToNextWorkspace does the same,
except that it only sends the window (as for SendToWorkspace).
TakeToPrevWorkspace and SendToPrevWorkspace work similarly, except
moving to the previous workspaces, not the next ones.
- PrevWindow/NextWindow parameters take an integer:
0 or unspecified = Default/current behavior - most recently used.
1 = Groups instead of Windows - only visit one tab in each group
2 = Skip stuck windows
4 = Skip shaded windows
8 = Switch between windows `linearly'; that is, if you repeatedly
press the NextWindow key, you will walk through all windows in the,
order that they were opened, instead of switching back and forth
between the most recently focused windows.
16 = Skip iconified windows
To combine any of these effects, add the corresponding numbers.
For instance, 14 means switch linearly, skipping stuck and shaded
windows, since 14 = 8 + 4 + 2.
- Bindkey will append key string and action to your keys file and bind the key.
- KeyMode allows you to have different keybindings that aren't all active at the
same time. For instance, you can use `KeyMode Xnest' to switch to the `Xnest'
key mode, which will disable all of your key bindings that don't have
`Xnest: ' before them and will enable all the ones that do.
<return key sequence> will then return you to the `default' key mode. If not
provided, this defaults to the escape key.
- The 'delta' value means the difference between the current setting and the
requested setting. So if you have a window that is 100 pixels wide, you could
set
..........................
Mod1 r :ResizeHorizontal 10
............................
and when you use that key it would increase the size of your window
to 110 pixels. If you had used
.............................
Mod1 R :ResizeHorizontal -10
.............................
then it would have decreased the size by 10, setting it to 90 pixels.
- Resize commands do not necessarily change the number of pixels. For
instance, many terminals will use the size of a character as the resize
unit. Most applications, however, use pixels.
- MacroCmd:
......................................
Mod1 r :MacroCmd {command1} {command2}
......................................
allows you to execute more than one command with one keybinding. The commands
will be executed in serial.
- ToggleCmd:
.......................................
Mod1 t :ToggleCmd {command1} {command2}
.......................................
alternates between the given commands each time you press Mod1 + t.
- SetAlpha [[+-]<int> [[+-]<int>]]:
Works on the currently focussed window. Given
* no arguments: reset to default alpha settings
* one argument: changes both focused and unfocused alpha settings
* two arguments: first value becomes the focused alpha, second becomes
the unfocused alpha value.
E.g: SetAlpha 127 +5 will set the focused alpha to 127 and increment the
unfocused alpha by 5 (until it reaches 255)
You can customize fluxbox's key handling through the ~/.fluxbox/keys file.
See 'fluxbox-keys(5)' for more information on the syntax of this file.
LAYERS
------
@ -1736,5 +1510,5 @@ mailinglists. More information can be found on the official website.
SEE ALSO
--------
bsetroot(1) fbsetbg(1) fbrun(1) fluxstyle(1)
fluxbox-keys(5) bsetroot(1) fbsetbg(1) fbrun(1) fluxstyle(1)

981
doc/fluxbox-keys.5 Normal file
View file

@ -0,0 +1,981 @@
.\" Title: fluxbox-keys
.\" Author:
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\" Date: 08/04/2008
.\" Manual:
.\" Source:
.\"
.TH "FLUXBOX\-KEYS" "5" "08/04/2008" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
fluxbox-keys - keyboard shortcuts configuration for fluxbox(1)
.SH "SYNOPSIS"
~/\.fluxbox/keys
.sp
.SH "SYNTAX"
Variable parameters are shown in emphasis: \fIargument\fR
.sp
Optional parameters are shown in square brackets: [\fIargument\fR]
.sp
All other characters shown are required verbatim\. Whitespace is required where shown, but it is fine to add more whitespace\.
.sp
.SH "DESCRIPTION"
The keys file defines the keyboard shortcuts for \fIfluxbox(1)\fR\.
.sp
You can customize fluxbox\'s key handling through the ~/\.fluxbox/keys file\. The file consists of lines of the basic format:
.sp
\fB[\fR\fB\fImodifiers\fR\fR\fB] \fR\fB\fIkey\fR\fR\fB :\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIarguments\fR\fR\fB \fR\fB\fI\&...\fR\fR\fB]\fR
.sp
The space between the \fIkey\fR and the \fB:\fR before the \fIcommand\fR is mandatory\.
.sp
All modifiers and commands are case\-insensitive\. Some command arguments (especially those that will be passed to the shell) are case\-sensitive\. Some key names are case\-sensitive\.
.sp
Lines beginning with a \fI#\fR or \fI!\fR are considered comments and are unread by fluxbox\.
.sp
.SH "MODIFIERS"
You can get a list of possible modifiers by calling `xmodmap \-pm\'\. This also shows you to which keys the modifiers are mapped, but the following modifiers are most commonly used:
.sp
\fBShift Control Mod1 Mod4\fR
.sp
where \fBMod1\fR is the Alt key on the PC keyboard and \fBMod4\fR is usually a key branded with a familiar company logo\.
.PP
There are also some special modifiers that refer to mouse button presses:
.RS 4
.PP
\fBOnDesktop\fR
.RS 4
The mouse cursor is over the desktop (root window), and not any window\.
.RE
.PP
\fBOnToolbar\fR
.RS 4
The mouse cursor is over the toolbar (which is normally at the bottom of the screen)\.
.RE
.PP
\fBOnWindow\fR
.RS 4
The mouse cursor is over a window\.
.RE
.PP
\fBOnTitlebar\fR
.RS 4
The mouse cursor is over a window\'s titlebar\.
.RE
.PP
\fBDouble\fR
.RS 4
Limits this action to double\-clicks only\.
.RE
.RE
.SS "Combining Modifiers"
To combine two or more modifiers, just list them (space\-delimited) in any order\.
.sp
.SH "KEYS"
You may specify a key by its key name (for example, \fBa\fR or \fBspace\fR) or by its numeric keycode (for example, \fB38\fR or \fB0xf3\fR)\.
.sp
If you don\'t know the name of a key, you can run \fIxev(1)\fR in a terminal, push the key, and see the name in the output\. If you have some "special" keys that do not produce a key name in the output of \fIxev(1)\fR, you can just use the keycode (NOT the keysym!) in your keys file\.
.sp
Commands can also be bound to mouse button presses, for which the proper "key" name is \fBMouse\fR\fIn\fR where \fIn\fR is the number of the mouse button\. For example, \fBMouse1\fR is the primary button, and \fBMouse4\fR / \fBMouse5\fR are the scroll wheel events, in normal configurations\. \fIxev(1)\fR can also be used to tell the button number\.
.sp
.SH "CHAINING"
Key bindings can be chained in a fashion similar to Emacs key bindings using the syntax:
.sp
\fB\fImodifiers\-1\fR\fR\fB \fR\fB\fIkey\-1\fR\fR\fB \fR\fB\fImodifiers\-2\fR\fR\fB \fR\fB\fIkey\-2\fR\fR\fB :\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIarguments \&...\fR\fR\fB]\fR
.PP
\fBExample\ 1.\ To Bind CTRL+C CTRL+X (Which means, press CTRL+C then CTRL+X) to quit fluxbox\fR
.sp
.RS 4
.nf
Control c Control x :Quit
.fi
.RE
.SH "KEYMODES"
A specific set of key mappings can be activated and de\-activated on\-the\-fly using what are called keymodes\. The syntax to define a mapping in a keymode is:
.sp
\fB\fIkeymode\fR\fR\fB: \fR\fB\fImodifiers\fR\fR\fB \fR\fB\fIkey\fR\fR\fB :\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIarguments\fR\fR\fB \fR\fB\fI\&...\fR\fR\fB]\fR
.sp
Where \fIkeymode\fR is any alpha\-numeric string name\.
.sp
When this keymode is activated (see the \fBKeyMode\fR command below), all bindings prefaced by that keymode name become active (and all other keybindings will be deactivated) until the keymode changes again\.
.sp
.SH "COMMANDS"
.PP
Some commands have multiple names which are shown below as:
.RS 4
CMD1 | CMD2
.RE
.PP
Related commands have been grouped below as:
.RS 4
CMD1 / CMD2
.RE
.PP
The commands are broken up into sections as follows:
.RS 4
.sp
.RS 4
\h'-04'\(bu\h'+03'Mouse Commands
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Window Commands
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Workspace Commands
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Menu Commands
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Window Manager Commands
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Special Commands
.RE
.RE
.SS "Mouse Commands"
These commands may only be bound to mouse buttons (plus modifiers), not keystrokes\. In all cases, the action finishes when the mouse button is released\.
.PP
\fBStartMoving\fR
.RS 4
Start dragging to move the window\.
.RE
.PP
\fBStartResizing\fR [\fIcorner\fR]
.RS 4
Start dragging to resize the window as if you had grabbed the window at the specified
\fIcorner\fR\.
.PP
By default \fIcorner\fR is \fBBottomRight\fR, but may be overridden with one of:
.RS 4
\fBNearestCorner NearestEdge Center TopLeft Top TopRight Left Right BottomLeft BottomRight\fR
.RE
.RE
.PP
\fBStartTabbing\fR
.RS 4
Start dragging to add this window to another\'s tabgroup\.
.RE
.SS "Window Commands"
These commands affect only the currently focused window\.
.PP
\fBActivate\fR | \fBFocus\fR
.RS 4
Set the focus to the window matching the argument, and raise it\.
.RE
.PP
\fBMinimize\fR | \fBMinimizeWindow\fR | \fBIconify\fR
.RS 4
Minimize the current window, equivalent to the window button\.
.RE
.PP
\fBMaximize\fR | \fBMaximizeWindow\fR
.RS 4
Maximize the current window, equivalent to the window button\.
.RE
.PP
\fBMaximizeHorizontal\fR / \fBMaximizeVertical\fR
.RS 4
Maximize the current window in one direction only, leaving the other dimension unchanged\.
.RE
.PP
\fBRaise\fR / \fBLower\fR
.RS 4
Reorder this window to the top or bottom of the window stack, within its current layer\. See
\fIfluxbox(1)\fR
for a discussion of layers\.
.RE
.PP
\fBRaiseLayer\fR / \fBLowerLayer\fR
.RS 4
Raise the window up to the layer above, or lower it to the layer below\. See
\fIfluxbox(1)\fR
for a discussion of layers\.
.RE
.PP
\fBClose\fR
.RS 4
Close the current window, equivalent to the window button\.
.RE
.PP
\fBKill\fR | \fBKillWindow\fR
.RS 4
Close a window that\'s not responding to
\fBClose\fR, like using
xkill\.
.RE
.PP
\fBShade\fR | \fBShadeWindow\fR
.RS 4
Toggle the
\fBshaded\fR
state of the current window, equivalent to the window button\. A
\fBshaded\fR
window appears as only the title bar\.
.RE
.PP
\fBShadeOn\fR / \fBShadeOff\fR
.RS 4
Set the
\fBshaded\fR
state of the window to On / Off\.
.RE
.PP
\fBStick\fR | \fBStickWindow\fR
.RS 4
Toggle the
\fBsticky\fR
state of the current window, equivalent to the window button\. A
\fBsticky\fR
window is visible on all workspaces\.
.RE
.PP
\fBToggleDecor\fR
.RS 4
Toggles the presence of the window decorations (title bar, window buttons, and resize bar)\.
.RE
.PP
\fBNextTab\fR / \fBPrevTab\fR
.RS 4
Cycle to the next / previous tab in the current tab group\.
.RE
.PP
\fBTab\fR \fInumber\fR
.RS 4
Cycle to the given tab in the current tab group, where
\fB1\fR
is the first tab\. A negative
\fInumber\fR
counts from the end of the tab group (\fB\-1\fR
is the last tab,
\fB\-2\fR
is the next\-to\-last, etc\.)\.
.RE
.PP
\fBMoveTabRight\fR / \fBMoveTabLeft\fR
.RS 4
Reorder the tabs in the current tab group, swapping the current tab with the one to the right / left\.
.RE
.PP
\fBDetachClient\fR
.RS 4
Remove the current tab from the tab group, placing it in its own window\.
.RE
.PP
\fBResizeTo\fR \fIwidth\fR \fIheight\fR
.RS 4
Resizes the window to the given width and height\.
.RE
.PP
\fBResize\fR \fIdelta\-width\fR \fIdelta\-height\fR
.RS 4
Resizes the window relative to the current width and height\.
.RE
.PP
\fBResizeHorizontal\fR \fIdelta\-width\fR / \fBResizeVertical\fR \fIdelta\-height\fR
.RS 4
Resizes the window in one dimension only
.RE
.PP
\fBMoveTo\fR \fIx\fR \fIy\fR [\fIanchor\fR]
.RS 4
Moves the window to the given coordinates, given in pixels\.
.sp
If either
\fIx\fR
or
\fIy\fR
is set to
\fB*\fR, that coordinate will be ignored, and the movement will only take place in one dimension\.
.PP
The default \fIanchor\fR is the upper left corner, but this may be overridden with one of:
.RS 4
\fBUpperLeft LowerLeft UpperRight LowerRight\fR
.RE
.RE
.PP
\fBMove\fR \fIdelta\-x\fR \fIdelta\-y\fR
.RS 4
Moves the window relative to its current position\. Positive numbers refer to right and down, and negative to left and up, respectively\.
.RE
.PP
\fBMoveRight\fR \fId\fR / \fBMoveLeft\fR \fId\fR / \fBMoveUp\fR \fId\fR / \fBMoveDown\fR \fId\fR
.RS 4
Moves the window relative to its current position by the number of pixels specified in
\fId\fR\. If the number is negative, it moves in the opposite direction\.
.RE
.PP
\fBTakeToWorkspace\fR \fIworkspace\fR / \fBSendToWorkspace\fR \fIworkspace\fR
.RS 4
Sends you along with the current window to the selected workspace\. SendToWorkspace just sends the window\. The first workspace is number
\fB1\fR, not 0\.
.RE
.PP
\fBTakeToNextWorkspace\fR [\fIoffset\fR] / \fBTakeToPrevWorkspace\fR [\fIoffset\fR]
.RS 4
Sends you along with the current window to the next or previous workspace\. If you set
\fIoffset\fR
to a value greater than the default of
\fB1\fR, it will move you that number of workspaces ahead or behind\. If you go beyond the end of the currently defined workspaces, it will wrap around to the other end automatically\.
.RE
.PP
\fBSendToNextWorkspace\fR [\fIoffset\fR] / \fBSendToPrevWorkspace\fR [\fIoffset\fR]
.RS 4
Identical to the "TakeTo\&..." commands, but again this sends only the window, and does not move you away from your current workspace\.
.RE
.PP
\fBSetAlpha\fR [\fIalpha\fR [\fIunfocused\-alpha\fR]]
.RS 4
Sets the alpha value of a window\.
.sp
Putting a
\fB+\fR
or
\fB\-\fR
in front of the value adds or subtracts from the current value\. A plain integer sets the value explicitly\.
.PP
no arguments
.RS 4
Resets both focused and unfocused settings to default opacity\.
.RE
.PP
one argument
.RS 4
Changes both focused and unfocused alpha settings\.
.RE
.PP
two arguments
.RS 4
First value becomes the focused alpha, second becomes the unfocused alpha value\.
.RE
.RE
.PP
\fBSetHead\fR \fInumber\fR
.RS 4
Moves the window to the given display head\. Only available when fluxbox has been compiled with Xinerama support\.
.RE
.SS "Workspace Commands"
These commands affect the entire workspace (or "desktop" as it is sometimes called)\.
.PP
\fBAddWorkspace\fR / \fBRemoveLastWorkspace\fR
.RS 4
Adds or removes a workspace from the end of the list of workspaces\.
.RE
.PP
\fBNextWorkspace\fR [\fIn\fR] / \fBPrevWorkspace\fR [\fIn\fR] / \fBRightWorkspace\fR [\fIn\fR] / \fBLeftWorkspace\fR [\fIn\fR]
.RS 4
Switch to the Next / Previous workspace\. All versions accept an offset value
\fIn\fR, which defaults to
\fB1\fR
and refers to the number of workspaces to move at one time\. {Next,Prev}Workspace wrap around when going past the last workspace, whereas {Right,Left}Workspace do not\.
.RE
.PP
\fBWorkspace\fR \fInumber\fR
.RS 4
Jumps to the given workspace
\fInumber\fR\. The first workspace is
\fB1\fR\.
.RE
.PP
\fBNextWindow\fR [{\fIoptions\fR}] [\fIpattern\fR] / \fBPrevWindow\fR [{\fIoptions\fR}] [\fIpattern\fR]
.RS 4
Focuses and activates the next / previous window in the focus list\.
.PP
\fIoptions\fR is one or more of the following, space delimited:
.RS 4
.PP
\fBstatic\fR
.RS 4
Instead of moving in order of most\-recent focus, move in order of when the window was opened (or, the order shown in the iconbar)\.
.RE
.PP
\fBgroups\fR
.RS 4
Only include the current tab in windows with multiple tabs\.
.RE
.sp
If
\fIpattern\fR
arguments are supplied, only windows that match all the patterns are considered \- all others are skipped\. See the section
\fBCLIENT PATTERNS\fR
below for more information\.
.sp
This pair of commands has a special side\-effect when the keybinding used has a modifier \- It will temporarily raise the cycled window to the front so you can see it, but if you continue holding down the modifier and press the key again (For example, keep holding "Alt" while you tap the "Tab" key a few times), fluxbox will lower the window again when you move on to the next one\. This allows you to preview the windows in order, but does not change the order in doing so\.
.RE
.RE
.PP
\fBNextGroup\fR [{\fIoptions\fR}] [\fIpattern\fR] / \fBPrevGroup\fR [{\fIoptions\fR}] [\fIpattern\fR]
.RS 4
Equivalent to NextWindow / PrevWindow above, but with the
\fBgroups\fR
option forced on\.
.RE
.PP
\fBGotoWindow\fR \fInumber\fR [{\fIoptions\fR}] [\fIpattern\fR]
.RS 4
Focuses and activates the window at position
\fInumber\fR
in the focus list\. The
\fIoptions\fR
and
\fIpattern\fR
arguments have the same meaning as
\fBNextWindow\fR
above\.
.RE
.PP
\fBAttach\fR \fIpattern\fR
.RS 4
Combines all windows that match the
\fIpattern\fR
into a single tab group\. See
\fBCLIENT PATTERNS\fR
for more about the
\fIpattern\fR
arguments\.
.RE
.PP
\fBFocusLeft\fR / \fBFocusRight\fR / \fBFocusUp\fR / \fBFocusDown\fR
.RS 4
Focus to the next window which is located in the direction specified\.
.RE
.PP
\fBArrangeWindows\fR \fIpattern\fR
.RS 4
Tries to arrange all windows on the current workspace so that they overlap the least amount possible\. See
\fBCLIENT PATTERNS\fR
for more about the
\fIpattern\fR
arguments\.
.RE
.PP
\fBShowDesktop\fR
.RS 4
Iconifies all windows\.
.RE
.PP
\fBDeiconify\fR \fImode\fR \fIdestination\fR
.RS 4
Deiconifies windows (or, restores from a minimized state)\.
.PP
Where \fImode\fR may be one of:
.RS 4
.PP
\fBAll\fR
.RS 4
All icons across all workspaces\.
.RE
.PP
\fBAllWorkspace\fR
.RS 4
All icons on the current workspace\.
.RE
.PP
\fBLast\fR
.RS 4
The last icon across all workspaces\.
.RE
.PP
\fBLastWorkspace\fR (default)
.RS 4
The last icon on the current workspace\.
.RE
.RE
.PP
And \fIdestination\fR may be one of:
.RS 4
.PP
\fBCurrent\fR (default)
.RS 4
Deiconify to the current workspace\.
.RE
.PP
\fBOriginQuiet\fR
.RS 4
Deiconify to the window\'s original workspace, but does so in the background, without moving you there\.
.RE
.RE
.RE
.PP
\fBSetWorkspaceName\fR \fIname\fR / \fBSetWorkspaceNameDialog\fR
.RS 4
Sets the name of the current workspace\.
.RE
.PP
\fBCloseAllWindows\fR
.RS 4
Closes all windows on all desktops\.
.RE
.SS "Menu Commands"
These commands open or close fluxbox popup menus\. For more information on what these menus contain or how to configure them, see \fIfluxbox(1)\fR\.
.PP
\fBRootMenu\fR / \fBWorkspaceMenu\fR / \fBWindowMenu\fR
.RS 4
Opens the specified menu\. See fluxbox(1) for more details on what these menus contain\.
.RE
.PP
\fBClientMenu\fR [\fIpattern\fR]
.RS 4
Opens a menu that contains all windows\. If you specify a
\fIpattern\fR, only matching windows will be in the menu\. See
\fBCLIENT PATTERNS\fR
below for more details on the
\fIpattern\fR
argument\.
.RE
.PP
\fBCustomMenu\fR \fIpath\fR
.RS 4
Opens a custom menu file\.
.RE
.PP
\fBHideMenus\fR
.RS 4
Hide all fluxbox popup menus\.
.RE
.SS "Window Manager Commands"
These commands affect the Window Manager, or more than one window\.
.PP
\fBRestart\fR [\fIpath\fR]
.RS 4
Restarts fluxbox\. This does not close any running applications\. If the optional
\fIpath\fR
is a path to an executable window manager, that manager is started in place of fluxbox\.
.RE
.PP
\fBQuit\fR | \fBExit\fR
.RS 4
Exits fluxbox\. This will normally cause X to stop as well and terminate all existing applications, returning you to the login manager or console\.
.RE
.PP
\fBReconfig\fR | \fBReconfigure\fR
.RS 4
Reloads all fluxbox configuration files including the keys file, apps file, and init file, if they have changed\.
.RE
.PP
\fBSetStyle\fR \fIpath\fR
.RS 4
Sets the current style to that given in
\fIpath\fR, which must be the full path to a fluxbox style\.
.RE
.PP
\fBReloadStyle\fR
.RS 4
Reloads only the current style\. Useful after editing a style which is currently in use\.
.RE
.PP
\fBExecCommand\fR \fIargs \&...\fR | \fBExec\fR \fIargs \&...\fR | \fBExecute\fR \fIargs \&...\fR
.RS 4
Probably the most\-used binding of all\. Passes all the arguments to your
\fB$SHELL\fR
(or /bin/sh if $SHELL is not set)\. You can use this to launch applications, run shell scripts, etc\. Since all arguments are passed verbatim to the shell, you can use environment variables, pipes, or anything else the shell can do\. Note that processes only see environment variables that were set before fluxbox started (such as in ~/\.fluxbox/startup), or any that are set via the Export or SetEnv commands, below\.
.RE
.PP
\fBCommandDialog\fR
.RS 4
Pops up a dialog box that lets you type in any of these commands manually\.
.RE
.PP
\fBSetEnv\fR \fIname\fR \fIvalue\fR | \fBExport\fR \fIname\fR=\fIvalue\fR
.RS 4
Sets an environment variable in Fluxbox\. It will be passed to any applications spawned by any future ExecCommand commands\.
.RE
.PP
\fBSetResourceValue\fR \fIresourcename\fR \fIresourcevalue\fR | \fBSetResourceValueDialog\fR
.RS 4
Sets a fluxbox resource value, which are normally stored in the init file\. See
\fIfluxbox(1)\fR
for more details on available resources and allowed values\.
.RE
.SS "Special Commands"
These commands have special meanings or behaviors\.
.PP
\fBMacroCmd\fR {\fIcommand1\fR} {\fIcommand2\fR} {\fIcommand3\fR} \fI\&...\fR
.RS 4
Allows you to execute more than one command with one keybinding\. The commands will be executed in series\. The
\fB{\fR
\fB}\fR
brackets are literally required, as in the following example:
.sp
.RS 4
.nf
MacroCmd {MoveTo 0 0} {ResizeTo 1280 800}
.fi
.RE
.RE
.PP
\fBDelay\fR {\fIcommand\fR} [\fImicroseconds\fR]
.RS 4
Delays running
\fIcommand\fR
for the given amount of time\. If the same key binding is activated again, the timer will be restarted\.
.RE
.PP
\fBToggleCmd\fR {\fIcommand1\fR} {\fIcommand2\fR} \fI\&...\fR
.RS 4
Alternates between the commands\. On the first press of the bound key, runs
\fIcommand1\fR\. On the next press, runs
\fIcommand2\fR\.
.RE
.PP
\fBBindKey\fR \fIkeybinding\fR
.RS 4
Adds the given
\fIkeybinding\fR
(which must be a valid key binding as defined in the DESCRIPTION section above) to your keys file\.
.RE
.PP
\fBKeyMode\fR \fIkeymode\fR [\fIreturn\-keybinding\fR]
.RS 4
Activates the named
\fIkeymode\fR
(or, all key binding lines prefaced with the same
\fIkeymode\fR:) and deactivates all others until the
\fIreturn\-keybinding\fR
(by default
\fBEscape\fR) is pressed\. The default keymode is named
\fIdefault\fR\.
.RE
.PP
\fBForEach\fR {\fIcommand\fR} [{\fIcondition\fR}] | \fBMap\fR {\fIcommand\fR} [{\fIcondition\fR}]
.RS 4
Runs the given
\fIcommand\fR
(normally one from the
\fBWindow Commands\fR
section above) on each window\. If you specify a
\fIcondition\fR
(See
\fBConditions\fR, below) the action will be limited to matching windows\.
.RE
.PP
\fBIf\fR {\fIcondition\fR} {\fIthen\-command\fR} [{\fIelse\-command\fR}] | \fBCond\fR {\fIcondition\fR} {\fIthen\-command\fR} [{\fIelse\-command\fR}]
.RS 4
If the
\fIcondition\fR
command returns
\fBtrue\fR, then run the
\fIthen\-command\fR, otherwise run the optional
\fIelse\-command\fR\. See
\fBConditions\fR
below for more information on the
\fIcondition\fR
argument\.
.RE
.SS "Conditions"
These special commands are used to match windows conditionally\. They are commonly used by the \fBIf\fR and \fBForEach\fR command\.
.PP
\fBMatches\fR \fIpattern\fR
.RS 4
Returns
\fBtrue\fR
if the current window matches the given
\fIpattern\fR\. See
\fBCLIENT PATTERNS\fR
below for details on the
\fIpattern\fR
syntax\.
.sp
If your key binding uses the
\fBOnWindow\fR
modifier, it matches against the window you clicked, not the currently focused window\.
.sp
To check other windows besides the currently focused one, see the
\fBEvery\fR
and
\fBSome\fR
conditions below\.
.RE
.PP
\fBSome\fR \fIcondition\fR
.RS 4
Retuns
\fBtrue\fR
if any window on any workspace (not just the currently focused one) matches the
\fIcondition\fR\.
.RE
.PP
\fBEvery\fR \fIcondition\fR
.RS 4
Retuns
\fBtrue\fR
if every window on every workspace (not just the current one) matches the
\fIcondition\fR\.
.RE
.PP
\fBNot\fR \fIcondition\fR
.RS 4
Returns
\fBtrue\fR
if
\fIcondition\fR
returns
\fBfalse\fR, and vice\-versa\.
.RE
.PP
\fBAnd\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...]
.RS 4
Returns
\fBtrue\fR
if and only if all given conditions return
\fBtrue\fR\.
.RE
.PP
\fBOr\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...]
.RS 4
Returns
\fBtrue\fR
if any of the listed conditions return
\fBtrue\fR\.
.RE
.PP
\fBXor\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...]
.RS 4
Returns the boolean
\fBxor\fR
of the truth values for all conditions listed\.
.RE
.SH "CLIENT PATTERNS"
Many of the more advanced commands take a \fIpattern\fR argument, which allows you to direct the action at a specific window or set of windows which match the properties specified in the \fIpattern\fR\. A \fIpattern\fR looks like this:
.sp
([\fIpropertyname\fR[!]=]\fIregexp\fR) \&...
.sp
That is, one or more match definitions, followed by an optional limit on the number of windows to match\.
.sp
Match definitions are enclosed in parentheses \fB(\fR\&...\fB)\fR, and if no \fIpropertyname\fR is given then \fBName\fR is assumed\. The \fIregexp\fR can contain any regular expression, or the special value \fB[current]\fR, which matches the corresponding value of the currently focused window\. See \fIregex(7)\fR for more information on acceptable regular expressions\.
.sp
You can use \fB=\fR to test for equality or \fB!=\fR to test for inequality\.
.PP
The following values are accepted for \fIpropertyname\fR:
.RS 4
.PP
\fBName\fR
.RS 4
A string, corresponding to the CLASSNAME property\.
.RE
.PP
\fBClass\fR
.RS 4
A string, corresponding to the CLASSCLASS property\.
.RE
.PP
\fBTitle\fR
.RS 4
A string, corresponding to the window title\.
.RE
.PP
\fBRole\fR
.RS 4
A string, corresponding to the ROLE property\.
.RE
.PP
\fBTransient\fR
.RS 4
Either
\fByes\fR
or
\fBno\fR, depending on whether the window is transient (typically, a popup dialog) or not\.
.RE
.PP
\fBMaximized\fR
.RS 4
Either
\fByes\fR
or
\fBno\fR, depending on whether the window is maximized or not\.
.RE
.PP
\fBMinimized\fR
.RS 4
Either
\fByes\fR
or
\fBno\fR, depending on whether the window is minimized (iconified) or not\.
.RE
.PP
\fBShaded\fR
.RS 4
Either
\fByes\fR
or
\fBno\fR, depending on whether the window is shaded or not\.
.RE
.PP
\fBStuck\fR
.RS 4
Either
\fByes\fR
or
\fBno\fR, depending on whether the window is sticky (on all workspaces) or not\.
.RE
.PP
\fBFocusHidden\fR
.RS 4
Either
\fByes\fR
or
\fBno\fR, depending on whether the window has asked to be left off the focus list (or, the alt\-tab list), or not\.
.RE
.PP
\fBIconHidden\fR
.RS 4
Either
\fByes\fR
or
\fBno\fR, depending on whether the window has asked to be left off the icon list (or, the taskbar), or not\.
.RE
.PP
\fBUrgent\fR
.RS 4
Either
\fByes\fR
or
\fBno\fR, depending on whether the window has the urgent hint set\.
.RE
.PP
\fBWorkspace\fR
.RS 4
A number corresponding to the workspace number to which the window is attached\. The first workspace here is
\fB0\fR\.
.RE
.PP
\fBWorkspaceName\fR
.RS 4
A string corresponding to the name of the workspace to which the window is attached\.
.RE
.PP
\fBHead\fR
.RS 4
The number of the display head to which the window is attached\. You may match this against the special value
\fB[mouse]\fR
which refers to the head where the mouse pointer currently resides\.
.RE
.PP
\fBLayer\fR
.RS 4
The string name of the window\'s layer, which is one of
\fBAbove Dock\fR,
\fBDock\fR,
\fBTop\fR,
\fBNormal\fR,
\fBBottom\fR,
\fBDesktop\fR
.RE
.RE
.PP
\fBExample\ 2.\ Matches any windows with the CLASSNAME of "xterm"\fR
.sp
.RS 4
.nf
(xterm)
.fi
.RE
.PP
\fBExample\ 3.\ Matches any windows with the same CLASSNAME as the currently focused window\fR
.sp
.RS 4
.nf
(Name=[current])
.fi
.RE
.PP
\fBExample\ 4.\ Matches any windows on the same head as the mouse but on a different layer than the currently focused window\fR
.sp
.RS 4
.nf
(Head=[mouse]) (Layer!=[current])
.fi
.RE
.SH "FILES"
.PP
~/\.fluxbox/keys
.RS 4
This is the default location for the keybinding definitions\.
.RE
.PP
/usr/X11R6/include/X11/keysymdef\.h
.RS 4
X key names are in this file\.
.RE
.PP
/usr/X11R6/lib/X11/XKeysymDB
.RS 4
X key names are also in this file\.
.RE
.SH "RESOURCES"
.PP
session\.keyFile: <location>
.RS 4
This may be set to override the location of the keybinding definitions\.
.RE
.SH "ENVIRONMENT"
Remember that \fBExecCommand\fR command can take advantage of other environment variables if they are set before fluxbox is started, or via the \fBExport\fR or \fBSetEnv\fR commands\. For example, if \fB$TERM\fR is set, it could be use like this:
.sp
.sp
.RS 4
.nf
Mod1 x :ExecCommand $TERM
.fi
.RE
For more information about environment variables, see your shell\'s manual\.
.sp
.SH "EXAMPLES"
Here are some interesting and/or useful examples you can do with your keys file\.
.sp
.sp
.RS 4
.nf
# Mod4+drag moves a window
OnWindow Mod4 Mouse1 :StartMoving
# If any xterm windows are open, cycle through them\. If none are open, open
# one:
Mod4 t :If {Some Matches (xterm)} {NextWindow (xterm)} {Exec xterm}
# Set a different wallpaper on every workspace:
ChangeWorkspace :Exec fbsetbg ~/\.fluxbox/bg$(xprop \-root _NET_CURRENT_DESKTOP | awk \'{print $3}\')\.png
.fi
.RE
.SH "AUTHOR AND CREDITS"
This manpage is the combined work of:
.sp
.sp
.RS 4
\h'-04'\(bu\h'+03'Jim Ramsay <i\.am at jimramsay com> (>fluxbox\-1\.0\.0)
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Curt Micol <asenchi at asenchi com> (>fluxbox\-0\.9\.11)
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Tobias Klausmann <klausman at users sourceforge net> (⇐fluxbox\-0\.9\.11)
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Grubert <grubert at users sourceforge net> (fluxbox)
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Matthew Hawkins <matt at mh dropbear id au> (blackbox)
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Wilbert Berendsen <wbsoft at xs4all nl> (blackbox)
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Numerous other languages could be available if someone jumps in\.
.RE
.SH "SEE ALSO"
fluxbox(1), xev(1), xkill(1), regex(7)
.sp

2158
doc/fluxbox.1.in
View file

File diff suppressed because it is too large Load diff