added new `fluxbox-keys' man page

1 files changed, 3 insertions, 229 deletions

diff --git a/doc/asciidoc/fluxbox.txt b/doc/asciidoc/fluxbox.txt
index 753ef3b..acaf9b1 100644
--- a/doc/asciidoc/fluxbox.txt
+++ b/doc/asciidoc/fluxbox.txt
@@ -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)