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