1 files changed, 56 insertions, 105 deletions

diff --git a/doc/asciidoc/fluxbox-keys.txt b/doc/asciidoc/fluxbox-keys.txt
index aaec83c..58f59b1 100644
--- a/doc/asciidoc/fluxbox-keys.txt
+++ b/doc/asciidoc/fluxbox-keys.txt
@@ -1,7 +1,10 @@
 fluxbox-keys(5)
 ===============
 Jim Ramsay <i.am@jimramsay.com>
-v1.1.0, 22 July, 2008
+v1.1.2, 18 February 2009
+:man source:   fluxbox-keys.txt
+:man version:  {revision}
+:man manual:   Fluxbox Manual
 
 NAME
 ----
@@ -38,6 +41,9 @@ key names are case-sensitive.
 Lines beginning with a '#' or '!' are considered comments and are unread by
 fluxbox.
 
+You will need to ``reload'' fluxbox after editing the keys file so it picks up
+your change.
+
 MODIFIERS
 ---------
 You can get a list of possible modifiers by calling `xmodmap -pm'. This also
@@ -73,21 +79,28 @@ 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
+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
+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
+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
+        Fires when the workspace changes. This can be used to change backgrounds or
+        do anything else you like when you switch to a new workspace. See the
+        *EXAMPLES* below for one idea.
+
+WARNING: Use caution with this event! For example, do NOT bind this to any
+action that changes your current workspace. If you break your fluxbox with this
+feature, you get to keep the pieces.
+
+////////////////
 TODO: Advanced users only?
 *FocusIn* / *FocusOut*;;
         Fires when the focus is given to or removed from a window. It may be
@@ -97,14 +110,16 @@ TODO: Advanced users only?
         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 ...']*
+'modifiers-1' 'key-1' 'modifiers-2' 'key-2' :'command' ['arguments ...']*
+
+To abort a chained command part-way through typing it, press the <ESC> key.
 
 .To Bind CTRL+C CTRL+X (Which means, press CTRL+C then CTRL+X) to quit fluxbox
 ........
@@ -156,7 +171,7 @@ 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*
+Bottom BottomRight*
 
 *StartTabbing*::
         Start dragging to add this window to another's tabgroup.
@@ -180,7 +195,7 @@ These commands ordinarily affect only the currently focused window. The
         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*::
+*RaiseLayer* / *LowerLayer* ['offset']::
         Raise the window up to the layer above, or lower it to the layer
         below. See 'fluxbox(1)' for a discussion of layers.
 
@@ -193,7 +208,7 @@ These commands ordinarily affect only the currently focused window. The
         Close the current window, equivalent to the window button.
 
 *Kill* | *KillWindow*::
-        Close a window that's not responding to *Close*, like using `xkill`.
+        Close a window that's not responding to *Close*, like using *xkill(1)*.
 
 *Shade* | *ShadeWindow*::
         Toggle the *shaded* state of the current window, equivalent to the
@@ -415,17 +430,26 @@ 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.
+*RootMenu*;;
+        Opens the root menu. See *ROOT MENU* in *fluxbox-menu(5)* for details.
+
+*WorkspaceMenu*;;
+        Opens a menu showing all workspaces and windows. See *Workspace Menu* in
+        *fluxbox(1)* for details.
+
+*WindowMenu*;;
+        Opens a menu containing actions for the current window. See *WINDOW MENU* in
+        *fluxbox-menu(5)* for details.
 
 *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.
+        Opens a menu that contains all windows. If you specify a 'pattern', only
+        matching windows will be in the menu. Selecting a window will jump to that
+        workspace and raise the window. See *CLIENT PATTERNS* below for more details
+        on the 'pattern' argument.
 
 *CustomMenu* 'path'::
-        Opens a custom menu file.
+        Opens a custom menu file. This 'path' must be a valid menu file in the same
+        format as detailed by the *ROOT MENU* section of *fluxbox-menu(5)*.
 
 *HideMenus*::
         Hide all fluxbox popup menus.
@@ -463,8 +487,9 @@ These commands affect the Window Manager, or more than one window.
         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.
+        as in *\~/.fluxbox/startup*), or any that are set via the *Export* or
+        *SetEnv* commands, below. See *fluxbox(1)* for more details on the
+        *ENVIRONMENT* and *\~/.fluxbox/startup* file.
 
 *CommandDialog*::
         Pops up a dialog box that lets you type in any of these commands
@@ -554,96 +579,27 @@ To check other windows besides the currently focused one, see the *Every* and
         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') ...
-
-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
-        *AboveDock*, *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])
-...........
+properties specified in the 'pattern'.
+
+include::client-patterns.txt[]
 
 FILES
 -----
-~/.fluxbox/keys::
+*\~/.fluxbox/keys*::
         This is the default location for the keybinding definitions.
-/usr/X11R6/include/X11/keysymdef.h::
+*/usr/X11R6/include/X11/keysymdef.h*::
         X key names are in this file.
-/usr/X11R6/lib/X11/XKeysymDB::
+*/usr/X11R6/lib/X11/XKeysymDB*::
         X key names are also in this file.
 
 RESOURCES
 ---------
-session.keyFile: <location>::
+*session.keyFile:* 'location'::
       This may be set to override the location of the keybinding definitions.
 
 ENVIRONMENT
@@ -675,10 +631,8 @@ Mod4 t :If {Some Matches (xterm)} {NextWindow (xterm)} {Exec xterm}
 ChangeWorkspace :Exec fbsetbg ~/.fluxbox/bg$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}').png
 ..................
 
-AUTHOR and CREDITS
-------------------
-This manpage is the combined work of:
-
+AUTHORS
+-------
 - 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)
@@ -686,9 +640,6 @@ This manpage is the combined work of:
 - 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)
-
+fluxbox(1) xprop(1) xev(1) xkill(1) regex(7)