1FLUXBOX-APPS(5) Fluxbox Manual FLUXBOX-APPS(5)
2
6 fluxbox-apps - per-window attribute configuration for fluxbox(1)
7
9 ~/.fluxbox/apps
10
12 Variable parameters are shown in emphasis: argument
13 All other characters shown are required verbatim. Whitespace is only
15 required to delimit words, but it is fine to add more whitespace.
16
18 It is possible to force an application to always have the same
19 dimensions, position, and other settings when it is first launched.
20 These settings are saved in the ‘apps’ file.
21 Most simple settings can be saved using the “Remember...” submenu of
23 the window menu, which can usually be opened with a right-click on the
24 titlebar. More advanced features require manually editing the ‘apps’
25 file. This may include using GROUP SECTIONS to set up automatic window
26 tab groups.
27 You do not need to “reload” fluxbox after editing the apps file, the
29 changes should be rescanned when the next window is opened.
30 The file is made up of two main types of sections, apps and groups,
32 detailed below.
33
35 [app] sections provide settings for individual application windows.
36 These sections begin with a line of the format
38 [app](pattern){count}
39 The pattern can be one or more patterns which match windows. For more
41 details, see CLIENT PATTERNS. If you specify more than one pattern,
42 they must ALL match for the settings to be applied.
43 The {count} is optional. If specified, then the entry will only match
45 at most that many windows at any time. If omitted, the default is to
46 apply the settings to all matching windows.
47 This opening [apps] line is followed by any number of settings for the
49 application. See SETTINGS for more details.
50 Each of these sections ends with the single line
52 [end]
53
55 The primary purpose of [group] sections is to group windows together.
56 All windows in a group will be tabbed together automatically.
57 These sections begin with a line of the format
59 [group](pattern)
60 Where the pattern item is optional. If specified, this pattern must
62 match for the group to take effect. It is common to use
63 non-window-specific patterns such as (workspace) here. See CLIENT
64 PATTERNS for more details.
65 This is followed by any number of [app] lines. These have a similar
67 format to the [app] section detailed above in APP SECTIONS, but do not
68 contain any settings and do not have an associated [end] line.
69 Like this
71 [app](pattern)
72 This section may also contain settings that are applied to every window
74 in the group. See the SETTINGS section for details.
75 As with [app] sections, each of these sections ends with the single
77 line
78 [end]
79
81 These settings may be stored in the ‘apps’ file. A settings line must
82 appear inside either an [app] or [group] section.
83 The general format is
85 [setting]{value}
86 All allowed values are described below, except for bool which can
88 simply have the value yes or no, which enables or disables the
89 associated setting, respectively.
90 [Workspace] {number}
92 Forces the application to open on the number workspace specified.
93 Workspaces are set by number, beginning with 0.
94 [Jump] {bool}
96 Changes the active workspace to the remembered one when the
97 application is opened. This is only useful when used in conjunction
98 with [Workspace]. See EXAMPLES.
99 [Head] {number}
101 Forces the application to open on the number head specified
102 (Xinerama only).
103 [Layer] {number}
105 Specify the layer to open the window on (by number). Each layer has
106 a number. The named ones are: 2-AboveDock, 4-Dock, 6-Top, 8-Normal,
107 10-Bottom, 12-Desktop.
108 [Dimensions] {width[%] height[%]}
110 Opens the application with the specified width and height, in
111 pixels. If the value is given in percent, then the window size will
112 be based on the current screen’s size.
113 [Position] (anchor) {X[%] Y[%]}
115 Position the application at a particular spot. By default the
116 upper-left corner is placed at screen coordinates (X,Y). If you
117 specify an anchor, say BottomRight, then the lower-right corner of
118 the window is positioned (X,Y) pixels from the lower-right corner
119 of the screen. If the value is given in percent, then the
120 coordinates will be based on the current screen’s size.
121 anchor may be set to one of:
123 TopLeft Left BottomLeft Top Center Bottom TopRight Right
124 BottomRight
125 [Deco] {value}
127 Specify the decoration state. There are several predefined value
129 sets:
130 NORMAL
132 Standard decorations
133 NONE
135 No decorations
136 BORDER
138 Like NONE except keep the X window border
139 TAB
141 Like BORDER except keep external tabs (if enabled)
142 TINY
144 Titlebar with only an iconify button
145 TOOL
147 Titlebar only
148 The value may also be a bitmask for finer-grained control. The
150 bits are, from (1<<0) to (1<<10): Titlebar, Handle/Grips,
151 Border, Iconify Button, Maximize Button, Close Button, Menu
152 Button, Sticky Button, Shade Button, External Tabs, Focus
153 Enabled.
154 [Shaded] {bool}
156 Whether the window is Shaded (rolled-up) or not.
157 [Tab] {bool}
159 Whether the window has tabs enabled.
160 [FocusNewWindow] {bool}
162 If enabled, a new window will grab X focus as soon as it is opened.
163 If disabled, a new window will not grab X focus as soon as it is
164 opened.
165 [FocusHidden] {bool}
167 If enabled, the window will not appear in NextWindow/PrevWindow
168 lists.
169 [IconHidden] {bool}
171 If enabled, the window will not appear in the icon area of the
172 toolbar.
173 [Hidden] {bool}
175 A shortcut for setting both FocusHidden and IconHidden at the same
176 time.
177 [Sticky] {bool}
179 Specify if an application should be sticky (shown on all
180 workspaces) or not.
181 [Minimized] {bool}
183 Application should start minimized
184 [Maximized] {value}
186 Application should start maximized. value may be:
188 yes
190 Fully maximized
191 horz
193 Horizontally maximized
194 vert
196 Vertically maximized
197 no
199 Not maximized
200 [Fullscreen] {bool}
202 Application should start in fullscreen mode (fully maximized
203 without any decorations).
204 [Close] {bool}
206 Save settings on close. By default, application settings are not
207 updated when a window is closed.
208 [Alpha] {value [value]}
210 Set the alpha value for this window. If two values are given, they
211 correspond to the focused and unfocused transparency, respectively.
212 One number only will be used for both values. value is an integer
213 between 0 and 255.
214
216 A pattern looks like this
217 ([propertyname[!]=]regexp) ...
218 Match definitions are enclosed in parentheses (...), and if no
220 propertyname is given then Name is assumed. The regexp can contain any
221 regular expression, or the special value [current], which matches the
222 corresponding value of the currently focused window. See regex(7) for
223 more information on acceptable regular expressions.
224 propertyname is not case sensitive, whereas the regexp is.
226 If you specify multiple (pattern) arguments, this implies an AND
228 condition - All specified patterns must match.
229 You can use = to test for equality or != to test for inequality.
231 The following values are accepted for propertyname
233 Name
235 A string, corresponding to the CLASSNAME property (The first
236 field of WM_CLASS from the output of the xprop(1) utility).
237 Class
239 A string, corresponding to the CLASSCLASS property (The second
240 field of WM_CLASS from the output of the xprop(1) utility).
241 Title
243 A string, corresponding to the window title (WM_NAME from
244 xprop(1)).
245 Role
247 A string, corresponding to the ROLE property (WM_WINDOW_ROLE
248 from xprop(1)).
249 Transient
251 Either yes or no, depending on whether the window is transient
252 (typically, a popup dialog) or not.
253 Maximized
255 Either yes or no, depending on whether the window is maximized
256 or not.
257 MaximizedHorizontal
259 Either yes or no, depending on whether the window is maximized
260 horizontally or not.
261 MaximizedVertical
263 Either yes or no, depending on whether the window is maximized
264 vertically or not.
265 Minimized
267 Either yes or no, depending on whether the window is minimized
268 (iconified) or not.
269 Fullscreen
271 Either yes or no, depending on whether the window is fullscreen
272 or not.
273 Shaded
275 Either yes or no, depending on whether the window is shaded or
276 not.
277 Stuck
279 Either yes or no, depending on whether the window is sticky (on
280 all workspaces) or not.
281 FocusHidden
283 Either yes or no, depending on whether the window has asked to
284 be left off the focus list (or, the alt-tab list), or not.
285 IconHidden
287 Either yes or no, depending on whether the window has asked to
288 be left off the icon list (or, the taskbar), or not.
289 Urgent
291 Either yes or no, depending on whether the window has the
292 urgent hint set.
293 Workspace
295 A number corresponding to the workspace number to which the
296 window is attached. The first workspace here is 0. You may also
297 use [current] to match the currently visible workspace.
298 WorkspaceName
300 A string corresponding to the name of the workspace to which
301 the window is attached.
302 Head
304 The number of the display head to which the window is attached.
305 You may match this against the special value [mouse] which
306 refers to the head where the mouse pointer currently resides.
307 Layer
309 The string name of the window’s layer, which is one of
310 AboveDock, Dock, Top, Normal, Bottom, Desktop
311 Screen
313 The number of the currently used screen. If the setup of the
314 running xserver involves independent screens (not Xinerama),
315 the $DISPLAY environment contains something like :0.1 or :1.0.
316 The part after the dot (.) is the number of the screen.
317 @XPROP
319 A string, corresponding to any xproperty (Use either the
320 xprop(1) utility or the SetXProp command to set a xproperty to
321 a window)
322 Matches any windows with the CLASSNAME of "xterm".
324 (xterm)
326 Matches any windows with the same CLASSNAME as the currently focused
328 window.
329 (Name=[current])
331 Matches any windows on the same head as the mouse but on a different
333 layer than the currently focused window.
334 (Head=[mouse]) (Layer!=[current])
336 Matches any windows having a xproperty named FOO with "bar" in it.
338 (@FOO=.*bar.*)
340
343 ~/.fluxbox/apps
344 This is the default location for the application settings.
345
347 session.appsFile: location
348 This may be set to override the location of the application
349 settings.
350
352 Here are some interesting and/or useful examples you can do with your
353 apps file.
354 # Put the first two windows which end with 'term' on workspace 1
356 [app] (name=.*[tT]erm) {2}
357 [Workspace] {1}
358 [end]
359 # Center kate with a specific size, and update these values when the window is
361 # closed.
362 [app] (name=kate)
363 [Dimensions] {1022 747}
364 [Position] (CENTER) {0 0}
365 [Close] {yes}
366 [end]
367 # When starting konqueror, jump to workspace 1 first and start it there.
369 [app] (name=konqueror)
370 [Workspace] {1}
371 [Jump] {yes}
372 [end]
373 # start all aterm without decorations
375 [app] (name=aterm)
376 [Deco] {NONE}
377 [end]
378 # a group with the gimp dock and toolbox
380 # appears on layer 4 (bottom)
381 [group]
382 [app] (name=gimp) (role=gimp-dock)
383 [app] (name=gimp) (role=gimp-toolbox)
384 [Layer] {4}
385 [end]
386
388 · Jim Ramsay <i.am at jimramsay com> (>fluxbox-1.0.0)
389 · Curt Micol <asenchi at asenchi com> (>fluxbox-0.9.11)
391 · Tobias Klausmann <klausman at users sourceforge net>
393 (⟨fluxbox-0.9.11)
394 · Grubert <grubert at users sourceforge net> (fluxbox)
396 · Matthew Hawkins <matt at mh dropbear id au> (blackbox)
398 · Wilbert Berendsen <wbsoft at xs4all nl> (blackbox)
400
402 fluxbox(1) xprop(1) regex(7)
403
405 Jim Ramsay <i.am@jimramsay.com>
406 Author.
407fluxbox-apps.txt 08 February 2015 FLUXBOX-APPS(5)