aboutsummaryrefslogtreecommitdiff
path: root/doc/fluxbox.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/fluxbox.1.in')
-rw-r--r--doc/fluxbox.1.in120
1 files changed, 115 insertions, 5 deletions
diff --git a/doc/fluxbox.1.in b/doc/fluxbox.1.in
index 8ce7331..dbec41d 100644
--- a/doc/fluxbox.1.in
+++ b/doc/fluxbox.1.in
@@ -199,6 +199,17 @@ The toolbar contains any combination of the following tools, by default in this
199\fBClock\fR: Date and Time 199\fBClock\fR: Date and Time
200.RE 200.RE
201.sp 201.sp
202.RS 4
203.ie n \{\
204\h'-04'\(bu\h'+03'\c
205.\}
206.el \{\
207.sp -1
208.IP \(bu 2.3
209.\}
210\fBButton\&.<name>\fR: A generic button with customizable label and mouse actions
211.RE
212.sp
202The contents and behavior of the toolbar can be configured, see the \fBTOOLBAR\fR section for details\&. 213The contents and behavior of the toolbar can be configured, see the \fBTOOLBAR\fR section for details\&.
203.SS "Slit" 214.SS "Slit"
204.sp 215.sp
@@ -1043,6 +1054,11 @@ The possible tools are:
1043This will show an area to display a clock and the date according to the format specification listed in "man strtftime" 1054This will show an area to display a clock and the date according to the format specification listed in "man strtftime"
1044.RE 1055.RE
1045.PP 1056.PP
1057\fBButton\&.<name>\fR
1058.RS 4
1059This displays a clickable label with custom text\&.
1060.RE
1061.PP
1046\fBIconbar\fR 1062\fBIconbar\fR
1047.RS 4 1063.RS 4
1048This is the area that contains all windows (all running applications, all minimized windows or maybe no window, all depending on the Toolbar Settings)\&. 1064This is the area that contains all windows (all running applications, all minimized windows or maybe no window, all depending on the Toolbar Settings)\&.
@@ -1097,6 +1113,13 @@ If this is enabled the toolbar will disappear after a defined time when the mous
1097resource for the delay time\&. 1113resource for the delay time\&.
1098.RE 1114.RE
1099.PP 1115.PP
1116\fBAuto raise\fR
1117.RS 4
1118If this is enabled the toolbar will elevate after a defined time when the mouse pointer enters the it\&. It will fall back when the cursor leaves the toolbar\&. See the
1119\fBsession\&.autoRaiseDelay\fR
1120resource for the delay time\&.
1121.RE
1122.PP
1100\fBToolbar width percentage\fR 1123\fBToolbar width percentage\fR
1101.RS 4 1124.RS 4
1102Sets the width of the toolbar in a percentage of your total screen size\&. Use the left mouse button to decrease and the right mouse\-button to increase the value\&. The value can be from 1\-100\&. 1125Sets the width of the toolbar in a percentage of your total screen size\&. Use the left mouse button to decrease and the right mouse\-button to increase the value\&. The value can be from 1\-100\&.
@@ -1221,6 +1244,11 @@ Click to focus windows\&.
1221Window focus follows mouse\&. 1244Window focus follows mouse\&.
1222.RE 1245.RE
1223.PP 1246.PP
1247\fBMouse Focus (Strict)\fR
1248.RS 4
1249Like Mouse Focus, but no mouse movement is required, ie\&. the window is also focused if it moves below the mouse, eg\&. because it shows up or you change the virtual desktop\&.
1250.RE
1251.PP
1224\fBClickTabFocus\fR 1252\fBClickTabFocus\fR
1225.RS 4 1253.RS 4
1226Click to focus tabs\&. 1254Click to focus tabs\&.
@@ -1328,6 +1356,13 @@ If this is enabled the slit will disappear after a defined time when the mouse p
1328resource for the delay time\&. 1356resource for the delay time\&.
1329.RE 1357.RE
1330.PP 1358.PP
1359\fBAuto raise\fR
1360.RS 4
1361If this is enabled the slit will elevate after a defined time when the mouse pointer enters the it\&. It will fall back when the cursor leaves the slit\&. See the
1362\fBsession\&.autoRaiseDelay\fR
1363resource for the delay time\&.
1364.RE
1365.PP
1331\fBMaximize Over\fR 1366\fBMaximize Over\fR
1332.RS 4 1367.RS 4
1333Enabling this option will allow windows to maximizing over the slit\&. With this switched off they will only expand to the edge of the slit\&. This option may be overridden by the \(lqFull Maximization\(rq from the 1368Enabling this option will allow windows to maximizing over the slit\&. With this switched off they will only expand to the edge of the slit\&. This option may be overridden by the \(lqFull Maximization\(rq from the
@@ -1450,6 +1485,16 @@ Default:
1450\fBFalse\fR 1485\fBFalse\fR
1451.RE 1486.RE
1452.PP 1487.PP
1488\fBsession\&.screen0\&.{slit|toolbar}\&.autoRaise\fR: \fIboolean\fR
1489.RS 4
1490If enabled, the respective item will elevate to the AboveDock layer when entered and fall back to its regular layer when left\&. Notice that this does
1491\fBnot\fR
1492implicitly alter the items regular layer or the workspace padding, ie\&. if the item is already set to AboveDock this does nothing and if a mximized window completely covers the item you won\(cqt be able to enter, thus elevate it\&.
1493.sp
1494Default:
1495\fBFalse\fR
1496.RE
1497.PP
1453\fBsession\&.screen0\&.{slit|toolbar}\&.layer\fR: \fIlayer\fR 1498\fBsession\&.screen0\&.{slit|toolbar}\&.layer\fR: \fIlayer\fR
1454.RS 4 1499.RS 4
1455With these two resources, you can set the layer you want the toolbar and the slit to appear on\&. Please read the LAYER section for more information\&. 1500With these two resources, you can set the layer you want the toolbar and the slit to appear on\&. Please read the LAYER section for more information\&.
@@ -1514,7 +1559,7 @@ character\&. They will appear in the order given\&.
1514.PP 1559.PP
1515Possible tools: 1560Possible tools:
1516.RS 4 1561.RS 4
1517\fBclock iconbar nextwindow prevwindow nextworkspace prevworkspace systemtray workspacename\fR 1562\fBclock iconbar nextwindow prevwindow nextworkspace prevworkspace systemtray workspacename button\&.<name>\fR
1518.RE 1563.RE
1519.PP 1564.PP
1520Default: 1565Default:
@@ -1567,6 +1612,15 @@ Default:
1567\fBsession\&.screen0\&.iconbar\&.alignment\fR: \fIposition\fR 1612\fBsession\&.screen0\&.iconbar\&.alignment\fR: \fIposition\fR
1568.RS 4 1613.RS 4
1569This value should be changed in the Iconbar Mode menu\&. 1614This value should be changed in the Iconbar Mode menu\&.
1615.RE
1616.PP
1617\fBsession\&.screen0\&.iconbar\&.iconifiedPattern\fR: \fIstring\fR
1618.RS 4
1619Allows to decorate the title of iconified (minimized) windows\&. The title is represented by "%t"\&.
1620.sp
1621Default:
1622\fB( %t )\fR
1623.RE
1570.PP 1624.PP
1571Available options: 1625Available options:
1572.RS 4 1626.RS 4
@@ -1605,9 +1659,7 @@ Available options:
1605.RE 1659.RE
1606.RE 1660.RE
1607.sp 1661.sp
1608Default: 1662+ Default: \fBRelative\fR
1609\fBRelative\fR
1610.RE
1611.PP 1663.PP
1612\fBsession\&.screen0\&.iconbar\&.iconWidth\fR: \fIinteger\fR 1664\fBsession\&.screen0\&.iconbar\&.iconWidth\fR: \fIinteger\fR
1613.RS 4 1665.RS 4
@@ -1745,7 +1797,7 @@ Default:
1745.PP 1797.PP
1746\fBsession\&.screen0\&.edgeResizeSnapThreshold\fR: \fIinteger\fR 1798\fBsession\&.screen0\&.edgeResizeSnapThreshold\fR: \fIinteger\fR
1747.RS 4 1799.RS 4
1748When resizing a window by grabbing a corner, fluxbox is able to have it \(oqsnap\(cq to the edges of the screen and other windows for easy placement\&. This variable tells fluxbox the distance (in pixels) at which the window corner will jump to the edge\&. 1800When resizing a window by grabbing a corner, fluxbox is able to have it \(oqsnap\(cq to the edges of the screen and other windows for easy placement\&. This variable tells fluxbox the distance (in pixels) at which the window will jump to the edge\&.
1749.sp 1801.sp
1750Default: 1802Default:
1751\fB0\fR 1803\fB0\fR
@@ -1801,6 +1853,39 @@ CascadePlacement: places windows below the titlebar of the previous one
1801.\} 1853.\}
1802UnderMousePlacement: places new windows underneath the mouse 1854UnderMousePlacement: places new windows underneath the mouse
1803.RE 1855.RE
1856.sp
1857.RS 4
1858.ie n \{\
1859\h'-04'\(bu\h'+03'\c
1860.\}
1861.el \{\
1862.sp -1
1863.IP \(bu 2.3
1864.\}
1865RowMinOverlapPlacement: place windows in rows with minimal overlapping
1866.RE
1867.sp
1868.RS 4
1869.ie n \{\
1870\h'-04'\(bu\h'+03'\c
1871.\}
1872.el \{\
1873.sp -1
1874.IP \(bu 2.3
1875.\}
1876ColMinOverlapPlacement: place windows in columns with minimal overlapping
1877.RE
1878.sp
1879.RS 4
1880.ie n \{\
1881\h'-04'\(bu\h'+03'\c
1882.\}
1883.el \{\
1884.sp -1
1885.IP \(bu 2.3
1886.\}
1887AutotabPlacement: tabs the window to the currently focused one
1888.RE
1804.RE 1889.RE
1805.sp 1890.sp
1806Default: 1891Default:
@@ -1847,6 +1932,31 @@ Default:
1847\fB4\fR 1932\fB4\fR
1848.RE 1933.RE
1849.PP 1934.PP
1935\fBsession\&.screen0\&.struts\fR: \fIinteger\fR, \fIinteger\fR, \fIinteger\fR, \fIinteger\fR
1936.RS 4
1937Shrink the workspace by left, right, top, bottom pixels (positive integers) This allows you to add some padding to the workspace eg\&. to keep a fraction of the desktop visible against maximized windows\&. session\&.screen0\&.struts\&.<n> allows to control this for individual heads (<n> starts counting at 1)
1938.sp
1939Default:
1940\fB0,0,0,0\fR
1941.RE
1942.PP
1943\fBsession\&.screen0\&.toolbar\&.button\&.<name>\&.label\fR: \fIstring\fR
1944.RS 4
1945The label text for the toolbar button tool "button\&.<name>"
1946.sp
1947Default:
1948\fBblank\fR
1949.RE
1950.PP
1951\fBsession\&.screen0\&.toolbar\&.button\&.<name>\&.commands\fR: \fIstring\fR:\*(Aqstring\*(Aq:\*(Aqstring\*(Aq:\*(Aqstring\*(Aq:\*(Aqstring\*(Aq
1952.RS 4
1953A colon delimited list of commands, executed when the respective mouse button is pressed on the toolbar button tool "button\&.<name>" The commands are the same as those detailed in
1954\fBfluxbox\-keys(5)\fR\&.
1955.sp
1956Default:
1957\fBblank\fR
1958.RE
1959.PP
1850\fBsession\&.cacheLife\fR: \fIminutes\fR 1960\fBsession\&.cacheLife\fR: \fIminutes\fR
1851.RS 4 1961.RS 4
1852This tells fluxbox how long unused pixmaps may stay in the X server\(cqs memory\&. 1962This tells fluxbox how long unused pixmaps may stay in the X server\(cqs memory\&.