nilix/fluxbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Synchronize manpages .in files with their .txt files

Browse source 
The .in files are generated from the .txt files.
This commit is contained in:
Jan Sucan 2020-04-12 08:31:44 +02:00 committed by Mathias Gumz
parent 7559d60edf
commit f48237e3ad
5 changed files with 229 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
doc/fbrun.1.in
View file

@ -77,6 +77,11 @@ Window position in pixels
Position the window under the mouse cursor
.RE
.PP
\fB\-center\fR
.RS 4
Position the window on the screen center
.RE
.PP
\fB\-fg\fR \fIcolor\fR
.RS 4
Foreground text color\&. The default is
@ -100,9 +105,21 @@ History file to load\&. The default is
\fB~/\&.fluxbox/fbrun_history\fR\&.
.RE
.PP
\fB\-cf\fR \fIfilename\fR
.RS 4
Completion data to load\&. The default is empty\&. If no data can be loaded, completion defaults to executables in $PATH
.RE
.PP
\fB\-preselect\fR
.RS 4
Select the preset text given by the \fB\&-text\fR\& parameter
Select the preset text given by the
\fB\-text\fR
parameter
.RE
.PP
\fB\-autocomplete\fR
.RS 4
Complete on typing\&. You can also set the FBRUN_AUTOCOMPLETE environment (to any value)
.RE
.PP
\fB\-help\fR

59
doc/fluxbox-apps.5.in
View file

@ -65,6 +65,11 @@ Each of these sections ends with the single line
.RS 4
\fB[end]\fR
.RE
.SH "TRANSIENT SECTIONS"
.sp
\fB[transient]\fR sections provide settings for "dialogs"\&.
.sp
This 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\&.
.SH "GROUP SECTIONS"
.sp
The 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
\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[IgnoreSizeHints]\fR {\fIbool\fR}
.RS 4
Some Applications restrict the aspect ratio, minimum or maximum size of windows\&. Setting this key "yes" will make fluxbox ignore those constraints\&.
\fBNOTICE\fR
that bad client implementations may hard depend on these constraints (by blindly using their geometry in unsave calculations, causing div\-by\-zero segfaults etc\&.)
.RE
.PP
\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
@ -199,8 +211,55 @@ Whether the window has tabs enabled\&.
.PP
\fB[FocusNewWindow]\fR {\fIbool\fR}
.RS 4
.PP
\fBDEPRECATED!\fR Please use FocusProtection "Gain" or "Refuse" instead\&.
.RS 4
If 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\&.
.RE
.RE
.PP
\fB[FocusProtection]\fR {\fIvalue\fR [,\fIvalue\fR [, \&...]] }
.RS 4
.PP
Comma separated list of focus controlling flags\&. \fIvalue\fR may be:
.RS 4
.PP
\fBNone\fR
.RS 4
Regular behavior
.RE
.PP
\fBGain\fR
.RS 4
A new window will grab X focus as soon as it is opened\&.
.RE
.PP
\fBRefuse\fR
.RS 4
A new window will not grab X focus as soon as it is opened\&.
.RE
.PP
\fBDeny\fR
.RS 4
The window is not allowed to claim focus while it is opened\&.
.RE
.PP
\fBLock\fR
.RS 4
No window is allowed to claim the focus while this window has it\&.
.RE
.sp
.if n \{\
.RS 4
.\}
.nf
Please 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\&.
.fi
.if n \{\
.RE
.\}
.RE
.RE
.PP
\fB[FocusHidden]\fR {\fIbool\fR}
.RS 4

36
doc/fluxbox-keys.5.in
View file

