diff options
author | Mark Tiefenbruck <mark@fluxbox.org> | 2012-07-09 00:35:48 (GMT) |
---|---|---|
committer | Mark Tiefenbruck <mark@fluxbox.org> | 2012-07-09 00:35:48 (GMT) |
commit | fb52be0c47bb41793fe1ac1eed710fb5375ec3d6 (patch) | |
tree | a7474e38020c5e1bd87339203b15e9534edd1ccf /doc | |
parent | 9eecd58bf30c8b1c0d72b9070bf91e2c60f32fa5 (diff) | |
download | fluxbox-fb52be0c47bb41793fe1ac1eed710fb5375ec3d6.zip fluxbox-fb52be0c47bb41793fe1ac1eed710fb5375ec3d6.tar.bz2 |
fix documentation of TAB decoration mask
Diffstat (limited to 'doc')
-rw-r--r-- | doc/asciidoc/fluxbox-apps.txt | 9 | ||||
-rw-r--r-- | doc/fluxbox-apps.5.in | 45 | ||||
-rw-r--r-- | doc/fluxbox-keys.5.in | 42 |
3 files changed, 73 insertions, 23 deletions
diff --git a/doc/asciidoc/fluxbox-apps.txt b/doc/asciidoc/fluxbox-apps.txt index 07bac0e..31a26fa 100644 --- a/doc/asciidoc/fluxbox-apps.txt +++ b/doc/asciidoc/fluxbox-apps.txt | |||
@@ -137,10 +137,10 @@ Specify the decoration state. There are several predefined 'value' sets:;; | |||
137 | Standard decorations | 137 | Standard decorations |
138 | *NONE*;; | 138 | *NONE*;; |
139 | No decorations | 139 | No decorations |
140 | *TAB* | 140 | *BORDER*;; |
141 | Like TAB except keep the tabs | ||
142 | *Border*;; | ||
143 | Like NONE except keep the X window border | 141 | Like NONE except keep the X window border |
142 | *TAB*;; | ||
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*;; |
@@ -150,8 +150,7 @@ Specify the decoration state. There are several predefined 'value' sets:;; | |||
150 | + | 150 | + |
151 | The 'value' may also be a bitmask for finer-grained control. The bits are, from | 151 | The 'value' may also be a bitmask for finer-grained control. The bits are, from |
152 | (1<<0) to (1<<10): Titlebar, Handle/Grips, Border, Iconify Button, Maximize | 152 | (1<<0) to (1<<10): Titlebar, Handle/Grips, Border, Iconify Button, Maximize |
153 | Button, Close Button, Menu Enabled, Sticky Button, Shade Button, Tabbing | 153 | Button, Close Button, Menu Button, Sticky Button, Shade Button, External Tabs, Focus Enabled. |
154 | enabled, Focus Enabled. | ||
155 | 154 | ||
156 | *[Shaded]* {'bool'}:: | 155 | *[Shaded]* {'bool'}:: |
157 | Whether the window is Shaded (rolled-up) or not. | 156 | Whether the window is Shaded (rolled-up) or not. |
diff --git a/doc/fluxbox-apps.5.in b/doc/fluxbox-apps.5.in index 88b947c..9b32ca6 100644 --- a/doc/fluxbox-apps.5.in +++ b/doc/fluxbox-apps.5.in | |||
@@ -1,7 +1,7 @@ | |||
1 | '\" t | 1 | '\" t |
2 | .\" Title: fluxbox-apps | 2 | .\" Title: fluxbox-apps |
3 | .\" Author: Jim Ramsay <i.am@jimramsay.com> | 3 | .\" Author: Jim Ramsay <i.am@jimramsay.com> |
4 | .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> | 4 | .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> |
5 | .\" Date: 28 October 2011 | 5 | .\" Date: 28 October 2011 |
6 | .\" Manual: Fluxbox Manual | 6 | .\" Manual: Fluxbox Manual |
7 | .\" Source: fluxbox-apps.txt | 7 | .\" Source: fluxbox-apps.txt |
@@ -137,18 +137,18 @@ head specified (Xinerama only)\&. | |||
137 | 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\&. | 137 | 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\&. |
138 | .RE | 138 | .RE |
139 | .PP | 139 | .PP |
140 | \fB[Dimensions]\fR {\fIwidth\fR \fIheight\fR} | 140 | \fB[Dimensions]\fR {\fIwidth[%]\fR \fIheight[%]\fR} |
141 | .RS 4 | 141 | .RS 4 |
142 | Opens the application with the specified | 142 | Opens the application with the specified |
143 | \fIwidth\fR | 143 | \fIwidth\fR |
144 | and | 144 | and |
145 | \fIheight\fR, in pixels\&. | 145 | \fIheight\fR, in pixels\&. If the value is given in percent, then the window size will be based on the current screen\(cqs size\&. |
146 | .RE | 146 | .RE |
147 | .PP | 147 | .PP |
148 | \fB[Position]\fR (\fIanchor\fR) {\fIX\fR \fIY\fR} | 148 | \fB[Position]\fR (\fIanchor\fR) {\fIX[%]\fR \fIY[%]\fR} |
149 | .RS 4 | 149 | .RS 4 |
150 | 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 | 150 | 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 |
151 | \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\&. | 151 | \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\&. If the value is given in percent, then the coordinates will be based on the current screen\(cqs size\&. |
152 | .PP | 152 | .PP |
153 | \fIanchor\fR may be set to one of: | 153 | \fIanchor\fR may be set to one of: |
154 | .RS 4 | 154 | .RS 4 |
@@ -171,15 +171,18 @@ Standard decorations | |||
171 | \fBNONE\fR | 171 | \fBNONE\fR |
172 | .RS 4 | 172 | .RS 4 |
173 | No decorations | 173 | No decorations |
174 | \fBTAB\fR | ||
175 | Like TAB except keep the tabs | ||
176 | .RE | 174 | .RE |
177 | .PP | 175 | .PP |
178 | \fBBorder\fR | 176 | \fBBORDER\fR |
179 | .RS 4 | 177 | .RS 4 |
180 | Like NONE except keep the X window border | 178 | Like NONE except keep the X window border |
181 | .RE | 179 | .RE |
182 | .PP | 180 | .PP |
181 | \fBTAB\fR | ||
182 | .RS 4 | ||
183 | Like BORDER except keep external tabs (if enabled) | ||
184 | .RE | ||
185 | .PP | ||
183 | \fBTINY\fR | 186 | \fBTINY\fR |
184 | .RS 4 | 187 | .RS 4 |
185 | Titlebar with only an iconify button | 188 | Titlebar with only an iconify button |
@@ -192,7 +195,7 @@ Titlebar only | |||
192 | .sp | 195 | .sp |
193 | The | 196 | The |
194 | \fIvalue\fR | 197 | \fIvalue\fR |
195 | 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\&. | 198 | 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 Button, Sticky Button, Shade Button, External Tabs, Focus Enabled\&. |
196 | .RE | 199 | .RE |
197 | .RE | 200 | .RE |
198 | .PP | 201 | .PP |
@@ -348,6 +351,22 @@ or | |||
348 | \fBno\fR, depending on whether the window is maximized or not\&. | 351 | \fBno\fR, depending on whether the window is maximized or not\&. |
349 | .RE | 352 | .RE |
350 | .PP | 353 | .PP |
354 | \fBMaximizedHorizontal\fR | ||
355 | .RS 4 | ||
356 | Either | ||
357 | \fByes\fR | ||
358 | or | ||
359 | \fBno\fR, depending on whether the window is maximized horizontally or not\&. | ||
360 | .RE | ||
361 | .PP | ||
362 | \fBMaximizedVertical\fR | ||
363 | .RS 4 | ||
364 | Either | ||
365 | \fByes\fR | ||
366 | or | ||
367 | \fBno\fR, depending on whether the window is maximized vertically or not\&. | ||
368 | .RE | ||
369 | .PP | ||
351 | \fBMinimized\fR | 370 | \fBMinimized\fR |
352 | .RS 4 | 371 | .RS 4 |
353 | Either | 372 | Either |
@@ -356,6 +375,14 @@ or | |||
356 | \fBno\fR, depending on whether the window is minimized (iconified) or not\&. | 375 | \fBno\fR, depending on whether the window is minimized (iconified) or not\&. |
357 | .RE | 376 | .RE |
358 | .PP | 377 | .PP |
378 | \fBFullscreen\fR | ||
379 | .RS 4 | ||
380 | Either | ||
381 | \fByes\fR | ||
382 | or | ||
383 | \fBno\fR, depending on whether the window is fullscreen or not\&. | ||
384 | .RE | ||
385 | .PP | ||
359 | \fBShaded\fR | 386 | \fBShaded\fR |
360 | .RS 4 | 387 | .RS 4 |
361 | Either | 388 | Either |
diff --git a/doc/fluxbox-keys.5.in b/doc/fluxbox-keys.5.in index 50b79d8..7ff39f5 100644 --- a/doc/fluxbox-keys.5.in +++ b/doc/fluxbox-keys.5.in | |||
@@ -1,7 +1,7 @@ | |||
1 | '\" t | 1 | '\" t |
2 | .\" Title: fluxbox-keys | 2 | .\" Title: fluxbox-keys |
3 | .\" Author: Jim Ramsay <i.am@jimramsay.com> | 3 | .\" Author: Jim Ramsay <i.am@jimramsay.com> |
4 | .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> | 4 | .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> |
5 | .\" Date: 28 October 2011 | 5 | .\" Date: 28 October 2011 |
6 | .\" Manual: Fluxbox Manual | 6 | .\" Manual: Fluxbox Manual |
7 | .\" Source: fluxbox-keys.txt | 7 | .\" Source: fluxbox-keys.txt |
@@ -417,24 +417,24 @@ Reorder the tabs in the current tab group, swapping the current tab with the one | |||
417 | Remove the current tab from the tab group, placing it in its own window\&. | 417 | Remove the current tab from the tab group, placing it in its own window\&. |
418 | .RE | 418 | .RE |
419 | .PP | 419 | .PP |
420 | \fBResizeTo\fR \fIwidth\fR \fIheight\fR | 420 | \fBResizeTo\fR \fIwidth[%]\fR \fIheight[%]\fR |
421 | .RS 4 | 421 | .RS 4 |
422 | Resizes the window to the given width and height\&. | 422 | Resizes the window to the given width and height\&. If the value is given in percent, then the window size will be based on the current screen\(cqs size\&. |
423 | .RE | 423 | .RE |
424 | .PP | 424 | .PP |
425 | \fBResize\fR \fIdelta\-width\fR \fIdelta\-height\fR | 425 | \fBResize\fR \fIdelta\-width[%]\fR \fIdelta\-height[%]\fR |
426 | .RS 4 | 426 | .RS 4 |
427 | Resizes the window relative to the current width and height\&. | 427 | Resizes the window relative to the current width and height\&. If the value is given in percent, then the window size will be based on the current window\(cqs size\&. |
428 | .RE | 428 | .RE |
429 | .PP | 429 | .PP |
430 | \fBResizeHorizontal\fR \fIdelta\-width\fR / \fBResizeVertical\fR \fIdelta\-height\fR | 430 | \fBResizeHorizontal\fR \fIdelta\-width[%]\fR / \fBResizeVertical\fR \fIdelta\-height[%]\fR |
431 | .RS 4 | 431 | .RS 4 |
432 | Resizes the window in one dimension only | 432 | Resizes the window in one dimension only\&. If the value is given in percent, then the window size will be based on the current window\(cqs size\&. |
433 | .RE | 433 | .RE |
434 | .PP | 434 | .PP |
435 | \fBMoveTo\fR \fIx\fR \fIy\fR [\fIanchor\fR] | 435 | \fBMoveTo\fR \fIx[%]\fR \fIy[%]\fR [\fIanchor\fR] |
436 | .RS 4 | 436 | .RS 4 |
437 | Moves the window to the given coordinates, given in pixels\&. | 437 | Moves the window to the given coordinates, given in pixels or relatively to the current screen size if % is specified after the value\&. |
438 | .sp | 438 | .sp |
439 | If either | 439 | If either |
440 | \fIx\fR | 440 | \fIx\fR |
@@ -1034,6 +1034,22 @@ or | |||
1034 | \fBno\fR, depending on whether the window is maximized or not\&. | 1034 | \fBno\fR, depending on whether the window is maximized or not\&. |
1035 | .RE | 1035 | .RE |
1036 | .PP | 1036 | .PP |
1037 | \fBMaximizedHorizontal\fR | ||
1038 | .RS 4 | ||
1039 | Either | ||
1040 | \fByes\fR | ||
1041 | or | ||
1042 | \fBno\fR, depending on whether the window is maximized horizontally or not\&. | ||
1043 | .RE | ||
1044 | .PP | ||
1045 | \fBMaximizedVertical\fR | ||
1046 | .RS 4 | ||
1047 | Either | ||
1048 | \fByes\fR | ||
1049 | or | ||
1050 | \fBno\fR, depending on whether the window is maximized vertically or not\&. | ||
1051 | .RE | ||
1052 | .PP | ||
1037 | \fBMinimized\fR | 1053 | \fBMinimized\fR |
1038 | .RS 4 | 1054 | .RS 4 |
1039 | Either | 1055 | Either |
@@ -1042,6 +1058,14 @@ or | |||
1042 | \fBno\fR, depending on whether the window is minimized (iconified) or not\&. | 1058 | \fBno\fR, depending on whether the window is minimized (iconified) or not\&. |
1043 | .RE | 1059 | .RE |
1044 | .PP | 1060 | .PP |
1061 | \fBFullscreen\fR | ||
1062 | .RS 4 | ||
1063 | Either | ||
1064 | \fByes\fR | ||
1065 | or | ||
1066 | \fBno\fR, depending on whether the window is fullscreen or not\&. | ||
1067 | .RE | ||
1068 | .PP | ||
1045 | \fBShaded\fR | 1069 | \fBShaded\fR |
1046 | .RS 4 | 1070 | .RS 4 |
1047 | Either | 1071 | Either |