aboutsummaryrefslogtreecommitdiff
path: root/doc/asciidoc/fluxbox.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/asciidoc/fluxbox.txt')
-rw-r--r--doc/asciidoc/fluxbox.txt232
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
1015 1015
1016KEYS 1016KEYS
1017---- 1017----
1018You can customize fluxbox's key handling through the ~/.fluxbox/keys file. The 1018You can customize fluxbox's key handling through the ~/.fluxbox/keys file.
1019file takes the format of: 1019See 'fluxbox-keys(5)' for more information on the syntax of this file.
1020
1021 [keymode:] <modifier> <key> :<command> <operation>
1022
1023In the example below, Mod1 is the 'ALT' key on the PC keyboard and Mod4 is one
1024of the three extra keys on a pc104 branded with a familiar company logo. Lines
1025beginning with a '#' or '!' are considered comments and unread by fluxbox.
1026
1027You can get a list of possible modifiers by calling 'xmodmap -pm'. This also
1028shows you to which keys the modifiers are mapped. Additionally there is the
1029'OnDesktop' modifier. To find valid keynames check the following files:
1030
1031 /usr/X11R6/include/X11/keysymdef.h
1032 /usr/X11R6/lib/X11/XKeysymDB
1033
1034
1035Furthermore you can use Mouse1, Mouse2, etc to define actions for your mouse
1036buttons.
1037
1038............................
1039# fluxbox keys file.
1040Mod1 Tab :NextWindow
1041Mod1 Shift Tab :PrevWindow
1042Mod1 F1 :Workspace 1
1043Mod1 F2 :Workspace 2
1044Mod1 F3 :Workspace 3
1045Mod1 F4 :Workspace 4
1046Mod1 F5 :Workspace 5
1047Mod1 F6 :Workspace 6
1048Mod1 F7 :Workspace 7
1049Mod1 F8 :Workspace 8
1050Mod1 F9 :Workspace 9
1051Mod4 b :PrevWorkspace
1052Mod4 c :Minimize
1053Mod4 r :ExecCommand rxvt
1054Mod4 v :NextWorkspace
1055Mod4 x :Close
1056Mod4 m :RootMenu
1057Control n Mod1 n :NextTab
1058............................
1059
1060As you can see from the last line, keybindings can be chained in a fashion
1061similar to Emacs keybindings.
1062
1063Some things to know:
1064- Commands are case-insensitive.
1065- Workspace numbering starts at "1".
1066- Some commands have synonyms.
1067- The space between the last key and the :Command is mandatory.
1068
1069Here are fluxbox key commands to use:
1070
1071Window Manager Commands
1072~~~~~~~~~~~~~~~~~~~~~~~
1073- Restart <argument>
1074- Quit
1075- Reconfigure
1076- SetStyle <argument>
1077- ExecCommand <argument>
1078
1079Currently Focused Window Commands
1080~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1081- Minimize
1082- MinimizeWindow
1083- Iconify
1084- Maximize
1085- MaximizeWindow
1086- MaximizeHorizontal
1087- MaximizeVertical
1088- ResizeTo <width> <height>
1089- Resize <delta-width> <delta-height>
1090- ResizeHorizontal <delta-width>
1091- ResizeVertical <delta-height>
1092- MoveTo <x> <y>
1093- Move <delta-x> <delta-y>
1094- MoveRight <delta-x>
1095- MoveLeft <delta-x>
1096- MoveUp <delta-y>
1097- MoveDown <delta-y>
1098- Raise
1099- Lower
1100- Close
1101- Shade
1102- ShadeWindow
1103- Stick
1104- StickWindow
1105- ToggleDecor
1106- TakeToWorkspace <number>
1107- TakeToNextWorkspace <offset>
1108- TakeToPrevWorkspace <offset>
1109- SendToWorkspace <number>
1110- SendToNextWorkspace <offset>
1111- SendToPrevWorkspace <offset>
1112- KillWindow
1113- NextTab
1114- PrevTab
1115- MoveTabLeft
1116- MoveTabRight
1117- DetachClient
1118- SetAlpha [[+-]<int> [[+-]<int>]]
1119
1120Workspace Commands
1121~~~~~~~~~~~~~~~~~~
1122- NextWorkspace
1123- PrevWorkspace
1124- RightWorkspace <by-number>
1125- LeftWorkspace <by-number>
1126- Workspace <number>
1127- NextWindow <bitmask>
1128- PrevWindow <bitmask>
1129- NextGroup <by-number>
1130- PrevGroup <by-number>
1131- FocusLeft
1132- FocusRight
1133- FocusUp
1134- FocusDown
1135- ArrangeWindows
1136- ShowDesktop (Iconifies all windows)
1137- Deiconify all|allworkspace|last|lastworkspace current|origin|originquiet
1138- RootMenu
1139- WorkspaceMenu
1140- WindowMenu
1141- HideMenu
1142- CustomMenu <path_to_file>
1143- SetWorkspaceName <name>
1144
1145Special Commands
1146~~~~~~~~~~~~~~~~
1147- MacroCmd
1148- ToggleCmd
1149- ReloadStyle
1150- SetResourceValue <resourcename> <resource> value
1151- BindKey <key><value>: <action>
1152- KeyMode <keymode name> <return key sequence>
1153
1154Couple of things
1155~~~~~~~~~~~~~~~~
1156- Exec:
1157 fluxbox utilizes /bin/sh to start the commands. This means, that
1158 you can use environment variables to do some tricks here. E.g:
1159 :Exec $XTERM
1160 This would fire up the term of your choice, if you set XTERM to
1161 something usefull _before_ fluxbox starts, e.g. in the .fluxbox/startup
1162 file.
1163
1164- TakeToWorkspace:
1165 Will send you along with the window to the selected workspace.
1166 SendToWorkspace just sends the window.
1167
1168- TakeToNextWorkspace <offset>:
1169 Will send you and the window to workspace number <current +
1170 offset>; that is, move you and the window <offset> spaces to the
1171 right (offset defaults to 1). SendToNextWorkspace does the same,
1172 except that it only sends the window (as for SendToWorkspace).
1173 TakeToPrevWorkspace and SendToPrevWorkspace work similarly, except
1174 moving to the previous workspaces, not the next ones.
1175
1176- PrevWindow/NextWindow parameters take an integer:
1177 0 or unspecified = Default/current behavior - most recently used.
1178 1 = Groups instead of Windows - only visit one tab in each group
1179 2 = Skip stuck windows
1180 4 = Skip shaded windows
1181 8 = Switch between windows `linearly'; that is, if you repeatedly
1182 press the NextWindow key, you will walk through all windows in the,
1183 order that they were opened, instead of switching back and forth
1184 between the most recently focused windows.
1185 16 = Skip iconified windows
1186
1187 To combine any of these effects, add the corresponding numbers.
1188 For instance, 14 means switch linearly, skipping stuck and shaded
1189 windows, since 14 = 8 + 4 + 2.
1190
1191- Bindkey will append key string and action to your keys file and bind the key.
1192
1193- KeyMode allows you to have different keybindings that aren't all active at the
1194 same time. For instance, you can use `KeyMode Xnest' to switch to the `Xnest'
1195 key mode, which will disable all of your key bindings that don't have
1196 `Xnest: ' before them and will enable all the ones that do.
1197 <return key sequence> will then return you to the `default' key mode. If not
1198 provided, this defaults to the escape key.
1199
1200- The 'delta' value means the difference between the current setting and the
1201requested setting. So if you have a window that is 100 pixels wide, you could
1202set
1203
1204..........................
1205Mod1 r :ResizeHorizontal 10
1206............................
1207
1208and when you use that key it would increase the size of your window
1209to 110 pixels. If you had used
1210
1211.............................
1212Mod1 R :ResizeHorizontal -10
1213.............................
1214
1215then it would have decreased the size by 10, setting it to 90 pixels.
1216
1217- Resize commands do not necessarily change the number of pixels. For
1218 instance, many terminals will use the size of a character as the resize
1219 unit. Most applications, however, use pixels.
1220
1221- MacroCmd:
1222
1223......................................
1224Mod1 r :MacroCmd {command1} {command2}
1225......................................
1226
1227 allows you to execute more than one command with one keybinding. The commands
1228 will be executed in serial.
1229
1230- ToggleCmd:
1231
1232.......................................
1233Mod1 t :ToggleCmd {command1} {command2}
1234.......................................
1235
1236 alternates between the given commands each time you press Mod1 + t.
1237
1238- SetAlpha [[+-]<int> [[+-]<int>]]:
1239 Works on the currently focussed window. Given
1240 * no arguments: reset to default alpha settings
1241 * one argument: changes both focused and unfocused alpha settings
1242 * two arguments: first value becomes the focused alpha, second becomes
1243 the unfocused alpha value.
1244 E.g: SetAlpha 127 +5 will set the focused alpha to 127 and increment the
1245 unfocused alpha by 5 (until it reaches 255)
1246 1020
1247LAYERS 1021LAYERS
1248------ 1022------
@@ -1736,5 +1510,5 @@ mailinglists. More information can be found on the official website.
1736 1510
1737SEE ALSO 1511SEE ALSO
1738-------- 1512--------
1739bsetroot(1) fbsetbg(1) fbrun(1) fluxstyle(1) 1513fluxbox-keys(5) bsetroot(1) fbsetbg(1) fbrun(1) fluxstyle(1)
1740 1514