1
.\" Title: fluxbox-apps
2
.\" Author: [see the "AUTHORS" section]
3
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
5
.\" Manual: Fluxbox Manual
6
.\" Source: fluxbox-apps.txt 1.1.2
9
.TH "FLUXBOX\-APPS" "5" "02/19/2009" "fluxbox\-apps\&.txt 1\&.1\&.2" "Fluxbox Manual"
10
.\" -----------------------------------------------------------------
11
.\" * (re)Define some macros
12
.\" -----------------------------------------------------------------
13
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14
.\" toupper - uppercase a string (locale-aware)
15
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17
.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
19
.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
21
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22
.\" SH-xref - format a cross-reference to an SH section
23
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33
.\" SH - level-one heading that works better for non-TTY output
34
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36
.\" put an extra blank line of space above the head in non-TTY output
43
.nr an-prevailing-indent \\n[IN]
47
.HTML-TAG ".NH \\n[an-level]"
49
.nr an-no-space-flag 1
51
\." make the size of the head bigger
56
.\" if n (TTY output), use uppercase
61
.\" if not n (not TTY), use normal case (not uppercase)
65
.\" if not n (not TTY), put a border/line under subheading
70
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71
.\" SS - level-two heading that works better for non-TTY output
72
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77
.nr an-prevailing-indent \\n[IN]
82
.nr an-no-space-flag 1
85
\." make the size of the head bigger
91
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92
.\" BB/BE - put background/screen (filled box) around block of text
93
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106
.if "\\$2"adjust-for-leading-newline" \{\
114
.nr BW \\n(.lu-\\n(.i
117
.ie "\\$2"adjust-for-leading-newline" \{\
118
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
121
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
132
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133
.\" BM/EM - put colored marker in margin next to block of text
134
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
159
.\" -----------------------------------------------------------------
160
.\" * set default formatting
161
.\" -----------------------------------------------------------------
162
.\" disable hyphenation
164
.\" disable justification (adjust text to left margin only)
166
.\" -----------------------------------------------------------------
167
.\" * MAIN CONTENT STARTS HERE *
168
.\" -----------------------------------------------------------------
170
fluxbox-apps \- per\-window attribute configuration for fluxbox(1)
176
Variable parameters are shown in emphasis: \fIargument\fR
178
All other characters shown are required verbatim\&. Whitespce is only required to delimit words, but it is fine to add more whitespace\&.
181
It is possible to force an application to always have the same dimensions, position, and other settings when it is first launched\&. These settings are saved in the `apps\' file\&.
183
Most simple settings can be saved using the \(lqRemember\&...\(rq submenu of the window menu, which can usually be opened with a right\-click on the titlebar\&. More advanced features require manually editing the `apps\' file\&. This may include using \fBGROUP SECTIONS\fR to set up automatic window tab groups\&.
185
You do not need to \(lqreload\(rq fluxbox after editing the apps file, the changes should be rescanned when the next window is opened\&.
187
The file is made up of two main types of sections, apps and groups, detailed below\&.
190
\fB[app]\fR sections provide settings for individual application windows\&.
192
These sections begin with a line of the format:
196
\fB(\fR\fIpattern\fR\fB)\fR
197
\fB{\fR\fIcount\fR\fB}\fR
200
The \fIpattern\fR can be one or more patterns which match windows\&. For more details, see \fBCLIENT PATTERNS\fR\&. If you specify more than one \fIpattern\fR, they must ALL match for the settings to be applied\&.
202
The \fB{\fR\fIcount\fR\fB}\fR is optional\&. If specified, then the entry will only match at most that many windows at any time\&. If omitted, the default is to apply the settings to all matching windows\&.
204
This opening \fB[apps]\fR line is followed by any number of settings for the application\&. See \fBSETTINGS\fR for more details\&.
206
Each of these sections ends with the single line:
213
The primary purpose of \fB[group]\fR sections is to group windows together\&. All windows in a group will be tabbed together automatically\&.
215
These sections begin with a line of the format:
219
\fB(\fR\fIpattern\fR\fB)\fR
222
Where the \fIpattern\fR item is optional\&. If specified, this pattern must match for the group to take effect\&. It is common to use non\-window\-specific patterns such as \fB(workspace)\fR here\&. See \fBCLIENT PATTERNS\fR for more details\&.
224
This is followed by any number of \fB[app]\fR lines\&. These have a simiar format to the \fB[app]\fR section detailed above in \fBAPP SECTIONS\fR, but do not contain any settings and do not have an associated \fB[end]\fR line\&.
230
\fB(\fR\fIpattern\fR\fB)\fR
233
This section may also contain settings that are applied to every window in the group\&. See the \fBSETTINGS\fR section for details\&.
235
As with \fB[app]\fR sections, each of these sections ends with the single line:
242
These settings may be stored in the `apps\' file\&. A settings line must appear inside either an \fB[app]\fR or \fB[group]\fR section\&.
244
The general format is:
247
\fB[\fR\fIsetting\fR\fB]\fR
248
\fB{\fR\fIvalue\fR\fB}\fR
251
All allowed values are described below, except for \fIbool\fR which can simply have the value \fByes\fR or \fBno\fR, which enables or disables the associated setting, respectively\&.
253
\fB[Workspace]\fR {\fInumber\fR}
255
Forces the application to open on the
257
workspace specified\&. Workspaces are set by number, beginning with 0\&.
260
\fB[Jump]\fR {\fIbool\fR}
262
Changes the active workspace to the remembered one when the application is opened\&. This is only useful when used in conjunction with
263
\fI[Workspace]\fR\&. See
267
\fB[Head]\fR {\fInumber\fR}
269
Forces the application to open on the
271
head specified (Xinerama only)\&.
274
\fB[Layer]\fR {\fInumber\fR}
276
Specify the layer to open the window on (by number)\&. Each layer has a number\&. The named ones are: 2\-AboveDock, 4\-Dock, 6\-Top, 8\-Normal, 10\-Bottom, 12\-Desktop\&.
279
\fB[Dimensions]\fR {\fIwidth\fR \fIheight\fR}
281
Opens the application with the specified
284
\fIheight\fR, in pixels\&.
287
\fB[Position]\fR (\fIanchor\fR) {\fIX\fR \fIY\fR}
289
Position the application at a particular spot\&. By default the upper\-left corner is placed at screen coordinates (\fIX\fR,\fIY\fR)\&. If you specify an
290
\fIanchor\fR, say BottomRight, then the lower\-right corner of the window is positioned (\fIX\fR,\fIY\fR) pixels from the lower\-right corner of the screen\&.
292
\fIanchor\fR may be set to one of:
295
\fBTopLeft Left BottomLeft Top Center Bottom TopRight Right BottomRight\fR
299
\fB[Deco]\fR {\fIvalue\fR}
302
Specify the decoration state\&. There are several predefined \fIvalue\fR sets:
314
Like TAB except keep the tabs
319
Like NONE except keep the X window border
324
Titlebar with only an iconify button
334
may also be a bitmask for finer\-grained control\&. The bits are, from (1<<0) to (1<<10): Titlebar, Handle/Grips, Border, Iconify Button, Maximize Button, Close Button, Menu Enabled, Sticky Button, Shade Button, Tabbing enabled, Focus Enabled\&.
338
\fB[Shaded]\fR {\fIbool\fR}
340
Whether the window is Shaded (rolled\-up) or not\&.
343
\fB[Tab]\fR {\fIbool\fR}
345
Whether the window has tabs enabled\&.
348
\fB[FocusHidden]\fR {\fIbool\fR}
350
If enabled, the window will not appear in
351
\fINextWindow\fR/\fIPrevWindow\fR
355
\fB[IconHidden]\fR {\fIbool\fR}
357
If enabled, the window will not appear in the icon area of the toolbar\&.
360
\fB[Hidden]\fR {\fIbool\fR}
362
A shortcut for setting both
369
\fB[Sticky]\fR {\fIbool\fR}
371
Specify if an application should be sticky (shown on all workspaces) or not\&.
374
\fB[Minimized]\fR {\fIbool\fR}
376
Application should start minimized
379
\fB[Maximized]\fR {\fIvalue\fR}
382
Application should start maximized\&. \fIvalue\fR may be:
392
Horizontally maximized
407
\fB[Fullscreen]\fR {\fIbool\fR}
409
Application should start in fullscreen mode (fully maximized without any decorations)\&.
412
\fB[Close]\fR {\fIbool\fR}
414
Save settings on close\&. By default, application settings are not updated when a window is closed\&.
417
\fB[Alpha]\fR {\fIvalue\fR [\fIvalue\fR]}
419
Set the alpha value for this window\&. If two values are given, they correspond to the focused and unfocused transparency, respectively\&. One number only will be used for both values\&.
421
is an integer between 0 and 255\&.
423
.SH "CLIENT PATTERNS"
425
A \fIpattern\fR looks like this:
428
\fB(\fR[\fIpropertyname\fR[!]=]\fIregexp\fR\fB)\fR
432
Match definitions are enclosed in parentheses \fB(\fR\&...\fB)\fR, and if no \fIpropertyname\fR is given then \fBName\fR is assumed\&. The \fIregexp\fR can contain any regular expression, or the special value \fB[current]\fR, which matches the corresponding value of the currently focused window\&. See \fIregex(7)\fR for more information on acceptable regular expressions\&.
434
\fIpropertyname\fR is not case sensitive, whereas the \fIregexp\fR is\&.
436
If you specify multiple \fB(\fR\fB\fIpattern\fR\fR) arguments, this implies an AND condition \- All specified patterns must match\&.
438
You can use \fB=\fR to test for equality or \fB!=\fR to test for inequality\&.
440
The following values are accepted for \fIpropertyname\fR:
445
A string, corresponding to the CLASSNAME property (The first field of WM_CLASS from the output of the
452
A string, corresponding to the CLASSCLASS property (The second field of WM_CLASS from the output of the
459
A string, corresponding to the window title (WM_NAME from
465
A string, corresponding to the ROLE property (WM_WINDOW_ROLE from
474
\fBno\fR, depending on whether the window is transient (typically, a popup dialog) or not\&.
482
\fBno\fR, depending on whether the window is maximized or not\&.
490
\fBno\fR, depending on whether the window is minimized (iconified) or not\&.
498
\fBno\fR, depending on whether the window is shaded or not\&.
506
\fBno\fR, depending on whether the window is sticky (on all workspaces) or not\&.
514
\fBno\fR, depending on whether the window has asked to be left off the focus list (or, the alt\-tab list), or not\&.
522
\fBno\fR, depending on whether the window has asked to be left off the icon list (or, the taskbar), or not\&.
530
\fBno\fR, depending on whether the window has the urgent hint set\&.
535
A number corresponding to the workspace number to which the window is attached\&. The first workspace here is
536
\fB0\fR\&. You may also use
538
to match the currently visible workspace\&.
543
A string corresponding to the name of the workspace to which the window is attached\&.
548
The number of the display head to which the window is attached\&. You may match this against the special value
550
which refers to the head where the mouse pointer currently resides\&.
555
The string name of the window\'s layer, which is one of
565
\fBExample\ \&1.\ \&Matches any windows with the CLASSNAME of "xterm"\fR
583
\fBExample\ \&2.\ \&Matches any windows with the same CLASSNAME as the currently focused window\fR
601
\fBExample\ \&3.\ \&Matches any windows on the same head as the mouse but on a different layer than the currently focused window\fR
610
(Head=[mouse]) (Layer!=[current])
620
\fB~/\&.fluxbox/apps\fR
622
This is the default location for the application settings\&.
626
\fBsession\&.appsFile:\fR \fIlocation\fR
628
This may be set to override the location of the application settings\&.
632
Here are some interesting and/or useful examples you can do with your apps file\&.
641
# Put the first two windows which end with \'term\' on workspace 1
642
[app] (name=\&.*[tT]erm) {2}
646
# Center kate with a specific size, and update these values when the window is
649
[Dimensions] {1022 747}
650
[Position] (CENTER) {0 0}
654
# When starting konqueror, jump to workspace 1 first and start it there\&.
655
[app] (name=konqueror)
660
# start all aterm without decorations
665
# a group with the gimp dock and toolbox
666
# appears on layer 4 (bottom)
668
[app] (name=gimp) (role=gimp\-dock)
669
[app] (name=gimp) (role=gimp\-toolbox)
689
Jim Ramsay <i\&.am at jimramsay com> (>fluxbox\-1\&.0\&.0)
700
Curt Micol <asenchi at asenchi com> (>fluxbox\-0\&.9\&.11)
711
Tobias Klausmann <klausman at users sourceforge net> (\(lafluxbox\-0\&.9\&.11)
722
Grubert <grubert at users sourceforge net> (fluxbox)
733
Matthew Hawkins <matt at mh dropbear id au> (blackbox)
744
Wilbert Berendsen <wbsoft at xs4all nl> (blackbox)
748
fluxbox(1) xprop(1) regex(7)
added
removed
doc/fluxbox-apps.5.in
