summaryrefslogtreecommitdiff
path: root/doc/asciidoc/fluxbox-apps.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/asciidoc/fluxbox-apps.txt')
-rw-r--r--doc/asciidoc/fluxbox-apps.txt269
1 files changed, 269 insertions, 0 deletions
diff --git a/doc/asciidoc/fluxbox-apps.txt b/doc/asciidoc/fluxbox-apps.txt
new file mode 100644
index 0000000..a2776fa
--- /dev/null
+++ b/doc/asciidoc/fluxbox-apps.txt
@@ -0,0 +1,269 @@
1fluxbox-apps(5)
2===============
3Jim Ramsay <i.am@jimramsay.com>
4v1.1.1, 10 February 2009
5:man source: fluxbox-apps.txt
6:man version: {revision}
7:man manual: Fluxbox Manual
8
9NAME
10----
11fluxbox-apps - per-window attribute configuration for fluxbox(1)
12
13SYNOPSIS
14--------
15~/.fluxbox/apps
16
17SYNTAX
18------
19Variable parameters are shown in emphasis: 'argument'
20
21All other characters shown are required verbatim. Whitespce is only required to
22delimit words, but it is fine to add more whitespace.
23
24DESCRIPTION
25-----------
26It is possible to force an application to always have the same dimensions,
27position, and other settings when it is first launched. These settings are saved
28in the `apps' file.
29
30Most simple settings can be saved using the `Remember' submenu of the window
31menu, which can usually be opened with a right-click on the titlebar. More
32advanced features require manually editing the `apps' file. This may include
33using *GROUP SECTIONS* to set up automatic window tab groups.
34
35The file is made up of two main types of sections, apps and groups, detailed
36below.
37
38APP SECTIONS
39------------
40*[app]* sections provide settings for individual application windows.
41
42These sections begin with a line of the format:::
43 *[app]* *(*'pattern'*)* *{*'count'*}*
44
45The 'pattern' can be one or more patterns which match windows. For more
46details, see *CLIENT PATTERNS*. If you specify more than one 'pattern', they
47must ALL match for the settings to be applied.
48
49The *{*'count'*}* is optional. If specified, then the entry will only match at
50most that many windows at any time. If omitted, the default is to apply the
51settings to all matching windows.
52
53This opening *[apps]* line is followed by any number of settings for the
54application. See *SETTINGS* for more details.
55
56Each of these sections ends with the single line:::
57 *[end]*
58
59GROUP SECTIONS
60--------------
61The primary purpose of *[group]* sections is to group windows together. All
62windows in a group will be tabbed together automatically.
63
64These sections begin with a line of the format:::
65 *[group]* *(*'pattern'*)*
66
67Where the 'pattern' item is optional. If specified, this pattern must match for
68the group to take effect. It is common to use non-window-specific patterns such
69as *(workspace)* here. See *CLIENT PATTERNS* for more details.
70
71This is followed by any number of *[app]* lines. These have a simiar format to
72the *[app]* section detailed above in *APP SECTIONS*, but do not contain any
73settings and do not have an associated *[end]* line.
74
75Like this:::
76 *[app]* *(*'pattern'*)*
77
78This section may also contain settings that are applied to every window in the
79group. See the *SETTINGS* section for details.
80
81As with *[app]* sections, each of these sections ends with the single line:::
82 *[end]*
83
84SETTINGS
85--------
86These settings may be stored in the `apps' file. A settings line must appear
87inside either an *[app]* or *[group]* section.
88
89The general format is:::
90 *[*'setting'*]* *{*'value'*}*
91
92All allowed values are described below, except for 'bool' which can simply have
93the value *yes* or *no*, which enables or disables the associated setting,
94respectively.
95
96*[Workspace]* {'number'}::
97 Forces the application to open on the 'number' workspace specified.
98 Workspaces are set by number, beginning with 0.
99
100*[Jump]* {'bool'}::
101 Changes the active workspace to the remembered one when the application is
102 opened. This is only useful when used in conjunction with '[Workspace]'. See
103 *EXAMPLES*.
104
105*[Head]* {'number'}::
106 Forces the application to open on the 'number' head specified (Xinerama
107 only).
108
109*[Layer]* {'number'}::
110 Specify the layer to open the window on (by number). Each layer has a
111 number. The named ones are: 2-AboveDock, 4-Dock, 6-Top, 8-Normal, 10-Bottom,
112 12-Desktop.
113
114*[Dimensions]* {'width' 'height'}::
115 Opens the application with the specified 'width' and 'height', in pixels.
116
117*[Position]* ('anchor') {'X' 'Y'}::
118Position the application at a particular spot. By default the upper-left corner
119is placed at screen coordinates ('X','Y'). If you specify an 'anchor', say
120BottomRight, then the lower-right corner of the window is positioned ('X','Y')
121pixels from the lower-right corner of the screen.
122+
123'anchor' may be set to one of:;;
124*TopLeft Left BottomLeft Top Center Bottom TopRight Right BottomRight*
125
126*[Deco]* {'value'}::
127Specify the decoration state. There are several predefined 'value' sets:;;
128+
129--
130 *NORMAL*;;
131 Standard decorations
132 *NONE*;;
133 No decorations
134 *TAB*
135 Like TAB except keep the tabs
136 *Border*;;
137 Like NONE except keep the X window border
138 *TINY*;;
139 Titlebar with only an iconify button
140 *TOOL*;;
141 Titlebar only
142
143--
144+
145The 'value' may also be a bitmask for finer-grained control. The bits are, from
146(1<<0) to (1<<10): Titlebar, Handle/Grips, Border, Iconify Button, Maximize
147Button, Close Button, Menu Enabled, Sticky Button, Shade Button, Tabbing
148enabled, Focus Enabled.
149
150*[Shaded]* {'bool'}::
151 Whether the window is Shaded (rolled-up) or not.
152
153*[Tab]* {'bool'}::
154 Whether the window has tabs enabled.
155
156*[FocusHidden]* {'bool'}::
157 If enabled, the window will not appear in 'NextWindow'/'PrevWindow' lists.
158
159*[IconHidden]* {'bool'}::
160 If enabled, the window will not appear in the icon area of the toolbar.
161
162*[Hidden]* {'bool'}::
163 A shortcut for setting both *FocusHidden* and *IconHidden* at the same time.
164
165*[Sticky]* {'bool'}::
166 Specify if an application should be sticky (shown on all workspaces) or not.
167
168*[Minimized]* {'bool'}::
169 Application should start minimized
170
171*[Maximized]* {'value'}::
172Application should start maximized. 'value' may be:;;
173+
174--
175 *yes*;;
176 Fully maximized
177 *horz*;;
178 Horizontally maximized
179 *vert*;;
180 Vertically maximized
181 *no*;;
182 Not maximized
183
184--
185
186*[Fullscreen]* {'bool'}::
187 Application should start in fullscreen mode (fully maximized without any
188 decorations).
189
190*[Close]* {'bool'}::
191 Save settings on close. By default, application settings are not updated when
192 a window is closed.
193
194*[Alpha]* {'value' ['value']}::
195 Set the alpha value for this window. If two values are given, they
196 correspond to the focused and unfocused transparency, respectively. One
197 number only will be used for both values. 'value' is an integer between 0
198 and 255.
199
200CLIENT PATTERNS
201---------------
202include::client-patterns.txt[]
203
204FILES
205-----
206*~/.fluxbox/apps*::
207 This is the default location for the application settings.
208
209RESOURCES
210---------
211*session.appsFile:* 'location'::
212 This may be set to override the location of the application settings.
213
214EXAMPLES
215--------
216Here are some interesting and/or useful examples you can do with your apps
217file.
218
219..................
220# Put the first two windows which end with 'term' on workspace 1
221[app] (name=.*[tT]erm) {2}
222 [Workspace] {1}
223[end]
224
225# Center kate with a specific size, and update these values when the window is
226# closed.
227[app] (name=kate)
228 [Dimensions] {1022 747}
229 [Position] (CENTER) {0 0}
230 [Close] {yes}
231[end]
232
233# When starting konqueror, jump to workspace 1 first and start it there.
234[app] (name=konqueror)
235 [Workspace] {1}
236 [Jump] {yes}
237[end]
238
239# start all aterm without decorations
240[app] (name=aterm)
241 [Deco] {NONE}
242[end]
243
244# a group with the gimp dock and toolbox
245# appears on layer 4 (bottom)
246[group]
247 [app] (name=gimp) (role=gimp-dock)
248 [app] (name=gimp) (role=gimp-toolbox)
249 [Layer] {4}
250[end]
251..................
252
253AUTHOR and CREDITS
254------------------
255This manpage is the combined work of:
256
257- Jim Ramsay <i.am at jimramsay com> (>fluxbox-1.0.0)
258- Curt Micol <asenchi at asenchi com> (>fluxbox-0.9.11)
259- Tobias Klausmann <klausman at users sourceforge net> (<=fluxbox-0.9.11)
260- Grubert <grubert at users sourceforge net> (fluxbox)
261- Matthew Hawkins <matt at mh dropbear id au> (blackbox)
262- Wilbert Berendsen <wbsoft at xs4all nl> (blackbox)
263
264- Numerous other languages could be available if someone jumps in.
265
266SEE ALSO
267--------
268fluxbox(1), xev(1), xkill(1), regex(7)
269