diff options
Diffstat (limited to 'doc/asciidoc')
-rw-r--r-- | doc/asciidoc/fluxbox.txt | 188 |
1 files changed, 9 insertions, 179 deletions
diff --git a/doc/asciidoc/fluxbox.txt b/doc/asciidoc/fluxbox.txt index 824f7b6..e13647a 100644 --- a/doc/asciidoc/fluxbox.txt +++ b/doc/asciidoc/fluxbox.txt | |||
@@ -1,7 +1,10 @@ | |||
1 | fluxbox(1) | 1 | fluxbox(1) |
2 | ========== | 2 | ========== |
3 | Henrik Kinnunen <fluxgen@fluxbox.org> | 3 | Henrik Kinnunen <fluxgen@fluxbox.org> |
4 | v1.0rc3, 21th April 2007 | 4 | v1.1.1, 10 February 2009 |
5 | :man source: fluxbox.txt | ||
6 | :man version: {revision} | ||
7 | :man manual: Fluxbox Manual | ||
5 | 8 | ||
6 | NAME | 9 | NAME |
7 | ---- | 10 | ---- |
@@ -162,7 +165,7 @@ fluxbox manages the following layers (from highest to lowest): | |||
162 | Windows on a higher layer will always appear above those on a lower one. These | 165 | Windows on a higher layer will always appear above those on a lower one. These |
163 | layers can be used on application windows, the slit or the toolbar. You can | 166 | layers can be used on application windows, the slit or the toolbar. You can |
164 | assign applications to a certain layer by specifying it in the `apps' file or | 167 | assign applications to a certain layer by specifying it in the `apps' file or |
165 | through the WindowMenu. We discuss the `apps' file in the APPLICATIONS section. | 168 | through the WindowMenu. We discuss the `apps' file in *fluxbox-apps(5)*. |
166 | We discuss the WindowMenu in the MENUS section. We discuss layers in more detail | 169 | We discuss the WindowMenu in the MENUS section. We discuss layers in more detail |
167 | in the LAYERS section. | 170 | in the LAYERS section. |
168 | 171 | ||
@@ -350,8 +353,8 @@ The options available are: | |||
350 | Change the layer of this window. | 353 | Change the layer of this window. |
351 | 354 | ||
352 | - *Remember...*: | 355 | - *Remember...*: |
353 | Specify which window settings should be stored in the apps file, | 356 | Specify which window settings should be stored in the `apps' file, |
354 | covered later on in the APPLICATIONS section. | 357 | covered in *fluxbox-apps(5)*. |
355 | 358 | ||
356 | - *Close*: | 359 | - *Close*: |
357 | Close the application softly. | 360 | Close the application softly. |
@@ -826,7 +829,7 @@ session.screen0.showwindowposition: <boolean> | |||
826 | session.screen0.defaultDeco: <string> | 829 | session.screen0.defaultDeco: <string> |
827 | This specifies the default window decorations, according to the same | 830 | This specifies the default window decorations, according to the same |
828 | options available to the `[Deco]' option in the `apps' file, described in | 831 | options available to the `[Deco]' option in the `apps' file, described in |
829 | the APPLICATIONS section. Default: NORMAL. | 832 | *fluxbox-apps(5)*. Default: NORMAL. |
830 | 833 | ||
831 | session.screen0.menuDelay: <integer> | 834 | session.screen0.menuDelay: <integer> |
832 | This sets the delay in milliseconds for submenus to open when you hover | 835 | This sets the delay in milliseconds for submenus to open when you hover |
@@ -964,7 +967,7 @@ names are (from highest to lowest layer): | |||
964 | * 12 - Desktop | 967 | * 12 - Desktop |
965 | 968 | ||
966 | The other way to set the layer for a window is through the `apps' file. This | 969 | The other way to set the layer for a window is through the `apps' file. This |
967 | method is described in the APPLICATIONS section. | 970 | method is described in *fluxbox-apps(5)*. |
968 | 971 | ||
969 | 972 | ||
970 | FOCUS MODEL | 973 | FOCUS MODEL |
@@ -1039,179 +1042,6 @@ session.screen0.styleOverlay (default: ~/.fluxbox/overlay ) can be used to set | |||
1039 | style resources that override all styles. For more information about which parts | 1042 | style resources that override all styles. For more information about which parts |
1040 | of fluxbox can be controlled by the overlay file, see fluxstyle(1). | 1043 | of fluxbox can be controlled by the overlay file, see fluxstyle(1). |
1041 | 1044 | ||
1042 | APPLICATIONS | ||
1043 | ------------ | ||
1044 | It is possible to force an application to always have the same dimensions, | ||
1045 | position, and other settings when it is first launched. The easiest way to do | ||
1046 | this is to use the `Remember...' submenu of the window menu, which can usually | ||
1047 | be opened with a right click on the titlebar. More advanced features require | ||
1048 | manually editing the ~/.fluxbox/apps file, where these settings are saved. | ||
1049 | |||
1050 | The format of a section in the `apps' file is: | ||
1051 | |||
1052 | .................................... | ||
1053 | [app] (Property='value') ... {count - optional} | ||
1054 | [Setting1] {value1} | ||
1055 | [Setting2] {value2} | ||
1056 | ... | ||
1057 | [end] | ||
1058 | .................................... | ||
1059 | |||
1060 | Property can be one of the following tags: | ||
1061 | |||
1062 | o name - the name of the window (the first field of WM_CLASS) | ||
1063 | o class - class of the window (the second field of WM_CLASS) | ||
1064 | o title - title of the window (the WM_NAME property) | ||
1065 | o role - role of the window (the WM_WINDOW_ROLE property) | ||
1066 | |||
1067 | You can find out the value for these fields for a particular window by running | ||
1068 | 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 | ||
1069 | expression. All values are case sensitive. | ||
1070 | |||
1071 | You can specify multiple properties, which must ALL match for the settings to be | ||
1072 | applied. If a count is supplied in curly brackets at the end of the app line, | ||
1073 | then the entry will only match at most that many at any time (default is to | ||
1074 | match all matching windows). Settings associated with an [app] line will not be | ||
1075 | applied to transient windows. [transient] may be used instead to match them. | ||
1076 | |||
1077 | ................................................................... | ||
1078 | # match a standard xterm | ||
1079 | [app] (name=xterm) | ||
1080 | # match an xterm started like: xterm -name myshell | ||
1081 | [app] (name=myshell) | ||
1082 | # match the gaim buddy list window | ||
1083 | [app] (role=buddy_list) | ||
1084 | # match an rdesktop window to a particular host | ||
1085 | [app] (title=rdesktop - hostname.*) | ||
1086 | # match pidgin IRC windows | ||
1087 | [app] (pidgin) (title=#.*) | ||
1088 | ................................................................... | ||
1089 | |||
1090 | The following are the settings that can be defined in each [app] entry. Each | ||
1091 | name must be enclosed in square brackets, and the value is generally in curly | ||
1092 | brackets: | ||
1093 | |||
1094 | - [Workspace] \{0-N\}: | ||
1095 | Forces the application to open on the workspace specified. Workspaces are | ||
1096 | set by number, beginning with 0. | ||
1097 | |||
1098 | - [Dimensions] \{Width Height\}: | ||
1099 | Open the application with the specified width and height, in pixels. | ||
1100 | |||
1101 | - [Position] (*refspot*) {X Y}: | ||
1102 | Position the application at a particular spot: | ||
1103 | + | ||
1104 | * TOPLEFT | ||
1105 | * TOP | ||
1106 | * TOPRIGHT | ||
1107 | * LEFT | ||
1108 | * CENTER | ||
1109 | * RIGHT | ||
1110 | * BOTTOMLEFT | ||
1111 | * BOTTOM | ||
1112 | * BOTTOMRIGHT | ||
1113 | + | ||
1114 | |||
1115 | You can optionally specify what X and Y are relative to. By default the | ||
1116 | upper left corner is placed at screen coordinates (X, Y). If you specify a | ||
1117 | reference point, say LOWERRIGHT, then the lower right corner of the window | ||
1118 | is positioned (X,Y) pixels from the lower right of the screen. | ||
1119 | |||
1120 | - [Layer] {Layernum}: | ||
1121 | Specify the layer to open the window on (by number). Each layer has a | ||
1122 | number. The named ones are: 2-AboveDock, 4-Dock, 6-Top, 8-Normal, | ||
1123 | 10-Bottom, 12-Desktop. | ||
1124 | |||
1125 | - [Shaded] {yes|no}: | ||
1126 | The window is started shaded, or not. | ||
1127 | |||
1128 | - [Tab] {yes|no}: | ||
1129 | Whether this window can be tabbed with others. | ||
1130 | |||
1131 | - [IconHidden] {yes|no}: | ||
1132 | Hides the app from the icon bar | ||
1133 | |||
1134 | - [FocusHidden] {yes|no}: | ||
1135 | Hides the app from the window cycling list used by Next/PrevWindow key | ||
1136 | bindings. | ||
1137 | |||
1138 | - [Hidden] {yes|no}: | ||
1139 | is both [IconHidden] plus [FocusHidden] | ||
1140 | |||
1141 | - [Deco] {NONE|NORMAL|TOOL|TINY|BORDER}: | ||
1142 | Specify the decoration state. There are several predefined dec- | ||
1143 | oration sets: | ||
1144 | |||
1145 | o NORMAL - standard decorations | ||
1146 | o NONE - no decorations | ||
1147 | o BORDER - like NONE except keep the X window border | ||
1148 | o TINY - titlebar with an iconify button | ||
1149 | o TOOL - titlebar only | ||
1150 | |||
1151 | A bitmask can also be used for fine-grained control. The bits are (from | ||
1152 | "1" to 1<<10): titlebar, handle/grips, border, iconify button, maximize | ||
1153 | button, close button, menu enabled, sticky button, shade button, tabbing | ||
1154 | enabled, focus enabled. | ||
1155 | |||
1156 | - [Sticky] {yes|no}: | ||
1157 | Whether the window is initially stuck or not. | ||
1158 | |||
1159 | - [Jump] {yes|no}: | ||
1160 | Jump to workspace. This one is only useful if `Workspace' is set too. The | ||
1161 | workspace is changed to the workspace containing the application being | ||
1162 | launched. | ||
1163 | |||
1164 | - [Close] {yes|no}: | ||
1165 | Save settings on close. By default, application settings are not saved | ||
1166 | when a window is closed. Set this option if you want previous settings to | ||
1167 | be saved when the window is closed. | ||
1168 | |||
1169 | - [Alpha] {int [int]} | ||
1170 | Where numbers represent focused and unfocused transparency, | ||
1171 | respectively. One number only will be used for both. | ||
1172 | |||
1173 | The apps file also allows you to specify applications that should be started | ||
1174 | on fluxbox startup using [startup] (options) {command} lines. Currently, the | ||
1175 | only valid option is (screen=NN), where NN is the screen number on which the | ||
1176 | command should be run. | ||
1177 | |||
1178 | Finally, you can set windows to group together by using the `apps' file. Just | ||
1179 | place a [group] tag around several [app] tags, with an [end] tag to indicate the | ||
1180 | end of the group. If you place (workspace) after the [group] tag, a new window | ||
1181 | will only get grouped with other windows on the current workspace. You can also | ||
1182 | specify dimensions, positions, etc. for the group as for normal app entries. | ||
1183 | Here is a short example of an `apps' file: | ||
1184 | |||
1185 | ......................................................... | ||
1186 | [startup] {xterm} | ||
1187 | # match anything ending with term, up to 2 instances | ||
1188 | [app] (name=.*[tT]erm) {2} | ||
1189 | [Workspace] {1} | ||
1190 | [end] | ||
1191 | [app] (name=kate) | ||
1192 | [Dimensions] {1022 747} | ||
1193 | [Position] (WINCENTER) {0 0} | ||
1194 | [Close] {yes} | ||
1195 | [end] | ||
1196 | [app] (name=konqueror) | ||
1197 | [Workspace] {1} | ||
1198 | [Dimensions] {1006 749} | ||
1199 | [Position] {16 0} | ||
1200 | [Jump] {yes} | ||
1201 | [end] | ||
1202 | # start all aterms without decorations | ||
1203 | [app] (name=aterm) | ||
1204 | [Deco] {NONE} | ||
1205 | [end] | ||
1206 | # a group with the gimp dock and toolbox | ||
1207 | # appears on layer 4 (bottom) | ||
1208 | [group] | ||
1209 | [app] (name=gimp) (role=gimp-dock) | ||
1210 | [app] (name=gimp) (role=gimp-toolbox) | ||
1211 | [Layer] {4} | ||
1212 | [end] | ||
1213 | ......................................................... | ||
1214 | |||
1215 | THE SLIT | 1045 | THE SLIT |
1216 | -------- | 1046 | -------- |
1217 | The slit is a special fluxbox window frame that can contain dockable | 1047 | The slit is a special fluxbox window frame that can contain dockable |