diff options
author | Mathias Gumz <akira@fluxbox.org> | 2015-01-05 15:52:06 (GMT) |
---|---|---|
committer | Mathias Gumz <akira@fluxbox.org> | 2015-01-05 15:52:06 (GMT) |
commit | a46a4aef08abaf548437b688c38d9e5eb99f7eb8 (patch) | |
tree | 6dad4e7ab0bad005a5a93f7f82c877fdff080040 /doc/asciidoc/fluxbox-apps.txt | |
parent | 3d6d7f8183c2424f83de0f4dd8d3e172f245d623 (diff) | |
download | fluxbox-a46a4aef08abaf548437b688c38d9e5eb99f7eb8.zip fluxbox-a46a4aef08abaf548437b688c38d9e5eb99f7eb8.tar.bz2 |
Documentation: white-spaces and minor formatting
Diffstat (limited to 'doc/asciidoc/fluxbox-apps.txt')
-rw-r--r-- | doc/asciidoc/fluxbox-apps.txt | 116 |
1 files changed, 58 insertions, 58 deletions
diff --git a/doc/asciidoc/fluxbox-apps.txt b/doc/asciidoc/fluxbox-apps.txt index c4164cc..08bc681 100644 --- a/doc/asciidoc/fluxbox-apps.txt +++ b/doc/asciidoc/fluxbox-apps.txt | |||
@@ -43,7 +43,7 @@ APP SECTIONS | |||
43 | *[app]* sections provide settings for individual application windows. | 43 | *[app]* sections provide settings for individual application windows. |
44 | 44 | ||
45 | These sections begin with a line of the format::: | 45 | These sections begin with a line of the format::: |
46 | *[app]* *(*'pattern'*)* *{*'count'*}* | 46 | *[app]* *(*'pattern'*)* *{*'count'*}* |
47 | 47 | ||
48 | The 'pattern' can be one or more patterns which match windows. For more | 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 | 49 | details, see *CLIENT PATTERNS*. If you specify more than one 'pattern', they |
@@ -57,7 +57,7 @@ This opening *[apps]* line is followed by any number of settings for the | |||
57 | application. See *SETTINGS* for more details. | 57 | application. See *SETTINGS* for more details. |
58 | 58 | ||
59 | Each of these sections ends with the single line::: | 59 | Each of these sections ends with the single line::: |
60 | *[end]* | 60 | *[end]* |
61 | 61 | ||
62 | GROUP SECTIONS | 62 | GROUP SECTIONS |
63 | -------------- | 63 | -------------- |
@@ -65,7 +65,7 @@ The primary purpose of *[group]* sections is to group windows together. All | |||
65 | windows in a group will be tabbed together automatically. | 65 | windows in a group will be tabbed together automatically. |
66 | 66 | ||
67 | These sections begin with a line of the format::: | 67 | These sections begin with a line of the format::: |
68 | *[group]* *(*'pattern'*)* | 68 | *[group]* *(*'pattern'*)* |
69 | 69 | ||
70 | Where the 'pattern' item is optional. If specified, this pattern must match for | 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 | 71 | the group to take effect. It is common to use non-window-specific patterns such |
@@ -76,13 +76,13 @@ the *[app]* section detailed above in *APP SECTIONS*, but do not contain any | |||
76 | settings and do not have an associated *[end]* line. | 76 | settings and do not have an associated *[end]* line. |
77 | 77 | ||
78 | Like this::: | 78 | Like this::: |
79 | *[app]* *(*'pattern'*)* | 79 | *[app]* *(*'pattern'*)* |
80 | 80 | ||
81 | This section may also contain settings that are applied to every window in the | 81 | This section may also contain settings that are applied to every window in the |
82 | group. See the *SETTINGS* section for details. | 82 | group. See the *SETTINGS* section for details. |
83 | 83 | ||
84 | As with *[app]* sections, each of these sections ends with the single line::: | 84 | As with *[app]* sections, each of these sections ends with the single line::: |
85 | *[end]* | 85 | *[end]* |
86 | 86 | ||
87 | SETTINGS | 87 | SETTINGS |
88 | -------- | 88 | -------- |
@@ -90,34 +90,34 @@ These settings may be stored in the `apps' file. A settings line must appear | |||
90 | inside either an *[app]* or *[group]* section. | 90 | inside either an *[app]* or *[group]* section. |
91 | 91 | ||
92 | The general format is::: | 92 | The general format is::: |
93 | *[*'setting'*]* *{*'value'*}* | 93 | *[*'setting'*]* *{*'value'*}* |
94 | 94 | ||
95 | All allowed values are described below, except for 'bool' which can simply have | 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, | 96 | the value *yes* or *no*, which enables or disables the associated setting, |
97 | respectively. | 97 | respectively. |
98 | 98 | ||
99 | *[Workspace]* {'number'}:: | 99 | *[Workspace]* {'number'}:: |
100 | Forces the application to open on the 'number' workspace specified. | 100 | Forces the application to open on the 'number' workspace specified. |
101 | Workspaces are set by number, beginning with 0. | 101 | Workspaces are set by number, beginning with 0. |
102 | 102 | ||
103 | *[Jump]* {'bool'}:: | 103 | *[Jump]* {'bool'}:: |
104 | Changes the active workspace to the remembered one when the application is | 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 | 105 | opened. This is only useful when used in conjunction with '[Workspace]'. See |
106 | *EXAMPLES*. | 106 | *EXAMPLES*. |
107 | 107 | ||
108 | *[Head]* {'number'}:: | 108 | *[Head]* {'number'}:: |
109 | Forces the application to open on the 'number' head specified (Xinerama | 109 | Forces the application to open on the 'number' head specified (Xinerama |
110 | only). | 110 | only). |
111 | 111 | ||
112 | *[Layer]* {'number'}:: | 112 | *[Layer]* {'number'}:: |
113 | Specify the layer to open the window on (by number). Each layer has a | 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, | 114 | number. The named ones are: 2-AboveDock, 4-Dock, 6-Top, 8-Normal, 10-Bottom, |
115 | 12-Desktop. | 115 | 12-Desktop. |
116 | 116 | ||
117 | *[Dimensions]* {'width[%]' 'height[%]'}:: | 117 | *[Dimensions]* {'width[%]' 'height[%]'}:: |
118 | Opens the application with the specified 'width' and 'height', in pixels. | 118 | Opens the application with the specified 'width' and 'height', in pixels. |
119 | If the value is given in percent, then the window size will be based on | 119 | If the value is given in percent, then the window size will be based on |
120 | the current screen's size. | 120 | the current screen's size. |
121 | 121 | ||
122 | *[Position]* ('anchor') {'X[%]' 'Y[%]'}:: | 122 | *[Position]* ('anchor') {'X[%]' 'Y[%]'}:: |
123 | Position the application at a particular spot. By default the upper-left corner | 123 | Position the application at a particular spot. By default the upper-left corner |
@@ -133,18 +133,18 @@ percent, then the coordinates will be based on the current screen's size. | |||
133 | Specify the decoration state. There are several predefined 'value' sets:;; | 133 | Specify the decoration state. There are several predefined 'value' sets:;; |
134 | + | 134 | + |
135 | -- | 135 | -- |
136 | *NORMAL*;; | 136 | *NORMAL*;; |
137 | Standard decorations | 137 | Standard decorations |
138 | *NONE*;; | 138 | *NONE*;; |
139 | No decorations | 139 | No decorations |
140 | *BORDER*;; | 140 | *BORDER*;; |
141 | Like NONE except keep the X window border | 141 | Like NONE except keep the X window border |
142 | *TAB*;; | 142 | *TAB*;; |
143 | Like BORDER except keep external tabs (if enabled) | 143 | Like BORDER except keep external tabs (if enabled) |
144 | *TINY*;; | 144 | *TINY*;; |
145 | Titlebar with only an iconify button | 145 | Titlebar with only an iconify button |
146 | *TOOL*;; | 146 | *TOOL*;; |
147 | Titlebar only | 147 | Titlebar only |
148 | 148 | ||
149 | -- | 149 | -- |
150 | + | 150 | + |
@@ -153,58 +153,58 @@ The 'value' may also be a bitmask for finer-grained control. The bits are, from | |||
153 | Button, Close Button, Menu Button, Sticky Button, Shade Button, External Tabs, Focus Enabled. | 153 | Button, Close Button, Menu Button, Sticky Button, Shade Button, External Tabs, Focus Enabled. |
154 | 154 | ||
155 | *[Shaded]* {'bool'}:: | 155 | *[Shaded]* {'bool'}:: |
156 | Whether the window is Shaded (rolled-up) or not. | 156 | Whether the window is Shaded (rolled-up) or not. |
157 | 157 | ||
158 | *[Tab]* {'bool'}:: | 158 | *[Tab]* {'bool'}:: |
159 | Whether the window has tabs enabled. | 159 | Whether the window has tabs enabled. |
160 | 160 | ||
161 | *[FocusNewWindow]* {'bool'}:: | 161 | *[FocusNewWindow]* {'bool'}:: |
162 | If enabled, a new window will grab X focus as soon as it is opened. | 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 opened. | 163 | If disabled, a new window will not grab X focus as soon as it is opened. |
164 | 164 | ||
165 | *[FocusHidden]* {'bool'}:: | 165 | *[FocusHidden]* {'bool'}:: |
166 | If enabled, the window will not appear in 'NextWindow'/'PrevWindow' lists. | 166 | If enabled, the window will not appear in 'NextWindow'/'PrevWindow' lists. |
167 | 167 | ||
168 | *[IconHidden]* {'bool'}:: | 168 | *[IconHidden]* {'bool'}:: |
169 | If enabled, the window will not appear in the icon area of the toolbar. | 169 | If enabled, the window will not appear in the icon area of the toolbar. |
170 | 170 | ||
171 | *[Hidden]* {'bool'}:: | 171 | *[Hidden]* {'bool'}:: |
172 | A shortcut for setting both *FocusHidden* and *IconHidden* at the same time. | 172 | A shortcut for setting both *FocusHidden* and *IconHidden* at the same time. |
173 | 173 | ||
174 | *[Sticky]* {'bool'}:: | 174 | *[Sticky]* {'bool'}:: |
175 | Specify if an application should be sticky (shown on all workspaces) or not. | 175 | Specify if an application should be sticky (shown on all workspaces) or not. |
176 | 176 | ||
177 | *[Minimized]* {'bool'}:: | 177 | *[Minimized]* {'bool'}:: |
178 | Application should start minimized | 178 | Application should start minimized |
179 | 179 | ||
180 | *[Maximized]* {'value'}:: | 180 | *[Maximized]* {'value'}:: |
181 | Application should start maximized. 'value' may be:;; | 181 | Application should start maximized. 'value' may be:;; |
182 | + | 182 | + |
183 | -- | 183 | -- |
184 | *yes*;; | 184 | *yes*;; |
185 | Fully maximized | 185 | Fully maximized |
186 | *horz*;; | 186 | *horz*;; |
187 | Horizontally maximized | 187 | Horizontally maximized |
188 | *vert*;; | 188 | *vert*;; |
189 | Vertically maximized | 189 | Vertically maximized |
190 | *no*;; | 190 | *no*;; |
191 | Not maximized | 191 | Not maximized |
192 | 192 | ||
193 | -- | 193 | -- |
194 | 194 | ||
195 | *[Fullscreen]* {'bool'}:: | 195 | *[Fullscreen]* {'bool'}:: |
196 | Application should start in fullscreen mode (fully maximized without any | 196 | Application should start in fullscreen mode (fully maximized without any |
197 | decorations). | 197 | decorations). |
198 | 198 | ||
199 | *[Close]* {'bool'}:: | 199 | *[Close]* {'bool'}:: |
200 | Save settings on close. By default, application settings are not updated when | 200 | Save settings on close. By default, application settings are not updated when |
201 | a window is closed. | 201 | a window is closed. |
202 | 202 | ||
203 | *[Alpha]* {'value' ['value']}:: | 203 | *[Alpha]* {'value' ['value']}:: |
204 | Set the alpha value for this window. If two values are given, they | 204 | Set the alpha value for this window. If two values are given, they |
205 | correspond to the focused and unfocused transparency, respectively. One | 205 | correspond to the focused and unfocused transparency, respectively. One |
206 | number only will be used for both values. 'value' is an integer between 0 | 206 | number only will be used for both values. 'value' is an integer between 0 |
207 | and 255. | 207 | and 255. |
208 | 208 | ||
209 | CLIENT PATTERNS | 209 | CLIENT PATTERNS |
210 | --------------- | 210 | --------------- |
@@ -213,12 +213,12 @@ include::client-patterns.txt[] | |||
213 | FILES | 213 | FILES |
214 | ----- | 214 | ----- |
215 | *~/.fluxbox/apps*:: | 215 | *~/.fluxbox/apps*:: |
216 | This is the default location for the application settings. | 216 | This is the default location for the application settings. |
217 | 217 | ||
218 | RESOURCES | 218 | RESOURCES |
219 | --------- | 219 | --------- |
220 | *session.appsFile:* 'location':: | 220 | *session.appsFile:* 'location':: |
221 | This may be set to override the location of the application settings. | 221 | This may be set to override the location of the application settings. |
222 | 222 | ||
223 | EXAMPLES | 223 | EXAMPLES |
224 | -------- | 224 | -------- |