@ -75,6 +75,11 @@ The mouse cursor is over the desktop (root window), and not any window\&.
The mouse cursor is over the toolbar (which is normally at the bottom of the screen)\&.
.RE
.PP
\fBOnSlit\fR
.RS 4
The mouse cursor is over the mystic slit (the thing that collects dock type windows)\&.
.RE
.PP
\fBOnWindow\fR
.RS 4
The mouse cursor is over a window\&.
@ -554,7 +559,7 @@ Adds or removes a workspace from the end of the list of workspaces\&.
Switch to the Next / Previous workspace\&. All versions accept an offset value
\fIn\fR, which defaults to
\fB1\fR
and 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\&.
and 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
.RE
.PP
\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
places the main window on the BOTTOM half of the screen and the tiled windows on the top half of the screen\&.
.RE
.PP
\fBUnclutter\fR \fIpattern\fR
.RS 4
Arrange all matching windows to reduce the overall window overlap as much as possible\&. Windows are not resized\&. See
\fBCLIENT PATTERNS\fR
for more about the
\fIpattern\fR
arguments\&.
.RE
.PP
\fBShowDesktop\fR
.RS 4
Minimizes all windows on the current workspace\&. If they are already all minimized, then it restores them\&.
.RE
.PP
\fBToggleSlitAbove\fR
.RS 4
Toggles the slit between its regular and the AboveDock layer
.RE
.PP
\fBToggleSlitHidden\fR
.RS 4
Toggles the slit\(cqs autohiding state (autohide doesn\(cqt have to be enabled)
.RE
.PP
\fBToggleToolbarAbove\fR
.RS 4
Toggles the toolbar between its regular and the AboveDock layer
.RE
.PP
\fBToggleToolbarHidden\fR
.RS 4
Toggles the toolbar\(cqs autohiding state (autohide doesn\(cqt have to be enabled)
.RE
.PP
\fBDeiconify\fR \fImode\fR \fIdestination\fR
.RS 4
Deiconifies windows (or, restores from a minimized state)\&.

4
doc/fluxbox-menu.5.in
View file

@ -238,9 +238,9 @@ for more information\&.
.RE
.SH "WINDOW MENU"
.sp
The 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\&.
The 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\&.
.sp
The additional available tags in this menu are:
The additonal available tags in this menu are:
.PP
\fB[shade]\fR
.RS 4

120
doc/fluxbox.1.in
View file

@ -199,6 +199,17 @@ The toolbar contains any combination of the following tools, by default in this
\fBClock\fR: Date and Time
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBButton\&.<name>\fR: A generic button with customizable label and mouse actions
.RE
.sp
The contents and behavior of the toolbar can be configured, see the \fBTOOLBAR\fR section for details\&.
.SS "Slit"
.sp
@ -1043,6 +1054,11 @@ The possible tools are:
This will show an area to display a clock and the date according to the format specification listed in "man strtftime"
.RE
.PP
\fBButton\&.<name>\fR
.RS 4
This displays a clickable label with custom text\&.
.RE
.PP
\fBIconbar\fR
.RS 4
This 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
resource for the delay time\&.
.RE
.PP
\fBAuto raise\fR
.RS 4
If 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
\fBsession\&.autoRaiseDelay\fR
resource for the delay time\&.
.RE
.PP
\fBToolbar width percentage\fR
.RS 4
Sets 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\&.
Window focus follows mouse\&.
.RE
.PP
\fBMouse Focus (Strict)\fR
.RS 4
Like 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\&.
.RE
.PP
\fBClickTabFocus\fR
.RS 4
Click to focus tabs\&.
@ -1328,6 +1356,13 @@ If this is enabled the slit will disappear after a defined time when the mouse p
resource for the delay time\&.
.RE
.PP
\fBAuto raise\fR
.RS 4
If 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
\fBsession\&.autoRaiseDelay\fR
resource for the delay time\&.
.RE
.PP
\fBMaximize Over\fR
.RS 4
Enabling 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:
\fBFalse\fR
.RE
.PP
\fBsession\&.screen0\&.{slit|toolbar}\&.autoRaise\fR: \fIboolean\fR
.RS 4
If 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
\fBnot\fR
implicitly 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\&.
.sp
Default:
\fBFalse\fR
.RE
.PP
\fBsession\&.screen0\&.{slit|toolbar}\&.layer\fR: \fIlayer\fR
.RS 4
With 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\&.
.PP
Possible tools:
.RS 4
\fBclock iconbar nextwindow prevwindow nextworkspace prevworkspace systemtray workspacename\fR
\fBclock iconbar nextwindow prevwindow nextworkspace prevworkspace systemtray workspacename button\&.<name>\fR
.RE
.PP
Default:
@ -1567,6 +1612,15 @@ Default:
\fBsession\&.screen0\&.iconbar\&.alignment\fR: \fIposition\fR
.RS 4
This value should be changed in the Iconbar Mode menu\&.
.RE
.PP
\fBsession\&.screen0\&.iconbar\&.iconifiedPattern\fR: \fIstring\fR
.RS 4
Allows to decorate the title of iconified (minimized) windows\&. The title is represented by "%t"\&.
.sp
Default:
\fB( %t )\fR
.RE
.PP
Available options:
.RS 4
@ -1605,9 +1659,7 @@ Available options:
.RE
.RE
.sp
Default:
\fBRelative\fR
.RE
+ Default: \fBRelative\fR
.PP
\fBsession\&.screen0\&.iconbar\&.iconWidth\fR: \fIinteger\fR
.RS 4
@ -1745,7 +1797,7 @@ Default:
.PP
\fBsession\&.screen0\&.edgeResizeSnapThreshold\fR: \fIinteger\fR
.RS 4
When 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\&.
When 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\&.
.sp
Default:
\fB0\fR
@ -1801,6 +1853,39 @@ CascadePlacement: places windows below the titlebar of the previous one
.\}
UnderMousePlacement: places new windows underneath the mouse
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
RowMinOverlapPlacement: place windows in rows with minimal overlapping
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ColMinOverlapPlacement: place windows in columns with minimal overlapping
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
AutotabPlacement: tabs the window to the currently focused one
.RE
.RE
.sp
Default:
@ -1847,6 +1932,31 @@ Default:
\fB4\fR
.RE
.PP
\fBsession\&.screen0\&.struts\fR: \fIinteger\fR, \fIinteger\fR, \fIinteger\fR, \fIinteger\fR
.RS 4
Shrink 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)
.sp
Default:
\fB0,0,0,0\fR
.RE
.PP
\fBsession\&.screen0\&.toolbar\&.button\&.<name>\&.label\fR: \fIstring\fR
.RS 4
The label text for the toolbar button tool "button\&.<name>"
.sp
Default:
\fBblank\fR
.RE
.PP
\fBsession\&.screen0\&.toolbar\&.button\&.<name>\&.commands\fR: \fIstring\fR:\*(Aqstring\*(Aq:\*(Aqstring\*(Aq:\*(Aqstring\*(Aq:\*(Aqstring\*(Aq
.RS 4
A 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
\fBfluxbox\-keys(5)\fR\&.
.sp
Default:
\fBblank\fR
.RE
.PP
\fBsession\&.cacheLife\fR: \fIminutes\fR
.RS 4
This tells fluxbox how long unused pixmaps may stay in the X server\(cqs memory\&.