aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan Sucan <jan@jansucan.com>2020-04-12 06:31:44 (GMT)
committerMathias Gumz <akira@fluxbox.org>2020-04-19 12:53:54 (GMT)
commitf48237e3ade27dbf69c1e87b80224445d50b1763 (patch)
tree92f49da3cdfd8af8a9f9031855df7f572a2eeb40
parent7559d60edf59584f1a780ff1952d611c0b1f26b5 (diff)
downloadfluxbox-f48237e3ade27dbf69c1e87b80224445d50b1763.zip
fluxbox-f48237e3ade27dbf69c1e87b80224445d50b1763.tar.bz2
Synchronize manpages .in files with their .txt files
The .in files are generated from the .txt files.
-rw-r--r--doc/fbrun.1.in19
-rw-r--r--doc/fluxbox-apps.5.in59
-rw-r--r--doc/fluxbox-keys.5.in36
-rw-r--r--doc/fluxbox-menu.5.in4
-rw-r--r--doc/fluxbox.1.in120
5 files changed, 229 insertions, 9 deletions
diff --git a/doc/fbrun.1.in b/doc/fbrun.1.in
index bc338de..9e6123b 100644
--- a/doc/fbrun.1.in
+++ b/doc/fbrun.1.in
@@ -77,6 +77,11 @@ Window position in pixels
77Position the window under the mouse cursor 77Position the window under the mouse cursor
78.RE 78.RE
79.PP 79.PP
80\fB\-center\fR
81.RS 4
82Position the window on the screen center
83.RE
84.PP
80\fB\-fg\fR \fIcolor\fR 85\fB\-fg\fR \fIcolor\fR
81.RS 4 86.RS 4
82Foreground text color\&. The default is 87Foreground text color\&. The default is
@@ -100,9 +105,21 @@ History file to load\&. The default is
100\fB~/\&.fluxbox/fbrun_history\fR\&. 105\fB~/\&.fluxbox/fbrun_history\fR\&.
101.RE 106.RE
102.PP 107.PP
108\fB\-cf\fR \fIfilename\fR
109.RS 4
110Completion data to load\&. The default is empty\&. If no data can be loaded, completion defaults to executables in $PATH
111.RE
112.PP
103\fB\-preselect\fR 113\fB\-preselect\fR
104.RS 4 114.RS 4
105Select the preset text given by the \fB\&-text\fR\& parameter 115Select the preset text given by the
116\fB\-text\fR
117parameter
118.RE
119.PP
120\fB\-autocomplete\fR
121.RS 4
122Complete on typing\&. You can also set the FBRUN_AUTOCOMPLETE environment (to any value)
106.RE 123.RE
107.PP 124.PP
108\fB\-help\fR 125\fB\-help\fR
diff --git a/doc/fluxbox-apps.5.in b/doc/fluxbox-apps.5.in
index 844af38..d551b30 100644
--- a/doc/fluxbox-apps.5.in
+++ b/doc/fluxbox-apps.5.in
@@ -65,6 +65,11 @@ Each of these sections ends with the single line
65.RS 4 65.RS 4
66\fB[end]\fR 66\fB[end]\fR
67.RE 67.RE
68.SH "TRANSIENT SECTIONS"
69.sp
70\fB[transient]\fR sections provide settings for "dialogs"\&.
71.sp
72This is the same as the \fB[app]\fR section, but applies to transient windows\&. Transient windows have a WM_TRANSIENT_FOR property\&. This will apply to all modal and several other dialogs which have a "leader" they remain above\&. Notably, open/save dialogs fall into this category\&.
68.SH "GROUP SECTIONS" 73.SH "GROUP SECTIONS"
69.sp 74.sp
70The primary purpose of \fB[group]\fR sections is to group windows together\&. All windows in a group will be tabbed together automatically\&. 75The primary purpose of \fB[group]\fR sections is to group windows together\&. All windows in a group will be tabbed together automatically\&.
@@ -134,6 +139,13 @@ and
134\fIheight\fR, in pixels\&. If the value is given in percent, then the window size will be based on the current screen\(cqs size\&. 139\fIheight\fR, in pixels\&. If the value is given in percent, then the window size will be based on the current screen\(cqs size\&.
135.RE 140.RE
136.PP 141.PP
142\fB[IgnoreSizeHints]\fR {\fIbool\fR}
143.RS 4
144Some Applications restrict the aspect ratio, minimum or maximum size of windows\&. Setting this key "yes" will make fluxbox ignore those constraints\&.
145\fBNOTICE\fR
146that bad client implementations may hard depend on these constraints (by blindly using their geometry in unsave calculations, causing div\-by\-zero segfaults etc\&.)
147.RE
148.PP
137\fB[Position]\fR (\fIanchor\fR) {\fIX[%]\fR \fIY[%]\fR} 149\fB[Position]\fR (\fIanchor\fR) {\fIX[%]\fR \fIY[%]\fR}
138.RS 4 150.RS 4
139Position 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 151Position 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
@@ -199,8 +211,55 @@ Whether the window has tabs enabled\&.
199.PP 211.PP
200\fB[FocusNewWindow]\fR {\fIbool\fR} 212\fB[FocusNewWindow]\fR {\fIbool\fR}
201.RS 4 213.RS 4
214.PP
215\fBDEPRECATED!\fR Please use FocusProtection "Gain" or "Refuse" instead\&.
216.RS 4
202If enabled, a new window will grab X focus as soon as it is opened\&. If disabled, a new window will not grab X focus as soon as it is opened\&. 217If enabled, a new window will grab X focus as soon as it is opened\&. If disabled, a new window will not grab X focus as soon as it is opened\&.
203.RE 218.RE
219.RE
220.PP
221\fB[FocusProtection]\fR {\fIvalue\fR [,\fIvalue\fR [, \&...]] }
222.RS 4
223.PP
224Comma separated list of focus controlling flags\&. \fIvalue\fR may be:
225.RS 4
226.PP
227\fBNone\fR
228.RS 4
229Regular behavior
230.RE
231.PP
232\fBGain\fR
233.RS 4
234A new window will grab X focus as soon as it is opened\&.
235.RE
236.PP
237\fBRefuse\fR
238.RS 4
239A new window will not grab X focus as soon as it is opened\&.
240.RE
241.PP
242\fBDeny\fR
243.RS 4
244The window is not allowed to claim focus while it is opened\&.
245.RE
246.PP
247\fBLock\fR
248.RS 4
249No window is allowed to claim the focus while this window has it\&.
250.RE
251.sp
252.if n \{\
253.RS 4
254.\}
255.nf
256Please notice that technically, windows may still obtain the focus which is then however reverted by the WM\&. In case you\*(Aqre very unlucky, a key event may thus still go to the wrong window\&.
257.fi
258.if n \{\
259.RE
260.\}
261.RE
262.RE
204.PP 263.PP
205\fB[FocusHidden]\fR {\fIbool\fR} 264\fB[FocusHidden]\fR {\fIbool\fR}
206.RS 4 265.RS 4
diff --git a/doc/fluxbox-keys.5.in b/doc/fluxbox-keys.5.in
index 0d5c041..aa460e6 100644
--- a/doc/fluxbox-keys.5.in
+++ b/doc/fluxbox-keys.5.in
@@ -75,6 +75,11 @@ The mouse cursor is over the desktop (root window), and not any window\&.
75The mouse cursor is over the toolbar (which is normally at the bottom of the screen)\&. 75The mouse cursor is over the toolbar (which is normally at the bottom of the screen)\&.
76.RE 76.RE
77.PP 77.PP
78\fBOnSlit\fR
79.RS 4
80The mouse cursor is over the mystic slit (the thing that collects dock type windows)\&.
81.RE
82.PP
78\fBOnWindow\fR 83\fBOnWindow\fR
79.RS 4 84.RS 4
80The mouse cursor is over a window\&. 85The mouse cursor is over a window\&.
@@ -554,7 +559,7 @@ Adds or removes a workspace from the end of the list of workspaces\&.
554Switch to the Next / Previous workspace\&. All versions accept an offset value 559Switch to the Next / Previous workspace\&. All versions accept an offset value
555\fIn\fR, which defaults to 560\fIn\fR, which defaults to
556\fB1\fR 561\fB1\fR
557and refers to the number of workspaces to move at one time\&. {Next,Prev}Workspace wrap around when going past the last workspace, whereas {Right,Left}Workspace do not\&. 562and refers to the number of workspaces to move at one time\&. {Next,Prev}Workspace wrap around when going past the last workspace, whereas {Right,Left}Workspace do not\&. The special offset "0" will toggle the former workspace for Next\- and PrevWorkspace
558.RE 563.RE
559.PP 564.PP
560\fBWorkspace\fR \fInumber\fR 565\fBWorkspace\fR \fInumber\fR
@@ -673,11 +678,40 @@ places the main window on the TOP half of the screen, and the tiled windows on t
673places the main window on the BOTTOM half of the screen and the tiled windows on the top half of the screen\&. 678places the main window on the BOTTOM half of the screen and the tiled windows on the top half of the screen\&.
674.RE 679.RE
675.PP 680.PP
681\fBUnclutter\fR \fIpattern\fR
682.RS 4
683Arrange all matching windows to reduce the overall window overlap as much as possible\&. Windows are not resized\&. See
684\fBCLIENT PATTERNS\fR
685for more about the
686\fIpattern\fR
687arguments\&.
688.RE
689.PP
676\fBShowDesktop\fR 690\fBShowDesktop\fR
677.RS 4 691.RS 4
678Minimizes all windows on the current workspace\&. If they are already all minimized, then it restores them\&. 692Minimizes all windows on the current workspace\&. If they are already all minimized, then it restores them\&.
679.RE 693.RE
680.PP 694.PP
695\fBToggleSlitAbove\fR
696.RS 4
697Toggles the slit between its regular and the AboveDock layer
698.RE
699.PP
700\fBToggleSlitHidden\fR
701.RS 4
702Toggles the slit\(cqs autohiding state (autohide doesn\(cqt have to be enabled)
703.RE
704.PP
705\fBToggleToolbarAbove\fR
706.RS 4
707Toggles the toolbar between its regular and the AboveDock layer
708.RE
709.PP
710\fBToggleToolbarHidden\fR
711.RS 4
712Toggles the toolbar\(cqs autohiding state (autohide doesn\(cqt have to be enabled)
713.RE
714.PP
681\fBDeiconify\fR \fImode\fR \fIdestination\fR 715\fBDeiconify\fR \fImode\fR \fIdestination\fR
682.RS 4 716.RS 4
683Deiconifies windows (or, restores from a minimized state)\&. 717Deiconifies windows (or, restores from a minimized state)\&.
diff --git a/doc/fluxbox-menu.5.in b/doc/fluxbox-menu.5.in
index 84dd4b7..c2d2d36 100644
--- a/doc/fluxbox-menu.5.in
+++ b/doc/fluxbox-menu.5.in
@@ -238,9 +238,9 @@ for more information\&.
238.RE 238.RE
239.SH "WINDOW MENU" 239.SH "WINDOW MENU"
240.sp 240.sp
241The syntax for the Window Menu is mostly identical to that for the \fBROOT MENU\fR; it must start with \fB[begin]\fR and end with \fB[end]\fR, and may have any of the above tags\&. However, it may also contain any of the following window-specific \fB[\fR\fItag\fR\fB]\fRs, which each must be on a line by itself with no labels, commands, or icons\&. 241The syntax for the Window Menu is mostly identical to that for the \fBROOT MENU\fR; it must start with \fB[begin]\fR and end with \fB[end]\fR, and may have any of the above tags\&. However, it may also contain any of the following window\-specific \fB[\fR\fItag\fR*]*s, which each must be on a line by itself with no labels, commands, or icons\&.
242.sp 242.sp
243The additional available tags in this menu are: 243The additonal available tags in this menu are:
244.PP 244.PP
245\fB[shade]\fR 245\fB[shade]\fR
246.RS 4 246.RS 4
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\&.