added new `fluxbox-keys' man page

1 files changed, 5 insertions, 454 deletions

diff --git a/doc/asciidoc/fluxbox.1 b/doc/asciidoc/fluxbox.1
index 2c97569..ba91d7a 100644
--- a/doc/asciidoc/fluxbox.1
+++ b/doc/asciidoc/fluxbox.1
@@ -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