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