fix documentation of TAB decoration mask
Mark Tiefenbruck mark@fluxbox.org
3 files changed,
73 insertions(+),
23 deletions(-)
M
doc/asciidoc/fluxbox-apps.txt
→
doc/asciidoc/fluxbox-apps.txt
@@ -137,10 +137,10 @@ *NORMAL*;;
Standard decorations *NONE*;; No decorations - *TAB* - Like TAB except keep the tabs - *Border*;; + *BORDER*;; Like NONE except keep the X window border + *TAB*;; + Like BORDER except keep external tabs (if enabled) *TINY*;; Titlebar with only an iconify button *TOOL*;;@@ -150,8 +150,7 @@ --
+ The 'value' 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. +Button, Close Button, Menu Button, Sticky Button, Shade Button, External Tabs, Focus Enabled. *[Shaded]* {'bool'}:: Whether the window is Shaded (rolled-up) or not.
M
doc/fluxbox-apps.5.in
→
doc/fluxbox-apps.5.in
@@ -1,7 +1,7 @@
'\" t .\" Title: fluxbox-apps .\" Author: Jim Ramsay <i.am@jimramsay.com> -.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> +.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: 28 October 2011 .\" Manual: Fluxbox Manual .\" Source: fluxbox-apps.txt@@ -137,18 +137,18 @@ .RS 4
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\&. .RE .PP -\fB[Dimensions]\fR {\fIwidth\fR \fIheight\fR} +\fB[Dimensions]\fR {\fIwidth[%]\fR \fIheight[%]\fR} .RS 4 Opens the application with the specified \fIwidth\fR and -\fIheight\fR, in pixels\&. +\fIheight\fR, in pixels\&. If the value is given in percent, then the window size will be based on the current screen\(cqs size\&. .RE .PP -\fB[Position]\fR (\fIanchor\fR) {\fIX\fR \fIY\fR} +\fB[Position]\fR (\fIanchor\fR) {\fIX[%]\fR \fIY[%]\fR} .RS 4 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 -\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\&. +\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\&. .PP \fIanchor\fR may be set to one of: .RS 4@@ -171,13 +171,16 @@ .PP
\fBNONE\fR .RS 4 No decorations -\fBTAB\fR -Like TAB except keep the tabs .RE .PP -\fBBorder\fR +\fBBORDER\fR .RS 4 Like NONE except keep the X window border +.RE +.PP +\fBTAB\fR +.RS 4 +Like BORDER except keep external tabs (if enabled) .RE .PP \fBTINY\fR@@ -192,7 +195,7 @@ .RE
.sp The \fIvalue\fR -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\&. +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\&. .RE .RE .PP@@ -348,12 +351,36 @@ or
\fBno\fR, depending on whether the window is maximized or not\&. .RE .PP +\fBMaximizedHorizontal\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is maximized horizontally or not\&. +.RE +.PP +\fBMaximizedVertical\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is maximized vertically or not\&. +.RE +.PP \fBMinimized\fR .RS 4 Either \fByes\fR or \fBno\fR, depending on whether the window is minimized (iconified) or not\&. +.RE +.PP +\fBFullscreen\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is fullscreen or not\&. .RE .PP \fBShaded\fR
M
doc/fluxbox-keys.5.in
→
doc/fluxbox-keys.5.in
@@ -1,7 +1,7 @@
'\" t .\" Title: fluxbox-keys .\" Author: Jim Ramsay <i.am@jimramsay.com> -.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> +.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: 28 October 2011 .\" Manual: Fluxbox Manual .\" Source: fluxbox-keys.txt@@ -417,24 +417,24 @@ .RS 4
Remove the current tab from the tab group, placing it in its own window\&. .RE .PP -\fBResizeTo\fR \fIwidth\fR \fIheight\fR +\fBResizeTo\fR \fIwidth[%]\fR \fIheight[%]\fR .RS 4 -Resizes the window to the given width and height\&. +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\&. .RE .PP -\fBResize\fR \fIdelta\-width\fR \fIdelta\-height\fR +\fBResize\fR \fIdelta\-width[%]\fR \fIdelta\-height[%]\fR .RS 4 -Resizes the window relative to the current width and height\&. +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\&. .RE .PP -\fBResizeHorizontal\fR \fIdelta\-width\fR / \fBResizeVertical\fR \fIdelta\-height\fR +\fBResizeHorizontal\fR \fIdelta\-width[%]\fR / \fBResizeVertical\fR \fIdelta\-height[%]\fR .RS 4 -Resizes the window in one dimension only +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\&. .RE .PP -\fBMoveTo\fR \fIx\fR \fIy\fR [\fIanchor\fR] +\fBMoveTo\fR \fIx[%]\fR \fIy[%]\fR [\fIanchor\fR] .RS 4 -Moves the window to the given coordinates, given in pixels\&. +Moves the window to the given coordinates, given in pixels or relatively to the current screen size if % is specified after the value\&. .sp If either \fIx\fR@@ -1034,12 +1034,36 @@ or
\fBno\fR, depending on whether the window is maximized or not\&. .RE .PP +\fBMaximizedHorizontal\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is maximized horizontally or not\&. +.RE +.PP +\fBMaximizedVertical\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is maximized vertically or not\&. +.RE +.PP \fBMinimized\fR .RS 4 Either \fByes\fR or \fBno\fR, depending on whether the window is minimized (iconified) or not\&. +.RE +.PP +\fBFullscreen\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is fullscreen or not\&. .RE .PP \fBShaded\fR