diff options
Diffstat (limited to 'doc/asciidoc/fluxbox.txt')
-rw-r--r-- | doc/asciidoc/fluxbox.txt | 122 |
1 files changed, 52 insertions, 70 deletions
diff --git a/doc/asciidoc/fluxbox.txt b/doc/asciidoc/fluxbox.txt index e357fd4..7ca1456 100644 --- a/doc/asciidoc/fluxbox.txt +++ b/doc/asciidoc/fluxbox.txt | |||
@@ -1115,28 +1115,33 @@ of fluxbox can be controlled by the overlay file, see fluxstyle(1). | |||
1115 | APPLICATIONS | 1115 | APPLICATIONS |
1116 | ------------ | 1116 | ------------ |
1117 | It is possible to force an application to always have the same dimensions, | 1117 | It is possible to force an application to always have the same dimensions, |
1118 | position, and other settings when it is first launched. This is done using | 1118 | position, and other settings when it is first launched. The easiest way to do |
1119 | either the window-menu `Remember...' submenu, or by directly using the | 1119 | this is to use the `Remember...' submenu of the window menu, which can usually |
1120 | ~/.fluxbox/apps file. Be careful about editing the apps file while fluxbox is | 1120 | be opened with a right click on the titlebar. More advanced features require |
1121 | running. Your changes may be overwritten. Following is a listing of the valid | 1121 | manually editing the ~/.fluxbox/apps file, where these settings are saved. |
1122 | entries for the `apps' file. The `Remember...' submenu has entries for most | ||
1123 | options that store the current state in the `apps' file for future use. | ||
1124 | 1122 | ||
1125 | The format of a line in the `apps' file is: | 1123 | The format of a section in the `apps' file is: |
1126 | 1124 | ||
1127 | .................................... | 1125 | .................................... |
1128 | [app] (app-name) {count - optional} | 1126 | [app] (Property='value') ... {count - optional} |
1129 | [Property1] {value1} | 1127 | [Setting1] {value1} |
1130 | [Property2] {value2} | 1128 | [Setting2] {value2} |
1131 | ... | 1129 | ... |
1132 | [end] | 1130 | [end] |
1133 | .................................... | 1131 | .................................... |
1134 | 1132 | ||
1135 | Each app-name can be a string, or a regular expression. By default the name | 1133 | Property can be one of the following tags: |
1136 | is matched against a window's WM_CLASS property (the first string in it, called | 1134 | |
1137 | the "instance"). You can match against the title, instance name (default), class | 1135 | o name - the name of the window (the first field of WM_CLASS) |
1138 | name, or role (the WM_WINDOW_ROLE property) by explicitly specifying it. You can | 1136 | o class - class of the window (the second field of WM_CLASS) |
1139 | also specify multiple matches, which must ALL match for the properties to be | 1137 | o title - title of the window (the WM_NAME property) |
1138 | o role - role of the window (the WM_WINDOW_ROLE property) | ||
1139 | |||
1140 | You can find out the value for these fields for a particular window by running | ||
1141 | xprop(1). The window title should be used only as a last resort, since it often changes after the window opens. Each 'value' can be a string or a regular | ||
1142 | expression. All values are case sensitive. | ||
1143 | |||
1144 | You can specify multiple properties, which must ALL match for the settings to be | ||
1140 | applied. If a count is supplied in curly brackets at the end of the app line, | 1145 | applied. If a count is supplied in curly brackets at the end of the app line, |
1141 | then the entry will only match at most that many at any time (default is to | 1146 | then the entry will only match at most that many at any time (default is to |
1142 | match all matching windows). Settings associated with an [app] line will not be | 1147 | match all matching windows). Settings associated with an [app] line will not be |
@@ -1144,22 +1149,20 @@ applied to transient windows. [transient] may be used instead to match them. | |||
1144 | 1149 | ||
1145 | ................................................................... | 1150 | ................................................................... |
1146 | # match a standard xterm | 1151 | # match a standard xterm |
1147 | [app] (xterm) | 1152 | [app] (name=xterm) |
1148 | # match an xterm started like: xterm -name myshell | 1153 | # match an xterm started like: xterm -name myshell |
1149 | [app] (myshell) | 1154 | [app] (name=myshell) |
1150 | # match any one Firefox window (the instance name is "Gecko") | ||
1151 | [app] (class=Firefox-bin) {1} | ||
1152 | # match the gaim buddy list window | 1155 | # match the gaim buddy list window |
1153 | [app] (role=buddy_list) | 1156 | [app] (role=buddy_list) |
1154 | # match an rdesktop window to a particular host | 1157 | # match an rdesktop window to a particular host |
1155 | [app] (title=rdesktop - hostname.*) | 1158 | [app] (title=rdesktop - hostname.*) |
1156 | # match gaim IRC windows | 1159 | # match pidgin IRC windows |
1157 | [app] (gaim) (title=#.*) | 1160 | [app] (pidgin) (title=#.*) |
1158 | ................................................................... | 1161 | ................................................................... |
1159 | 1162 | ||
1160 | The following are the properties that can be defined in each [app] entry. | 1163 | The following are the settings that can be defined in each [app] entry. Each |
1161 | Each name must be enclosed in square brackets, and the value is generally in | 1164 | name must be enclosed in square brackets, and the value is generally in curly |
1162 | curly brackets: | 1165 | brackets: |
1163 | 1166 | ||
1164 | - [Workspace] \{0-N\}: | 1167 | - [Workspace] \{0-N\}: |
1165 | Forces the application to open on the workspace specified. Workspaces are | 1168 | Forces the application to open on the workspace specified. Workspaces are |
@@ -1168,7 +1171,7 @@ curly brackets: | |||
1168 | - [Dimensions] \{Width Height\}: | 1171 | - [Dimensions] \{Width Height\}: |
1169 | Open the application with the specified width and height, in pixels. | 1172 | Open the application with the specified width and height, in pixels. |
1170 | 1173 | ||
1171 | - [Position] (*refspot*)) {X Y}: | 1174 | - [Position] (*refspot*) {X Y}: |
1172 | Position the application at a particular spot: | 1175 | Position the application at a particular spot: |
1173 | + | 1176 | + |
1174 | * TOPLEFT | 1177 | * TOPLEFT |
@@ -1202,7 +1205,7 @@ curly brackets: | |||
1202 | Hides the app from the icon bar | 1205 | Hides the app from the icon bar |
1203 | 1206 | ||
1204 | - [FocusHidden] {yes|no}: | 1207 | - [FocusHidden] {yes|no}: |
1205 | Hides the app from the window cycling list used Next/PrevWindow key | 1208 | Hides the app from the window cycling list used by Next/PrevWindow key |
1206 | bindings. | 1209 | bindings. |
1207 | 1210 | ||
1208 | - [Hidden] {yes|no}: | 1211 | - [Hidden] {yes|no}: |
@@ -1245,64 +1248,43 @@ on fluxbox startup using [startup] (options) {command} lines. Currently, the | |||
1245 | only valid option is (screen=NN), where NN is the screen number on which the | 1248 | only valid option is (screen=NN), where NN is the screen number on which the |
1246 | command should be run. | 1249 | command should be run. |
1247 | 1250 | ||
1248 | Finally, you can set windows to group together by using the `apps' file. This | 1251 | Finally, you can set windows to group together by using the `apps' file. Just |
1249 | can be achieved with regular expressions using: | 1252 | place a [group] tag around several [app] tags, with an [end] tag to indicate the |
1250 | 1253 | end of the group. If you place (workspace) after the [group] tag, a new window | |
1251 | [app] (property=expr) ... {number} | 1254 | will only get grouped with other windows on the current workspace. You can also |
1252 | 1255 | specify dimensions, positions, etc. for the group as for normal app entries. | |
1253 | Property can be one of the following tags: | 1256 | Here is a short example of an `apps' file: |
1254 | |||
1255 | o name - the name of the window (the first field of WM_CLASS) | ||
1256 | o class - class of the window (the second field of WM_CLASS) | ||
1257 | o title - title of the window ( WM_NAME property) | ||
1258 | o role - role of the window (the WM_WINDOW_ROLE property) | ||
1259 | |||
1260 | If no `property' is specified, the name property is assumed. You can find out | ||
1261 | the value for these fields for a particular window by running xprop(1). | ||
1262 | |||
1263 | You can also place [group] tag around several [app] tags, with an [end] tag to | ||
1264 | indicate the end of the group. If you place (workspace) after the [group] tag, a | ||
1265 | new window will only get grouped with other windows on the current workspace. | ||
1266 | You can also specify dimensions, positions, etc. for the group as for normal app | ||
1267 | entries. Here is a short example of an `apps' file: | ||
1268 | 1257 | ||
1269 | ......................................................... | 1258 | ......................................................... |
1270 | [startup] {xterm} | 1259 | [startup] {xterm} |
1271 | # match anything ending with term, up to 2 instances | 1260 | # match anything ending with term, up to 2 instances |
1272 | [app] (.*[tT]erm) {2} | 1261 | [app] (name=.*[tT]erm) {2} |
1273 | # match anything with `gaim' in the title | 1262 | [Workspace] {1} |
1274 | [app] (title=.*gaim.*) | ||
1275 | [app] (kate) | ||
1276 | [Dimensions] {1022 747} | ||
1277 | [Position] (WINCENTER) {0 0} | ||
1278 | [Close] {yes} | ||
1279 | [end] | 1263 | [end] |
1280 | [app] (konqueror) | 1264 | [app] (name=kate) |
1281 | [Workspace] {1} | 1265 | [Dimensions] {1022 747} |
1282 | [Dimensions] {1006 749} | 1266 | [Position] (WINCENTER) {0 0} |
1283 | [Position] {16 0} | 1267 | [Close] {yes} |
1284 | [Jump] {yes} | 1268 | [end] |
1269 | [app] (name=konqueror) | ||
1270 | [Workspace] {1} | ||
1271 | [Dimensions] {1006 749} | ||
1272 | [Position] {16 0} | ||
1273 | [Jump] {yes} | ||
1285 | [end] | 1274 | [end] |
1286 | # start all aterms without decorations | 1275 | # start all aterms without decorations |
1287 | [app] (aterm) | 1276 | [app] (name=aterm) |
1288 | [Deco] {NONE} | 1277 | [Deco] {NONE} |
1289 | [end] | 1278 | [end] |
1290 | # a group with the gimp dock and toolbox | 1279 | # a group with the gimp dock and toolbox |
1291 | # appears on layer 4 (bottom) | 1280 | # appears on layer 4 (bottom) |
1292 | [group] | 1281 | [group] |
1293 | [app] (gimp) (role=gimp-dock) | 1282 | [app] (name=gimp) (role=gimp-dock) |
1294 | [app] (gimp) (role=gimp-toolbox) | 1283 | [app] (name=gimp) (role=gimp-toolbox) |
1295 | [Layer] {4} | 1284 | [Layer] {4} |
1296 | [end] | 1285 | [end] |
1297 | ......................................................... | 1286 | ......................................................... |
1298 | 1287 | ||
1299 | Parameters in the `apps' file are case-sensitive. Application names are taken | ||
1300 | from the first X window WM_CLASS attribute by default (WM_NAME = title, | ||
1301 | WM_WINDOW_ROLE = role). You can see this attribute by using the xprop | ||
1302 | command. Take care when using regular expressions. If you are not familiar with | ||
1303 | regular expressions you can disable this feature by specifying --disable-regexp | ||
1304 | during configure. Plain strings will then be matched. | ||
1305 | |||
1306 | THE SLIT | 1288 | THE SLIT |
1307 | -------- | 1289 | -------- |
1308 | The slit is a special fluxbox window frame that can contain dockable | 1290 | The slit is a special fluxbox window frame that can contain dockable |