all repos — fluxbox @ 56e393a71c9b5da57e615af64fd7cd3011da31e7

custom fork of the fluxbox windowmanager

Added fluxbox-apps(5) manpage

This now shares the CLIENT PATTERNS section in common with fluxbox-keys(5), so I
split this out into a client-patterns.txt which is included by both
fluxbox-apps.txt and fluxbox-keys.txt.
Jim Ramsay i.am@jimramsay.com
commit

56e393a71c9b5da57e615af64fd7cd3011da31e7

parent

49ec77449f219df4950a45902a1273d5e50030f6

M doc/Makefile.amdoc/Makefile.am

@@ -5,8 +5,8 @@ SUBDIRS = ru

CLEANFILES = fluxbox.1 fluxstyle.1 MAINTAINERCLEANFILES = Makefile.in man_MANS = fluxbox.1 fbsetroot.1 fbrun.1 fbsetbg.1 \ - startfluxbox.1 fluxstyle.1 fluxbox-keys.5 fluxbox-remote.1 -EXTRA_DIST=fluxbox.1.in fbsetroot.1 fbrun.1 fluxbox-keys.5 fluxbox-remote.1 startfluxbox.1 fbsetbg.1 \ + startfluxbox.1 fluxstyle.1 fluxbox-keys.5 fluxbox-apps.5 fluxbox-remote.1 +EXTRA_DIST=fluxbox.1.in fbsetroot.1 fbrun.1 fluxbox-keys.5 fluxbox-apps.5 fluxbox-remote.1 startfluxbox.1 fbsetbg.1 \ fluxstyle.1.in CODESTYLE distclean-local: rm -f *\~
M doc/asciidoc/Makefiledoc/asciidoc/Makefile

@@ -3,11 +3,12 @@ # create manpages from the asciidoc files

# SRC1 = fluxbox.txt fluxstyle.txt fluxbox-keys.txt fluxbox-remote.txt -SRC5 = fluxbox-keys.txt +SRC5 = fluxbox-keys.txt fluxbox-apps.txt MAN = $(SRC1:.txt=.1) $(SRC5:.txt=.5) all : $(MAN) + clean: rm -fv $(MAN)

@@ -20,3 +21,7 @@

%.5 : %.xml xmlto man $< +# Dependencies: +# +# fluxbox-apps(5) and fluxbox-keys(5) both include client-patterns.txt +fluxbox-keys.5 fluxbox-apps.5: client-patterns.txt
A doc/asciidoc/client-patterns.txt

@@ -0,0 +1,81 @@

+A 'pattern' looks like this::: + *(*['propertyname'[!]=]'regexp'*)* ... + +Match definitions are enclosed in parentheses *(*...*)*, and if no +'propertyname' is given then *Name* is assumed. The 'regexp' can contain any +regular expression, or the special value *[current]*, which matches the +corresponding value of the currently focused window. See 'regex(7)' for more +information on acceptable regular expressions. + +'propertyname' is not case sensitive, whereas the 'regexp' is. + +If you specify multiple *('pattern'*) arguments, this implies an AND condition - +All specified patterns must match. + +You can use *=* to test for equality or *!=* to test for inequality. + +The following values are accepted for 'propertyname'::: +*Name*;; + A string, corresponding to the CLASSNAME property (The first field of + WM_CLASS from the output of the *xprop(1)* utility). +*Class*;; + A string, corresponding to the CLASSCLASS property (The second field of + WM_CLASS from the output of the *xprop(1)* utility). +*Title*;; + A string, corresponding to the window title (WM_NAME from *xprop(1)*). +*Role*;; + A string, corresponding to the ROLE property (WM_WINDOW_ROLE from + *xprop(1)*). +*Transient*;; + Either *yes* or *no*, depending on whether the window is transient + (typically, a popup dialog) or not. +*Maximized*;; + Either *yes* or *no*, depending on whether the window is maximized or + not. +*Minimized*;; + Either *yes* or *no*, depending on whether the window is minimized + (iconified) or not. +*Shaded*;; + Either *yes* or *no*, depending on whether the window is shaded or + not. +*Stuck*;; + Either *yes* or *no*, depending on whether the window is sticky (on + all workspaces) or not. +*FocusHidden*;; + Either *yes* or *no*, depending on whether the window has asked to be + left off the focus list (or, the alt-tab list), or not. +*IconHidden*;; + Either *yes* or *no*, depending on whether the window has asked to be + left off the icon list (or, the taskbar), or not. +*Urgent*;; + Either *yes* or *no*, depending on whether the window has the urgent + hint set. +*Workspace*;; + A number corresponding to the workspace number to which the window is + attached. The first workspace here is *0*. You may also use *[current]* to + match the currently visible workspace. +*WorkspaceName*;; + A string corresponding to the name of the workspace to which the + window is attached. +*Head*;; + The number of the display head to which the window is attached. You + may match this against the special value *[mouse]* which refers to the + head where the mouse pointer currently resides. +*Layer*;; + The string name of the window's layer, which is one of + *AboveDock*, *Dock*, *Top*, *Normal*, *Bottom*, *Desktop* + +.Matches any windows with the CLASSNAME of "xterm" +.......... +(xterm) +.......... + +.Matches any windows with the same CLASSNAME as the currently focused window +.......... +(Name=[current]) +.......... + +.Matches any windows on the same head as the mouse but on a different layer than the currently focused window +........... +(Head=[mouse]) (Layer!=[current]) +...........
A doc/asciidoc/fluxbox-apps.5

@@ -0,0 +1,748 @@

+.\" Title: fluxbox-apps +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> +.\" Date: 04/24/2009 +.\" Manual: Fluxbox Manual +.\" Source: fluxbox-apps.txt 1.1.2 +.\" Language: English +.\" +.TH "FLUXBOX\-APPS" "5" "04/24/2009" "fluxbox\-apps\&.txt 1\&.1\&.2" "Fluxbox Manual" +.\" ----------------------------------------------------------------- +.\" * (re)Define some macros +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" toupper - uppercase a string (locale-aware) +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de toupper +.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ +\\$* +.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH-xref - format a cross-reference to an SH section +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de SH-xref +.ie n \{\ +.\} +.toupper \\$* +.el \{\ +\\$* +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH - level-one heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SH +.\" put an extra blank line of space above the head in non-TTY output +.if t \{\ +.sp 1 +.\} +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[an-margin]u +.ti 0 +.HTML-TAG ".NH \\n[an-level]" +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +\." make the size of the head bigger +.ps +3 +.ft B +.ne (2v + 1u) +.ie n \{\ +.\" if n (TTY output), use uppercase +.toupper \\$* +.\} +.el \{\ +.nr an-break-flag 0 +.\" if not n (not TTY), use normal case (not uppercase) +\\$1 +.in \\n[an-margin]u +.ti 0 +.\" if not n (not TTY), put a border/line under subheading +.sp -.6 +\l'\n(.lu' +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SS - level-two heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SS +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[IN]u +.ti \\n[SN]u +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.ps \\n[PS-SS]u +\." make the size of the head bigger +.ps +2 +.ft B +.ne (2v + 1u) +.if \\n[.$] \&\\$* +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BB/BE - put background/screen (filled box) around block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BB +.if t \{\ +.sp -.5 +.br +.in +2n +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EB +.if t \{\ +.if "\\$2"adjust-for-leading-newline" \{\ +.sp -1 +.\} +.br +.di +.in +.ll +.gcolor +.nr BW \\n(.lu-\\n(.i +.nr BH \\n(dn+.5v +.ne \\n(BHu+.5v +.ie "\\$2"adjust-for-leading-newline" \{\ +\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.el \{\ +\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.in 0 +.sp -.5v +.nf +.BX +.in +.sp .5v +.fi +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BM/EM - put colored marker in margin next to block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BM +.if t \{\ +.br +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EM +.if t \{\ +.br +.di +.ll +.gcolor +.nr BH \\n(dn +.ne \\n(BHu +\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] +.in 0 +.nf +.BX +.in +.fi +.\} +.. +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "Name" +fluxbox-apps \- per\-window attribute configuration for fluxbox(1) +.SH "Synopsis" +.sp +~/\&.fluxbox/apps +.SH "SYNTAX" +.sp +Variable parameters are shown in emphasis: \fIargument\fR +.sp +All other characters shown are required verbatim\&. Whitespce is only required to delimit words, but it is fine to add more whitespace\&. +.SH "DESCRIPTION" +.sp +It is possible to force an application to always have the same dimensions, position, and other settings when it is first launched\&. These settings are saved in the `apps\' file\&. +.sp +Most simple settings can be saved using the \(lqRemember\&...\(rq submenu of the window menu, which can usually be opened with a right\-click on the titlebar\&. More advanced features require manually editing the `apps\' file\&. This may include using \fBGROUP SECTIONS\fR to set up automatic window tab groups\&. +.sp +You do not need to \(lqreload\(rq fluxbox after editing the apps file, the changes should be rescanned when the next window is opened\&. +.sp +The file is made up of two main types of sections, apps and groups, detailed below\&. +.SH "APP SECTIONS" +.sp +\fB[app]\fR sections provide settings for individual application windows\&. +.PP +These sections begin with a line of the format: +.RS 4 + +\fB[app]\fR +\fB(\fR\fIpattern\fR\fB)\fR +\fB{\fR\fIcount\fR\fB}\fR +.RE +.sp +The \fIpattern\fR can be one or more patterns which match windows\&. For more details, see \fBCLIENT PATTERNS\fR\&. If you specify more than one \fIpattern\fR, they must ALL match for the settings to be applied\&. +.sp +The \fB{\fR\fIcount\fR\fB}\fR is optional\&. If specified, then the entry will only match at most that many windows at any time\&. If omitted, the default is to apply the settings to all matching windows\&. +.sp +This opening \fB[apps]\fR line is followed by any number of settings for the application\&. See \fBSETTINGS\fR for more details\&. +.PP +Each of these sections ends with the single line: +.RS 4 + +\fB[end]\fR +.RE +.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\&. +.PP +These sections begin with a line of the format: +.RS 4 + +\fB[group]\fR +\fB(\fR\fIpattern\fR\fB)\fR +.RE +.sp +Where the \fIpattern\fR item is optional\&. If specified, this pattern must match for the group to take effect\&. It is common to use non\-window\-specific patterns such as \fB(workspace)\fR here\&. See \fBCLIENT PATTERNS\fR for more details\&. +.sp +This is followed by any number of \fB[app]\fR lines\&. These have a simiar format to the \fB[app]\fR section detailed above in \fBAPP SECTIONS\fR, but do not contain any settings and do not have an associated \fB[end]\fR line\&. +.PP +Like this: +.RS 4 + +\fB[app]\fR +\fB(\fR\fIpattern\fR\fB)\fR +.RE +.sp +This section may also contain settings that are applied to every window in the group\&. See the \fBSETTINGS\fR section for details\&. +.PP +As with \fB[app]\fR sections, each of these sections ends with the single line: +.RS 4 + +\fB[end]\fR +.RE +.SH "SETTINGS" +.sp +These settings may be stored in the `apps\' file\&. A settings line must appear inside either an \fB[app]\fR or \fB[group]\fR section\&. +.PP +The general format is: +.RS 4 + +\fB[\fR\fIsetting\fR\fB]\fR +\fB{\fR\fIvalue\fR\fB}\fR +.RE +.sp +All allowed values are described below, except for \fIbool\fR which can simply have the value \fByes\fR or \fBno\fR, which enables or disables the associated setting, respectively\&. +.PP +\fB[Workspace]\fR {\fInumber\fR} +.RS 4 +Forces the application to open on the +\fInumber\fR +workspace specified\&. Workspaces are set by number, beginning with 0\&. +.RE +.PP +\fB[Jump]\fR {\fIbool\fR} +.RS 4 +Changes the active workspace to the remembered one when the application is opened\&. This is only useful when used in conjunction with +\fI[Workspace]\fR\&. See +\fBEXAMPLES\fR\&. +.RE +.PP +\fB[Head]\fR {\fInumber\fR} +.RS 4 +Forces the application to open on the +\fInumber\fR +head specified (Xinerama only)\&. +.RE +.PP +\fB[Layer]\fR {\fInumber\fR} +.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} +.RS 4 +Opens the application with the specified +\fIwidth\fR +and +\fIheight\fR, in pixels\&. +.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 +\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\&. +.PP +\fIanchor\fR may be set to one of: +.RS 4 + +\fBTopLeft Left BottomLeft Top Center Bottom TopRight Right BottomRight\fR +.RE +.RE +.PP +\fB[Deco]\fR {\fIvalue\fR} +.RS 4 +.PP +Specify the decoration state\&. There are several predefined \fIvalue\fR sets: +.RS 4 +.PP +\fBNORMAL\fR +.RS 4 +Standard decorations +.RE +.PP +\fBNONE\fR +.RS 4 +No decorations +\fBTAB\fR +Like TAB except keep the tabs +.RE +.PP +\fBBorder\fR +.RS 4 +Like NONE except keep the X window border +.RE +.PP +\fBTINY\fR +.RS 4 +Titlebar with only an iconify button +.RE +.PP +\fBTOOL\fR +.RS 4 +Titlebar only +.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\&. +.RE +.RE +.PP +\fB[Shaded]\fR {\fIbool\fR} +.RS 4 +Whether the window is Shaded (rolled\-up) or not\&. +.RE +.PP +\fB[Tab]\fR {\fIbool\fR} +.RS 4 +Whether the window has tabs enabled\&. +.RE +.PP +\fB[FocusHidden]\fR {\fIbool\fR} +.RS 4 +If enabled, the window will not appear in +\fINextWindow\fR/\fIPrevWindow\fR +lists\&. +.RE +.PP +\fB[IconHidden]\fR {\fIbool\fR} +.RS 4 +If enabled, the window will not appear in the icon area of the toolbar\&. +.RE +.PP +\fB[Hidden]\fR {\fIbool\fR} +.RS 4 +A shortcut for setting both +\fBFocusHidden\fR +and +\fBIconHidden\fR +at the same time\&. +.RE +.PP +\fB[Sticky]\fR {\fIbool\fR} +.RS 4 +Specify if an application should be sticky (shown on all workspaces) or not\&. +.RE +.PP +\fB[Minimized]\fR {\fIbool\fR} +.RS 4 +Application should start minimized +.RE +.PP +\fB[Maximized]\fR {\fIvalue\fR} +.RS 4 +.PP +Application should start maximized\&. \fIvalue\fR may be: +.RS 4 +.PP +\fByes\fR +.RS 4 +Fully maximized +.RE +.PP +\fBhorz\fR +.RS 4 +Horizontally maximized +.RE +.PP +\fBvert\fR +.RS 4 +Vertically maximized +.RE +.PP +\fBno\fR +.RS 4 +Not maximized +.RE +.RE +.RE +.PP +\fB[Fullscreen]\fR {\fIbool\fR} +.RS 4 +Application should start in fullscreen mode (fully maximized without any decorations)\&. +.RE +.PP +\fB[Close]\fR {\fIbool\fR} +.RS 4 +Save settings on close\&. By default, application settings are not updated when a window is closed\&. +.RE +.PP +\fB[Alpha]\fR {\fIvalue\fR [\fIvalue\fR]} +.RS 4 +Set the alpha value for this window\&. If two values are given, they correspond to the focused and unfocused transparency, respectively\&. One number only will be used for both values\&. +\fIvalue\fR +is an integer between 0 and 255\&. +.RE +.SH "CLIENT PATTERNS" +.PP +A \fIpattern\fR looks like this: +.RS 4 + +\fB(\fR[\fIpropertyname\fR[!]=]\fIregexp\fR\fB)\fR +\&... +.RE +.sp +Match definitions are enclosed in parentheses \fB(\fR\&...\fB)\fR, and if no \fIpropertyname\fR is given then \fBName\fR is assumed\&. The \fIregexp\fR can contain any regular expression, or the special value \fB[current]\fR, which matches the corresponding value of the currently focused window\&. See \fIregex(7)\fR for more information on acceptable regular expressions\&. +.sp +\fIpropertyname\fR is not case sensitive, whereas the \fIregexp\fR is\&. +.sp +If you specify multiple \fB(\fR\fB\fIpattern\fR\fR) arguments, this implies an AND condition \- All specified patterns must match\&. +.sp +You can use \fB=\fR to test for equality or \fB!=\fR to test for inequality\&. +.PP +The following values are accepted for \fIpropertyname\fR: +.RS 4 +.PP +\fBName\fR +.RS 4 +A string, corresponding to the CLASSNAME property (The first field of WM_CLASS from the output of the +\fBxprop(1)\fR +utility)\&. +.RE +.PP +\fBClass\fR +.RS 4 +A string, corresponding to the CLASSCLASS property (The second field of WM_CLASS from the output of the +\fBxprop(1)\fR +utility)\&. +.RE +.PP +\fBTitle\fR +.RS 4 +A string, corresponding to the window title (WM_NAME from +\fBxprop(1)\fR)\&. +.RE +.PP +\fBRole\fR +.RS 4 +A string, corresponding to the ROLE property (WM_WINDOW_ROLE from +\fBxprop(1)\fR)\&. +.RE +.PP +\fBTransient\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is transient (typically, a popup dialog) or not\&. +.RE +.PP +\fBMaximized\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is maximized 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 +\fBShaded\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is shaded or not\&. +.RE +.PP +\fBStuck\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is sticky (on all workspaces) or not\&. +.RE +.PP +\fBFocusHidden\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window has asked to be left off the focus list (or, the alt\-tab list), or not\&. +.RE +.PP +\fBIconHidden\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window has asked to be left off the icon list (or, the taskbar), or not\&. +.RE +.PP +\fBUrgent\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window has the urgent hint set\&. +.RE +.PP +\fBWorkspace\fR +.RS 4 +A number corresponding to the workspace number to which the window is attached\&. The first workspace here is +\fB0\fR\&. You may also use +\fB[current]\fR +to match the currently visible workspace\&. +.RE +.PP +\fBWorkspaceName\fR +.RS 4 +A string corresponding to the name of the workspace to which the window is attached\&. +.RE +.PP +\fBHead\fR +.RS 4 +The number of the display head to which the window is attached\&. You may match this against the special value +\fB[mouse]\fR +which refers to the head where the mouse pointer currently resides\&. +.RE +.PP +\fBLayer\fR +.RS 4 +The string name of the window\'s layer, which is one of +\fBAboveDock\fR, +\fBDock\fR, +\fBTop\fR, +\fBNormal\fR, +\fBBottom\fR, +\fBDesktop\fR +.RE +.RE +.PP +\fBExample\ \&1.\ \&Matches any windows with the CLASSNAME of "xterm"\fR +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +(xterm) +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&2.\ \&Matches any windows with the same CLASSNAME as the currently focused window\fR +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +(Name=[current]) +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&3.\ \&Matches any windows on the same head as the mouse but on a different layer than the currently focused window\fR +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +(Head=[mouse]) (Layer!=[current]) +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.SH "FILES" +.PP +\fB~/\&.fluxbox/apps\fR +.RS 4 +This is the default location for the application settings\&. +.RE +.SH "RESOURCES" +.PP +\fBsession\&.appsFile:\fR \fIlocation\fR +.RS 4 +This may be set to override the location of the application settings\&. +.RE +.SH "EXAMPLES" +.sp +Here are some interesting and/or useful examples you can do with your apps file\&. +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +# Put the first two windows which end with \'term\' on workspace 1 +[app] (name=\&.*[tT]erm) {2} + [Workspace] {1} +[end] + +# Center kate with a specific size, and update these values when the window is +# closed\&. +[app] (name=kate) + [Dimensions] {1022 747} + [Position] (CENTER) {0 0} + [Close] {yes} +[end] + +# When starting konqueror, jump to workspace 1 first and start it there\&. +[app] (name=konqueror) + [Workspace] {1} + [Jump] {yes} +[end] + +# start all aterm without decorations +[app] (name=aterm) + [Deco] {NONE} +[end] + +# a group with the gimp dock and toolbox +# appears on layer 4 (bottom) +[group] + [app] (name=gimp) (role=gimp\-dock) + [app] (name=gimp) (role=gimp\-toolbox) + [Layer] {4} +[end] +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.SH "AUTHORS" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Jim Ramsay <i\&.am at jimramsay com> (>fluxbox\-1\&.0\&.0) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Curt Micol <asenchi at asenchi com> (>fluxbox\-0\&.9\&.11) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Tobias Klausmann <klausman at users sourceforge net> (\(lafluxbox\-0\&.9\&.11) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Grubert <grubert at users sourceforge net> (fluxbox) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Matthew Hawkins <matt at mh dropbear id au> (blackbox) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Wilbert Berendsen <wbsoft at xs4all nl> (blackbox) +.RE +.SH "SEE ALSO" +.sp +fluxbox(1) xprop(1) regex(7)
A doc/asciidoc/fluxbox-apps.txt

@@ -0,0 +1,269 @@

+fluxbox-apps(5) +=============== +Jim Ramsay <i.am@jimramsay.com> +v1.1.1, 10 February 2009 +:man source: fluxbox-apps.txt +:man version: {revision} +:man manual: Fluxbox Manual + +NAME +---- +fluxbox-apps - per-window attribute configuration for fluxbox(1) + +SYNOPSIS +-------- +~/.fluxbox/apps + +SYNTAX +------ +Variable parameters are shown in emphasis: 'argument' + +All other characters shown are required verbatim. Whitespce is only required to +delimit words, but it is fine to add more whitespace. + +DESCRIPTION +----------- +It is possible to force an application to always have the same dimensions, +position, and other settings when it is first launched. These settings are saved +in the `apps' file. + +Most simple settings can be saved using the `Remember' submenu of the window +menu, which can usually be opened with a right-click on the titlebar. More +advanced features require manually editing the `apps' file. This may include +using *GROUP SECTIONS* to set up automatic window tab groups. + +The file is made up of two main types of sections, apps and groups, detailed +below. + +APP SECTIONS +------------ +*[app]* sections provide settings for individual application windows. + +These sections begin with a line of the format::: + *[app]* *(*'pattern'*)* *{*'count'*}* + +The 'pattern' can be one or more patterns which match windows. For more +details, see *CLIENT PATTERNS*. If you specify more than one 'pattern', they +must ALL match for the settings to be applied. + +The *{*'count'*}* is optional. If specified, then the entry will only match at +most that many windows at any time. If omitted, the default is to apply the +settings to all matching windows. + +This opening *[apps]* line is followed by any number of settings for the +application. See *SETTINGS* for more details. + +Each of these sections ends with the single line::: + *[end]* + +GROUP SECTIONS +-------------- +The primary purpose of *[group]* sections is to group windows together. All +windows in a group will be tabbed together automatically. + +These sections begin with a line of the format::: + *[group]* *(*'pattern'*)* + +Where the 'pattern' item is optional. If specified, this pattern must match for +the group to take effect. It is common to use non-window-specific patterns such +as *(workspace)* here. See *CLIENT PATTERNS* for more details. + +This is followed by any number of *[app]* lines. These have a simiar format to +the *[app]* section detailed above in *APP SECTIONS*, but do not contain any +settings and do not have an associated *[end]* line. + +Like this::: + *[app]* *(*'pattern'*)* + +This section may also contain settings that are applied to every window in the +group. See the *SETTINGS* section for details. + +As with *[app]* sections, each of these sections ends with the single line::: + *[end]* + +SETTINGS +-------- +These settings may be stored in the `apps' file. A settings line must appear +inside either an *[app]* or *[group]* section. + +The general format is::: + *[*'setting'*]* *{*'value'*}* + +All allowed values are described below, except for 'bool' which can simply have +the value *yes* or *no*, which enables or disables the associated setting, +respectively. + +*[Workspace]* {'number'}:: + Forces the application to open on the 'number' workspace specified. + Workspaces are set by number, beginning with 0. + +*[Jump]* {'bool'}:: + Changes the active workspace to the remembered one when the application is + opened. This is only useful when used in conjunction with '[Workspace]'. See + *EXAMPLES*. + +*[Head]* {'number'}:: + Forces the application to open on the 'number' head specified (Xinerama + only). + +*[Layer]* {'number'}:: + 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. + +*[Dimensions]* {'width' 'height'}:: + Opens the application with the specified 'width' and 'height', in pixels. + +*[Position]* ('anchor') {'X' 'Y'}:: +Position the application at a particular spot. By default the upper-left corner +is placed at screen coordinates ('X','Y'). If you specify an 'anchor', say +BottomRight, then the lower-right corner of the window is positioned ('X','Y') +pixels from the lower-right corner of the screen. ++ +'anchor' may be set to one of:;; +*TopLeft Left BottomLeft Top Center Bottom TopRight Right BottomRight* + +*[Deco]* {'value'}:: +Specify the decoration state. There are several predefined 'value' sets:;; ++ +-- + *NORMAL*;; + Standard decorations + *NONE*;; + No decorations + *TAB* + Like TAB except keep the tabs + *Border*;; + Like NONE except keep the X window border + *TINY*;; + Titlebar with only an iconify button + *TOOL*;; + Titlebar only + +-- ++ +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. + +*[Shaded]* {'bool'}:: + Whether the window is Shaded (rolled-up) or not. + +*[Tab]* {'bool'}:: + Whether the window has tabs enabled. + +*[FocusHidden]* {'bool'}:: + If enabled, the window will not appear in 'NextWindow'/'PrevWindow' lists. + +*[IconHidden]* {'bool'}:: + If enabled, the window will not appear in the icon area of the toolbar. + +*[Hidden]* {'bool'}:: + A shortcut for setting both *FocusHidden* and *IconHidden* at the same time. + +*[Sticky]* {'bool'}:: + Specify if an application should be sticky (shown on all workspaces) or not. + +*[Minimized]* {'bool'}:: + Application should start minimized + +*[Maximized]* {'value'}:: +Application should start maximized. 'value' may be:;; ++ +-- + *yes*;; + Fully maximized + *horz*;; + Horizontally maximized + *vert*;; + Vertically maximized + *no*;; + Not maximized + +-- + +*[Fullscreen]* {'bool'}:: + Application should start in fullscreen mode (fully maximized without any + decorations). + +*[Close]* {'bool'}:: + Save settings on close. By default, application settings are not updated when + a window is closed. + +*[Alpha]* {'value' ['value']}:: + Set the alpha value for this window. If two values are given, they + correspond to the focused and unfocused transparency, respectively. One + number only will be used for both values. 'value' is an integer between 0 + and 255. + +CLIENT PATTERNS +--------------- +include::client-patterns.txt[] + +FILES +----- +*~/.fluxbox/apps*:: + This is the default location for the application settings. + +RESOURCES +--------- +*session.appsFile:* 'location':: + This may be set to override the location of the application settings. + +EXAMPLES +-------- +Here are some interesting and/or useful examples you can do with your apps +file. + +.................. +# Put the first two windows which end with 'term' on workspace 1 +[app] (name=.*[tT]erm) {2} + [Workspace] {1} +[end] + +# Center kate with a specific size, and update these values when the window is +# closed. +[app] (name=kate) + [Dimensions] {1022 747} + [Position] (CENTER) {0 0} + [Close] {yes} +[end] + +# When starting konqueror, jump to workspace 1 first and start it there. +[app] (name=konqueror) + [Workspace] {1} + [Jump] {yes} +[end] + +# start all aterm without decorations +[app] (name=aterm) + [Deco] {NONE} +[end] + +# a group with the gimp dock and toolbox +# appears on layer 4 (bottom) +[group] + [app] (name=gimp) (role=gimp-dock) + [app] (name=gimp) (role=gimp-toolbox) + [Layer] {4} +[end] +.................. + +AUTHOR and CREDITS +------------------ +This manpage is the combined work of: + +- Jim Ramsay <i.am at jimramsay com> (>fluxbox-1.0.0) +- Curt Micol <asenchi at asenchi com> (>fluxbox-0.9.11) +- Tobias Klausmann <klausman at users sourceforge net> (<=fluxbox-0.9.11) +- Grubert <grubert at users sourceforge net> (fluxbox) +- Matthew Hawkins <matt at mh dropbear id au> (blackbox) +- Wilbert Berendsen <wbsoft at xs4all nl> (blackbox) + +- Numerous other languages could be available if someone jumps in. + +SEE ALSO +-------- +fluxbox(1), xev(1), xkill(1), regex(7) +
A doc/asciidoc/fluxbox-keys.5

@@ -0,0 +1,1406 @@

+.\" Title: fluxbox-keys +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> +.\" Date: 04/24/2009 +.\" Manual: Fluxbox Manual +.\" Source: fluxbox-keys.txt 1.1.2 +.\" Language: English +.\" +.TH "FLUXBOX\-KEYS" "5" "04/24/2009" "fluxbox\-keys\&.txt 1\&.1\&.2" "Fluxbox Manual" +.\" ----------------------------------------------------------------- +.\" * (re)Define some macros +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" toupper - uppercase a string (locale-aware) +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de toupper +.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ +\\$* +.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH-xref - format a cross-reference to an SH section +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de SH-xref +.ie n \{\ +.\} +.toupper \\$* +.el \{\ +\\$* +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH - level-one heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SH +.\" put an extra blank line of space above the head in non-TTY output +.if t \{\ +.sp 1 +.\} +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[an-margin]u +.ti 0 +.HTML-TAG ".NH \\n[an-level]" +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +\." make the size of the head bigger +.ps +3 +.ft B +.ne (2v + 1u) +.ie n \{\ +.\" if n (TTY output), use uppercase +.toupper \\$* +.\} +.el \{\ +.nr an-break-flag 0 +.\" if not n (not TTY), use normal case (not uppercase) +\\$1 +.in \\n[an-margin]u +.ti 0 +.\" if not n (not TTY), put a border/line under subheading +.sp -.6 +\l'\n(.lu' +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SS - level-two heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SS +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[IN]u +.ti \\n[SN]u +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.ps \\n[PS-SS]u +\." make the size of the head bigger +.ps +2 +.ft B +.ne (2v + 1u) +.if \\n[.$] \&\\$* +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BB/BE - put background/screen (filled box) around block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BB +.if t \{\ +.sp -.5 +.br +.in +2n +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EB +.if t \{\ +.if "\\$2"adjust-for-leading-newline" \{\ +.sp -1 +.\} +.br +.di +.in +.ll +.gcolor +.nr BW \\n(.lu-\\n(.i +.nr BH \\n(dn+.5v +.ne \\n(BHu+.5v +.ie "\\$2"adjust-for-leading-newline" \{\ +\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.el \{\ +\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.in 0 +.sp -.5v +.nf +.BX +.in +.sp .5v +.fi +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BM/EM - put colored marker in margin next to block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BM +.if t \{\ +.br +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EM +.if t \{\ +.br +.di +.ll +.gcolor +.nr BH \\n(dn +.ne \\n(BHu +\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] +.in 0 +.nf +.BX +.in +.fi +.\} +.. +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "Name" +fluxbox-keys \- keyboard shortcuts configuration for fluxbox(1) +.SH "Synopsis" +.sp +~/\&.fluxbox/keys +.SH "SYNTAX" +.sp +Variable parameters are shown in emphasis: \fIargument\fR +.sp +Optional parameters are shown in square brackets: [\fIargument\fR] +.sp +All other characters shown are required verbatim\&. Whitespace is required where shown, but it is fine to add more whitespace\&. +.SH "DESCRIPTION" +.sp +The keys file defines the keyboard shortcuts for \fIfluxbox(1)\fR\&. +.sp +You can customize fluxbox\'s key handling through the ~/\&.fluxbox/keys file\&. The file consists of lines of the basic format: +.sp +\fB[\fR\fB\fImodifiers\fR\fR\fB] \fR\fB\fIkey\fR\fR\fB :\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIarguments\fR\fR\fB \fR\fB\fI\&...\fR\fR\fB]\fR +.sp +The space between the \fIkey\fR and the \fB:\fR before the \fIcommand\fR is mandatory\&. +.sp +All modifiers and commands are case\-insensitive\&. Some command arguments (especially those that will be passed to the shell) are case\-sensitive\&. Some key names are case\-sensitive\&. +.sp +Lines beginning with a \fI#\fR or \fI!\fR are considered comments and are unread by fluxbox\&. +.sp +You will need to \(lqreload\(rq fluxbox after editing the keys file so it picks up your change\&. +.SH "MODIFIERS" +.sp +You can get a list of possible modifiers by calling `xmodmap \-pm\'\&. This also shows you to which keys the modifiers are mapped, but the following modifiers are most commonly used: +.sp +\fBShift Control Mod1 Mod4\fR +.sp +where \fBMod1\fR is the Alt key on the PC keyboard and \fBMod4\fR is usually a key branded with a familiar company logo\&. +.PP +There are also some special modifiers that refer to mouse button presses: +.RS 4 +.PP +\fBOnDesktop\fR +.RS 4 +The mouse cursor is over the desktop (root window), and not any window\&. +.RE +.PP +\fBOnToolbar\fR +.RS 4 +The mouse cursor is over the toolbar (which is normally at the bottom of the screen)\&. +.RE +.PP +\fBOnWindow\fR +.RS 4 +The mouse cursor is over a window\&. +.RE +.PP +\fBOnTitlebar\fR +.RS 4 +The mouse cursor is over a window\'s titlebar\&. +.RE +.PP +\fBDouble\fR +.RS 4 +Limits this action to double\-clicks only\&. +.RE +.RE +.SS "Combining Modifiers" +.sp +To combine two or more modifiers, just list them (space\-delimited) in any order\&. +.SH "KEYS" +.sp +You may specify a key by its key name (for example, \fBa\fR or \fBspace\fR) or by its numeric keycode (for example, \fB38\fR or \fB0xf3\fR)\&. +.sp +If you don\'t know the name of a key, you can run \fBxev(1)\fR in a terminal, push the key, and see the name in the output\&. If you have some "special" keys that do not produce a key name in the output of \fBxev(1)\fR, you can just use the keycode (NOT the keysym!) in your keys file\&. +.sp +Commands can also be bound to mouse button presses, for which the proper "key" name is \fBMouse\fR\fIn\fR where \fIn\fR is the number of the mouse button\&. For example, \fBMouse1\fR is the primary button, and \fBMouse4\fR / \fBMouse5\fR are the scroll wheel events, in normal configurations\&. \fBxev(1)\fR can also be used to tell the button number\&. +.PP +There are some special "keys" that let you bind events to non\-keyboard events: +.RS 4 +.PP +\fBChangeWorkspace\fR +.RS 4 +Fires when the workspace changes\&. This can be used to change backgrounds or do anything else you like when you switch to a new workspace\&. See the +\fBEXAMPLES\fR +below for one idea\&. +.RE +.RE +.SH "CHAINING" +.sp +Key bindings can be chained in a fashion similar to Emacs key bindings using the syntax: +.sp +\fImodifiers\-1\fR \fIkey\-1\fR \fImodifiers\-2\fR \fIkey\-2\fR :\fIcommand\fR [\fIarguments \&...\fR]* +.sp +To abort a chained command part\-way through typing it, press the <ESC> key\&. +.PP +\fBExample\ \&1.\ \&To Bind CTRL+C CTRL+X (Which means, press CTRL+C then CTRL+X) to quit fluxbox\fR +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +Control c Control x :Quit +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.SH "KEYMODES" +.sp +A specific set of key mappings can be activated and de\-activated on\-the\-fly using what are called keymodes\&. The syntax to define a mapping in a keymode is: +.sp +\fB\fIkeymode\fR\fR\fB: \fR\fB\fImodifiers\fR\fR\fB \fR\fB\fIkey\fR\fR\fB :\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIarguments\fR\fR\fB \fR\fB\fI\&...\fR\fR\fB]\fR +.sp +Where \fIkeymode\fR is any alpha\-numeric string name\&. +.sp +When this keymode is activated (see the \fBKeyMode\fR command below), all bindings prefaced by that keymode name become active (and all other keybindings will be deactivated) until the keymode changes again\&. +.SH "COMMANDS" +.PP +Some commands have multiple names which are shown below as: +.RS 4 +CMD1 | CMD2 +.RE +.PP +Related commands have been grouped below as: +.RS 4 +CMD1 / CMD2 +.RE +.PP +The commands are broken up into sections as follows: +.RS 4 +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Mouse Commands +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Window Commands +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Workspace Commands +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Menu Commands +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Window Manager Commands +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Special Commands +.RE +.RE +.SS "Mouse Commands" +.sp +These commands may only be bound to mouse buttons (plus modifiers), not keystrokes\&. In all cases, the action finishes when the mouse button is released\&. +.PP +\fBStartMoving\fR +.RS 4 +Start dragging to move the window\&. +.RE +.PP +\fBStartResizing\fR [\fIcorner\fR] +.RS 4 +Start dragging to resize the window as if you had grabbed the window at the specified +\fIcorner\fR\&. +.PP +By default \fIcorner\fR is \fBBottomRight\fR, but may be overridden with one of: +.RS 4 + +\fBNearestCorner NearestEdge Center TopLeft Top TopRight Left Right BottomLeft BottomRight\fR +.RE +.RE +.PP +\fBStartTabbing\fR +.RS 4 +Start dragging to add this window to another\'s tabgroup\&. +.RE +.SS "Window Commands" +.sp +These commands ordinarily affect only the currently focused window\&. The \fBOnWindow\fR modifier and \fBForEach\fR command may affect the window that is used\&. +.PP +\fBMinimize\fR | \fBMinimizeWindow\fR | \fBIconify\fR +.RS 4 +Minimize the current window, equivalent to the window button\&. +.RE +.PP +\fBMaximize\fR | \fBMaximizeWindow\fR +.RS 4 +Maximize the current window, equivalent to the window button\&. +.RE +.PP +\fBMaximizeHorizontal\fR / \fBMaximizeVertical\fR +.RS 4 +Maximize the current window in one direction only, leaving the other dimension unchanged\&. +.RE +.PP +\fBRaise\fR / \fBLower\fR +.RS 4 +Reorder this window to the top or bottom of the window stack, within its current layer\&. See +\fIfluxbox(1)\fR +for a discussion of layers\&. +.RE +.PP +\fBRaiseLayer\fR / \fBLowerLayer\fR +.RS 4 +Raise the window up to the layer above, or lower it to the layer below\&. See +\fIfluxbox(1)\fR +for a discussion of layers\&. +.RE +.PP +\fBSetLayer\fR \fIlayer\fR +.RS 4 +Move the window to the specified layer\&. +\fIlayer\fR +should be one of +\fBAboveDock\fR, +\fBDock\fR, +\fBTop\fR, +\fBNormal\fR, +\fBBottom\fR, +\fBDesktop\fR\&. See +\fIfluxbox(1)\fR +for a discussion of layers\&. +.RE +.PP +\fBClose\fR +.RS 4 +Close the current window, equivalent to the window button\&. +.RE +.PP +\fBKill\fR | \fBKillWindow\fR +.RS 4 +Close a window that\'s not responding to +\fBClose\fR, like using +\fBxkill(1)\fR\&. +.RE +.PP +\fBShade\fR | \fBShadeWindow\fR +.RS 4 +Toggle the +\fBshaded\fR +state of the current window, equivalent to the window button\&. A +\fBshaded\fR +window appears as only the title bar\&. +.RE +.PP +\fBShadeOn\fR / \fBShadeOff\fR +.RS 4 +Set the +\fBshaded\fR +state of the window to On / Off\&. +.RE +.PP +\fBStick\fR | \fBStickWindow\fR +.RS 4 +Toggle the +\fBsticky\fR +state of the current window, equivalent to the window button\&. A +\fBsticky\fR +window is visible on all workspaces\&. +.RE +.PP +\fBSetDecor\fR \fIdecor\fR +.RS 4 +Sets which window decorations will be shown\&. +\fIdecor\fR +has the same format as the `\fI parameter in the apps file\&. See `man fluxbox\fR +section APPLICATIONS for more info\&. +.RE +.PP +\fBToggleDecor\fR +.RS 4 +Toggles the presence of the window decorations (title bar, window buttons, and resize bar)\&. +.RE +.PP +\fBNextTab\fR / \fBPrevTab\fR +.RS 4 +Cycle to the next / previous tab in the current tab group\&. +.RE +.PP +\fBTab\fR \fInumber\fR +.RS 4 +Cycle to the given tab in the current tab group, where +\fB1\fR +is the first tab\&. A negative +\fInumber\fR +counts from the end of the tab group (\fB\-1\fR +is the last tab, +\fB\-2\fR +is the next\-to\-last, etc\&.)\&. +.RE +.PP +\fBMoveTabRight\fR / \fBMoveTabLeft\fR +.RS 4 +Reorder the tabs in the current tab group, swapping the current tab with the one to the right / left\&. +.RE +.PP +\fBDetachClient\fR +.RS 4 +Remove the current tab from the tab group, placing it in its own window\&. +.RE +.PP +\fBResizeTo\fR \fIwidth\fR \fIheight\fR +.RS 4 +Resizes the window to the given width and height\&. +.RE +.PP +\fBResize\fR \fIdelta\-width\fR \fIdelta\-height\fR +.RS 4 +Resizes the window relative to the current width and height\&. +.RE +.PP +\fBResizeHorizontal\fR \fIdelta\-width\fR / \fBResizeVertical\fR \fIdelta\-height\fR +.RS 4 +Resizes the window in one dimension only +.RE +.PP +\fBMoveTo\fR \fIx\fR \fIy\fR [\fIanchor\fR] +.RS 4 +Moves the window to the given coordinates, given in pixels\&. +.sp +If either +\fIx\fR +or +\fIy\fR +is set to +\fB*\fR, that coordinate will be ignored, and the movement will only take place in one dimension\&. +.PP +The default \fIanchor\fR is the upper left corner, but this may be overridden with one of: +.RS 4 + +\fBTopLeft Left BottomLeft Top Center Bottom TopRight Right BottomRight\fR +.RE +.RE +.PP +\fBMove\fR \fIdelta\-x\fR \fIdelta\-y\fR +.RS 4 +Moves the window relative to its current position\&. Positive numbers refer to right and down, and negative to left and up, respectively\&. +.RE +.PP +\fBMoveRight\fR \fId\fR / \fBMoveLeft\fR \fId\fR / \fBMoveUp\fR \fId\fR / \fBMoveDown\fR \fId\fR +.RS 4 +Moves the window relative to its current position by the number of pixels specified in +\fId\fR\&. If the number is negative, it moves in the opposite direction\&. +.RE +.PP +\fBTakeToWorkspace\fR \fIworkspace\fR +.RS 4 +Sends you along with the current window to the selected workspace\&. The first workspace is number +\fB1\fR, not 0\&. +.RE +.PP +\fBSendToWorkspace\fR \fIworkspace\fR +.RS 4 +SendToWorkspace just sends the window to the specified workspace\&. As in TakeToWorkspace, the first workspace is number +\fB1\fR, but in addition you may use the number +\fB0\fR +to mean "The currently active workspace"\&. +.RE +.PP +\fBTakeToNextWorkspace\fR [\fIoffset\fR] / \fBTakeToPrevWorkspace\fR [\fIoffset\fR] +.RS 4 +Sends you along with the current window to the next or previous workspace\&. If you set +\fIoffset\fR +to a value greater than the default of +\fB1\fR, it will move you that number of workspaces ahead or behind\&. If you go beyond the end of the currently defined workspaces, it will wrap around to the other end automatically\&. +.RE +.PP +\fBSendToNextWorkspace\fR [\fIoffset\fR] / \fBSendToPrevWorkspace\fR [\fIoffset\fR] +.RS 4 +Identical to the "TakeTo\&..." commands, but again this sends only the window, and does not move you away from your current workspace\&. +.RE +.PP +\fBSetAlpha\fR [\fIalpha\fR [\fIunfocused\-alpha\fR]] +.RS 4 +Sets the alpha value of a window\&. +.sp +Putting a +\fB+\fR +or +\fB\-\fR +in front of the value adds or subtracts from the current value\&. A plain integer sets the value explicitly\&. +.PP +no arguments +.RS 4 +Resets both focused and unfocused settings to default opacity\&. +.RE +.PP +one argument +.RS 4 +Changes both focused and unfocused alpha settings\&. +.RE +.PP +two arguments +.RS 4 +First value becomes the focused alpha, second becomes the unfocused alpha value\&. +.RE +.RE +.PP +\fBSetHead\fR \fInumber\fR +.RS 4 +Moves the window to the given display head\&. Only available when fluxbox has been compiled with Xinerama support\&. +.RE +.PP +\fBSendToNextHead\fR [\fIoffset\fR] / \fBSendToPrevHead\fR [\fIoffset\fR] +.RS 4 +Sends the current window to the next/previous display head\&. If you specify an +\fIoffset\fR +greater than +\fB1\fR, it will move the window that many heads\&. If this takes the window beyond the total number of heads, it will wrap around to the beginning\&. +.RE +.SS "Workspace Commands" +.sp +These commands affect the entire workspace (or "desktop" as it is sometimes called)\&. +.PP +\fBAddWorkspace\fR / \fBRemoveLastWorkspace\fR +.RS 4 +Adds or removes a workspace from the end of the list of workspaces\&. +.RE +.PP +\fBNextWorkspace\fR [\fIn\fR] / \fBPrevWorkspace\fR [\fIn\fR] / \fBRightWorkspace\fR [\fIn\fR] / \fBLeftWorkspace\fR [\fIn\fR] +.RS 4 +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\&. +.RE +.PP +\fBWorkspace\fR \fInumber\fR +.RS 4 +Jumps to the given workspace +\fInumber\fR\&. The first workspace is +\fB1\fR\&. +.RE +.PP +\fBNextWindow\fR [{\fIoptions\fR}] [\fIpattern\fR] / \fBPrevWindow\fR [{\fIoptions\fR}] [\fIpattern\fR] +.RS 4 +Focuses the next / previous window in the focus list\&. +.PP +\fIoptions\fR is one or more of the following, space delimited: +.RS 4 +.PP +\fBstatic\fR +.RS 4 +Instead of moving in order of most\-recent focus, move in order of when the window was opened (or, the order shown in the iconbar)\&. +.RE +.PP +\fBgroups\fR +.RS 4 +Only include the current tab in windows with multiple tabs\&. +.RE +.sp +If +\fIpattern\fR +arguments are supplied, only windows that match all the patterns are considered \- all others are skipped\&. See the section +\fBCLIENT PATTERNS\fR +below for more information\&. +.sp +This pair of commands has a special side\-effect when the keybinding used has a modifier \- It will temporarily raise the cycled window to the front so you can see it, but if you continue holding down the modifier and press the key again (For example, keep holding "Alt" while you tap the "Tab" key a few times), fluxbox will lower the window again when you move on to the next one\&. This allows you to preview the windows in order, but does not change the order in doing so\&. +.RE +.RE +.PP +\fBNextGroup\fR [{\fIoptions\fR}] [\fIpattern\fR] / \fBPrevGroup\fR [{\fIoptions\fR}] [\fIpattern\fR] +.RS 4 +Equivalent to NextWindow / PrevWindow above, but with the +\fBgroups\fR +option forced on\&. +.RE +.PP +\fBGotoWindow\fR \fInumber\fR [{\fIoptions\fR}] [\fIpattern\fR] +.RS 4 +Focuses and activates the window at position +\fInumber\fR +in the focus list\&. The +\fIoptions\fR +and +\fIpattern\fR +arguments have the same meaning as +\fBNextWindow\fR +above\&. +.RE +.PP +\fBActivate\fR [\fIpattern\fR] | \fBFocus\fR [\fIpattern\fR] +.RS 4 +With +\fIpattern\fR, this is an alias for +\fBGoToWindow\fR +1 +\fIpattern\fR\&. Without, this behaves like a window command, so that OnWindow events can change the focused window\&. +.RE +.PP +\fBAttach\fR \fIpattern\fR +.RS 4 +Combines all windows that match the +\fIpattern\fR +into a single tab group\&. See +\fBCLIENT PATTERNS\fR +for more about the +\fIpattern\fR +arguments\&. +.RE +.PP +\fBFocusLeft\fR / \fBFocusRight\fR / \fBFocusUp\fR / \fBFocusDown\fR +.RS 4 +Focus to the next window which is located in the direction specified\&. +.RE +.PP +\fBArrangeWindows\fR \fIpattern\fR +.RS 4 +Tries to arrange all windows on the current workspace so that they overlap the least amount possible\&. 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 +\fBDeiconify\fR \fImode\fR \fIdestination\fR +.RS 4 +Deiconifies windows (or, restores from a minimized state)\&. +.PP +Where \fImode\fR may be one of: +.RS 4 +.PP +\fBAll\fR +.RS 4 +All icons across all workspaces\&. +.RE +.PP +\fBAllWorkspace\fR +.RS 4 +All icons on the current workspace\&. +.RE +.PP +\fBLast\fR +.RS 4 +The last icon across all workspaces\&. +.RE +.PP +\fBLastWorkspace\fR (default) +.RS 4 +The last icon on the current workspace\&. +.RE +.RE +.PP +And \fIdestination\fR may be one of: +.RS 4 +.PP +\fBCurrent\fR (default) +.RS 4 +Deiconify to the current workspace\&. +.RE +.PP +\fBOriginQuiet\fR +.RS 4 +Deiconify to the window\'s original workspace, but does so in the background, without moving you there\&. +.RE +.RE +.RE +.PP +\fBSetWorkspaceName\fR \fIname\fR / \fBSetWorkspaceNameDialog\fR +.RS 4 +Sets the name of the current workspace\&. +.RE +.PP +\fBCloseAllWindows\fR +.RS 4 +Closes all windows on all desktops\&. +.RE +.SS "Menu Commands" +.sp +These commands open or close fluxbox popup menus\&. For more information on what these menus contain or how to configure them, see \fIfluxbox(1)\fR\&. +.PP +\fBRootMenu\fR +.RS 4 +Opens the root menu\&. See +\fBROOT MENU\fR +in +\fBfluxbox\-menu(5)\fR +for details\&. +.RE +.PP +\fBWorkspaceMenu\fR +.RS 4 +Opens a menu showing all workspaces and windows\&. See +\fBWorkspace Menu\fR +in +\fBfluxbox(1)\fR +for details\&. +.RE +.PP +\fBWindowMenu\fR +.RS 4 +Opens a menu containing actions for the current window\&. See +\fBWINDOW MENU\fR +in +\fBfluxbox\-menu(5)\fR +for details\&. +.PP +\fBClientMenu\fR [\fIpattern\fR] +.RS 4 +Opens a menu that contains all windows\&. If you specify a +\fIpattern\fR, only matching windows will be in the menu\&. Selecting a window will jump to that workspace and raise the window\&. See +\fBCLIENT PATTERNS\fR +below for more details on the +\fIpattern\fR +argument\&. +.RE +.PP +\fBCustomMenu\fR \fIpath\fR +.RS 4 +Opens a custom menu file\&. This +\fIpath\fR +must be a valid menu file in the same format as detailed by the +\fBROOT MENU\fR +section of +\fBfluxbox\-menu(5)\fR\&. +.RE +.PP +\fBHideMenus\fR +.RS 4 +Hide all fluxbox popup menus\&. +.RE +.RE +.SS "Window Manager Commands" +.sp +These commands affect the Window Manager, or more than one window\&. +.PP +\fBRestart\fR [\fIpath\fR] +.RS 4 +Restarts fluxbox\&. This does not close any running applications\&. If the optional +\fIpath\fR +is a path to an executable window manager, that manager is started in place of fluxbox\&. +.RE +.PP +\fBQuit\fR | \fBExit\fR +.RS 4 +Exits fluxbox\&. This will normally cause X to stop as well and terminate all existing applications, returning you to the login manager or console\&. +.RE +.PP +\fBReconfig\fR | \fBReconfigure\fR +.RS 4 +Reloads all fluxbox configuration files including the keys file, apps file, and init file, if they have changed\&. +.RE +.PP +\fBSetStyle\fR \fIpath\fR +.RS 4 +Sets the current style to that given in +\fIpath\fR, which must be the full path to a fluxbox style\&. +.RE +.PP +\fBReloadStyle\fR +.RS 4 +Reloads only the current style\&. Useful after editing a style which is currently in use\&. +.RE +.PP +\fBExecCommand\fR \fIargs \&...\fR | \fBExec\fR \fIargs \&...\fR | \fBExecute\fR \fIargs \&...\fR +.RS 4 +Probably the most\-used binding of all\&. Passes all the arguments to your +\fB$SHELL\fR +(or /bin/sh if $SHELL is not set)\&. You can use this to launch applications, run shell scripts, etc\&. Since all arguments are passed verbatim to the shell, you can use environment variables, pipes, or anything else the shell can do\&. Note that processes only see environment variables that were set before fluxbox started (such as in +\fB~/\&.fluxbox/startup\fR), or any that are set via the +\fBExport\fR +or +\fBSetEnv\fR +commands, below\&. See +\fBfluxbox(1)\fR +for more details on the +\fBENVIRONMENT\fR +and +\fB~/\&.fluxbox/startup\fR +file\&. +.RE +.PP +\fBCommandDialog\fR +.RS 4 +Pops up a dialog box that lets you type in any of these commands manually\&. +.RE +.PP +\fBSetEnv\fR \fIname\fR \fIvalue\fR | \fBExport\fR \fIname\fR=\fIvalue\fR +.RS 4 +Sets an environment variable in Fluxbox\&. It will be passed to any applications spawned by any future ExecCommand commands\&. +.RE +.PP +\fBSetResourceValue\fR \fIresourcename\fR \fIresourcevalue\fR | \fBSetResourceValueDialog\fR +.RS 4 +Sets a fluxbox resource value, which are normally stored in the init file\&. See +\fIfluxbox(1)\fR +for more details on available resources and allowed values\&. +.RE +.SS "Special Commands" +.sp +These commands have special meanings or behaviors\&. +.PP +\fBMacroCmd\fR {\fIcommand1\fR} {\fIcommand2\fR} {\fIcommand3\fR} \fI\&...\fR +.RS 4 +Allows you to execute more than one command with one keybinding\&. The commands will be executed in series\&. The +\fB{\fR +\fB}\fR +brackets are literally required, as in the following example: +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +MacroCmd {MoveTo 0 0} {ResizeTo 1280 800} +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.RE +.PP +\fBDelay\fR {\fIcommand\fR} [\fImicroseconds\fR] +.RS 4 +Delays running +\fIcommand\fR +for the given amount of time\&. If the same key binding is activated again, the timer will be restarted\&. +.RE +.PP +\fBToggleCmd\fR {\fIcommand1\fR} {\fIcommand2\fR} \fI\&...\fR +.RS 4 +Alternates between the commands\&. On the first press of the bound key, runs +\fIcommand1\fR\&. On the next press, runs +\fIcommand2\fR\&. +.RE +.PP +\fBBindKey\fR \fIkeybinding\fR +.RS 4 +Adds the given +\fIkeybinding\fR +(which must be a valid key binding as defined in the DESCRIPTION section above) to your keys file\&. +.RE +.PP +\fBKeyMode\fR \fIkeymode\fR [\fIreturn\-keybinding\fR] +.RS 4 +Activates the named +\fIkeymode\fR +(or, all key binding lines prefaced with the same +\fIkeymode\fR:) and deactivates all others until the +\fIreturn\-keybinding\fR +(by default +\fBEscape\fR) is pressed\&. The default keymode is named +\fIdefault\fR\&. +.RE +.PP +\fBForEach\fR {\fIcommand\fR} [{\fIcondition\fR}] | \fBMap\fR {\fIcommand\fR} [{\fIcondition\fR}] +.RS 4 +Runs the given +\fIcommand\fR +(normally one from the +\fBWindow Commands\fR +section above) on each window\&. If you specify a +\fIcondition\fR +(See +\fBConditions\fR, below) the action will be limited to matching windows\&. +.RE +.PP +\fBIf\fR {\fIcondition\fR} {\fIthen\-command\fR} [{\fIelse\-command\fR}] | \fBCond\fR {\fIcondition\fR} {\fIthen\-command\fR} [{\fIelse\-command\fR}] +.RS 4 +If the +\fIcondition\fR +command returns +\fBtrue\fR, then run the +\fIthen\-command\fR, otherwise run the optional +\fIelse\-command\fR\&. See +\fBConditions\fR +below for more information on the +\fIcondition\fR +argument\&. +.RE +.SS "Conditions" +.sp +These special commands are used to match windows conditionally\&. They are commonly used by the \fBIf\fR and \fBForEach\fR command\&. +.PP +\fBMatches\fR \fIpattern\fR +.RS 4 +Returns +\fBtrue\fR +if the current window matches the given +\fIpattern\fR\&. See +\fBCLIENT PATTERNS\fR +below for details on the +\fIpattern\fR +syntax\&. +.sp +If your key binding uses the +\fBOnWindow\fR +modifier, it matches against the window you clicked, not the currently focused window\&. +.sp +To check other windows besides the currently focused one, see the +\fBEvery\fR +and +\fBSome\fR +conditions below\&. +.RE +.PP +\fBSome\fR \fIcondition\fR +.RS 4 +Retuns +\fBtrue\fR +if any window on any workspace (not just the currently focused one) matches the +\fIcondition\fR\&. +.RE +.PP +\fBEvery\fR \fIcondition\fR +.RS 4 +Retuns +\fBtrue\fR +if every window on every workspace (not just the current one) matches the +\fIcondition\fR\&. +.RE +.PP +\fBNot\fR \fIcondition\fR +.RS 4 +Returns +\fBtrue\fR +if +\fIcondition\fR +returns +\fBfalse\fR, and vice\-versa\&. +.RE +.PP +\fBAnd\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...] +.RS 4 +Returns +\fBtrue\fR +if and only if all given conditions return +\fBtrue\fR\&. +.RE +.PP +\fBOr\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...] +.RS 4 +Returns +\fBtrue\fR +if any of the listed conditions return +\fBtrue\fR\&. +.RE +.PP +\fBXor\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...] +.RS 4 +Returns the boolean +\fBxor\fR +of the truth values for all conditions listed\&. +.RE +.SH "CLIENT PATTERNS" +.sp +Many of the more advanced commands take a \fIpattern\fR argument, which allows you to direct the action at a specific window or set of windows which match the properties specified in the \fIpattern\fR\&. +.PP +A \fIpattern\fR looks like this: +.RS 4 + +\fB(\fR[\fIpropertyname\fR[!]=]\fIregexp\fR\fB)\fR +\&... +.RE +.sp +Match definitions are enclosed in parentheses \fB(\fR\&...\fB)\fR, and if no \fIpropertyname\fR is given then \fBName\fR is assumed\&. The \fIregexp\fR can contain any regular expression, or the special value \fB[current]\fR, which matches the corresponding value of the currently focused window\&. See \fIregex(7)\fR for more information on acceptable regular expressions\&. +.sp +\fIpropertyname\fR is not case sensitive, whereas the \fIregexp\fR is\&. +.sp +If you specify multiple \fB(\fR\fB\fIpattern\fR\fR) arguments, this implies an AND condition \- All specified patterns must match\&. +.sp +You can use \fB=\fR to test for equality or \fB!=\fR to test for inequality\&. +.PP +The following values are accepted for \fIpropertyname\fR: +.RS 4 +.PP +\fBName\fR +.RS 4 +A string, corresponding to the CLASSNAME property (The first field of WM_CLASS from the output of the +\fBxprop(1)\fR +utility)\&. +.RE +.PP +\fBClass\fR +.RS 4 +A string, corresponding to the CLASSCLASS property (The second field of WM_CLASS from the output of the +\fBxprop(1)\fR +utility)\&. +.RE +.PP +\fBTitle\fR +.RS 4 +A string, corresponding to the window title (WM_NAME from +\fBxprop(1)\fR)\&. +.RE +.PP +\fBRole\fR +.RS 4 +A string, corresponding to the ROLE property (WM_WINDOW_ROLE from +\fBxprop(1)\fR)\&. +.RE +.PP +\fBTransient\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is transient (typically, a popup dialog) or not\&. +.RE +.PP +\fBMaximized\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is maximized 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 +\fBShaded\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is shaded or not\&. +.RE +.PP +\fBStuck\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is sticky (on all workspaces) or not\&. +.RE +.PP +\fBFocusHidden\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window has asked to be left off the focus list (or, the alt\-tab list), or not\&. +.RE +.PP +\fBIconHidden\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window has asked to be left off the icon list (or, the taskbar), or not\&. +.RE +.PP +\fBUrgent\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window has the urgent hint set\&. +.RE +.PP +\fBWorkspace\fR +.RS 4 +A number corresponding to the workspace number to which the window is attached\&. The first workspace here is +\fB0\fR\&. You may also use +\fB[current]\fR +to match the currently visible workspace\&. +.RE +.PP +\fBWorkspaceName\fR +.RS 4 +A string corresponding to the name of the workspace to which the window is attached\&. +.RE +.PP +\fBHead\fR +.RS 4 +The number of the display head to which the window is attached\&. You may match this against the special value +\fB[mouse]\fR +which refers to the head where the mouse pointer currently resides\&. +.RE +.PP +\fBLayer\fR +.RS 4 +The string name of the window\'s layer, which is one of +\fBAboveDock\fR, +\fBDock\fR, +\fBTop\fR, +\fBNormal\fR, +\fBBottom\fR, +\fBDesktop\fR +.RE +.RE +.PP +\fBExample\ \&2.\ \&Matches any windows with the CLASSNAME of "xterm"\fR +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +(xterm) +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&3.\ \&Matches any windows with the same CLASSNAME as the currently focused window\fR +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +(Name=[current]) +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&4.\ \&Matches any windows on the same head as the mouse but on a different layer than the currently focused window\fR +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +(Head=[mouse]) (Layer!=[current]) +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.SH "FILES" +.PP +\fB~/\&.fluxbox/keys\fR +.RS 4 +This is the default location for the keybinding definitions\&. +.RE +.PP +\fB/usr/X11R6/include/X11/keysymdef\&.h\fR +.RS 4 +X key names are in this file\&. +.RE +.PP +\fB/usr/X11R6/lib/X11/XKeysymDB\fR +.RS 4 +X key names are also in this file\&. +.RE +.SH "RESOURCES" +.PP +\fBsession\&.keyFile:\fR \fIlocation\fR +.RS 4 +This may be set to override the location of the keybinding definitions\&. +.RE +.SH "ENVIRONMENT" +.sp +Remember that \fBExecCommand\fR command can take advantage of other environment variables if they are set before fluxbox is started, or via the \fBExport\fR or \fBSetEnv\fR commands\&. For example, if \fB$TERM\fR is set, it could be use like this: +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +Mod1 x :ExecCommand $TERM +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.sp +For more information about environment variables, see your shell\'s manual\&. +.SH "EXAMPLES" +.sp +Here are some interesting and/or useful examples you can do with your keys file\&. +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +# Mod4+drag moves a window +OnWindow Mod4 Mouse1 :StartMoving + +# If any xterm windows are open, cycle through them\&. If none are open, open +# one: +Mod4 t :If {Some Matches (xterm)} {NextWindow (xterm)} {Exec xterm} + +# Set a different wallpaper on every workspace: +ChangeWorkspace :Exec fbsetbg ~/\&.fluxbox/bg$(xprop \-root _NET_CURRENT_DESKTOP | awk \'{print $3}\')\&.png +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.SH "AUTHORS" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Jim Ramsay <i\&.am at jimramsay com> (>fluxbox\-1\&.0\&.0) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Curt Micol <asenchi at asenchi com> (>fluxbox\-0\&.9\&.11) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Tobias Klausmann <klausman at users sourceforge net> (\(lafluxbox\-0\&.9\&.11) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Grubert <grubert at users sourceforge net> (fluxbox) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Matthew Hawkins <matt at mh dropbear id au> (blackbox) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Wilbert Berendsen <wbsoft at xs4all nl> (blackbox) +.RE +.SH "SEE ALSO" +.sp +fluxbox(1) xprop(1) xev(1) xkill(1) regex(7)
M doc/asciidoc/fluxbox-keys.txtdoc/asciidoc/fluxbox-keys.txt

@@ -1,7 +1,10 @@

fluxbox-keys(5) =============== Jim Ramsay <i.am@jimramsay.com> -v1.1.0, 22 July, 2008 +v1.1.1, 10 February 2009 +:man source: fluxbox-keys.txt +:man version: {revision} +:man manual: Fluxbox Manual NAME ----

@@ -554,83 +557,14 @@ *Xor* {'condition1'} {'condition2'} [{'condition3'} ...]::

Returns the boolean *xor* of the truth values for all conditions listed. + CLIENT PATTERNS --------------- Many of the more advanced commands take a 'pattern' argument, which allows you to direct the action at a specific window or set of windows which match the -properties specified in the 'pattern'. A 'pattern' looks like this: - -(['propertyname'[!]=]'regexp') ... +properties specified in the 'pattern'. -Match definitions are enclosed in parentheses *(*...*)*, and if no -'propertyname' is given then *Name* is assumed. The 'regexp' can contain any -regular expression, or the special value *[current]*, which matches the -corresponding value of the currently focused window. See 'regex(7)' for more -information on acceptable regular expressions. - -You can use *=* to test for equality or *!=* to test for inequality. - -The following values are accepted for 'propertyname'::: -*Name*;; - A string, corresponding to the CLASSNAME property. -*Class*;; - A string, corresponding to the CLASSCLASS property. -*Title*;; - A string, corresponding to the window title. -*Role*;; - A string, corresponding to the ROLE property. -*Transient*;; - Either *yes* or *no*, depending on whether the window is transient - (typically, a popup dialog) or not. -*Maximized*;; - Either *yes* or *no*, depending on whether the window is maximized or - not. -*Minimized*;; - Either *yes* or *no*, depending on whether the window is minimized - (iconified) or not. -*Shaded*;; - Either *yes* or *no*, depending on whether the window is shaded or - not. -*Stuck*;; - Either *yes* or *no*, depending on whether the window is sticky (on - all workspaces) or not. -*FocusHidden*;; - Either *yes* or *no*, depending on whether the window has asked to be - left off the focus list (or, the alt-tab list), or not. -*IconHidden*;; - Either *yes* or *no*, depending on whether the window has asked to be - left off the icon list (or, the taskbar), or not. -*Urgent*;; - Either *yes* or *no*, depending on whether the window has the urgent - hint set. -*Workspace*;; - A number corresponding to the workspace number to which the window is - attached. The first workspace here is *0*. -*WorkspaceName*;; - A string corresponding to the name of the workspace to which the - window is attached. -*Head*;; - The number of the display head to which the window is attached. You - may match this against the special value *[mouse]* which refers to the - head where the mouse pointer currently resides. -*Layer*;; - The string name of the window's layer, which is one of - *AboveDock*, *Dock*, *Top*, *Normal*, *Bottom*, *Desktop* - -.Matches any windows with the CLASSNAME of "xterm" -.......... -(xterm) -.......... - -.Matches any windows with the same CLASSNAME as the currently focused window -.......... -(Name=[current]) -.......... - -.Matches any windows on the same head as the mouse but on a different layer than the currently focused window -........... -(Head=[mouse]) (Layer!=[current]) -........... +include::client-patterns.txt[] FILES -----
A doc/asciidoc/fluxbox.1

@@ -0,0 +1,2336 @@

+.\" Title: fluxbox +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> +.\" Date: 04/24/2009 +.\" Manual: Fluxbox Manual +.\" Source: fluxbox.txt 1.1.2 +.\" Language: English +.\" +.TH "FLUXBOX" "1" "04/24/2009" "fluxbox\&.txt 1\&.1\&.2" "Fluxbox Manual" +.\" ----------------------------------------------------------------- +.\" * (re)Define some macros +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" toupper - uppercase a string (locale-aware) +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de toupper +.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ +\\$* +.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH-xref - format a cross-reference to an SH section +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de SH-xref +.ie n \{\ +.\} +.toupper \\$* +.el \{\ +\\$* +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH - level-one heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SH +.\" put an extra blank line of space above the head in non-TTY output +.if t \{\ +.sp 1 +.\} +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[an-margin]u +.ti 0 +.HTML-TAG ".NH \\n[an-level]" +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +\." make the size of the head bigger +.ps +3 +.ft B +.ne (2v + 1u) +.ie n \{\ +.\" if n (TTY output), use uppercase +.toupper \\$* +.\} +.el \{\ +.nr an-break-flag 0 +.\" if not n (not TTY), use normal case (not uppercase) +\\$1 +.in \\n[an-margin]u +.ti 0 +.\" if not n (not TTY), put a border/line under subheading +.sp -.6 +\l'\n(.lu' +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SS - level-two heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SS +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[IN]u +.ti \\n[SN]u +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.ps \\n[PS-SS]u +\." make the size of the head bigger +.ps +2 +.ft B +.ne (2v + 1u) +.if \\n[.$] \&\\$* +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BB/BE - put background/screen (filled box) around block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BB +.if t \{\ +.sp -.5 +.br +.in +2n +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EB +.if t \{\ +.if "\\$2"adjust-for-leading-newline" \{\ +.sp -1 +.\} +.br +.di +.in +.ll +.gcolor +.nr BW \\n(.lu-\\n(.i +.nr BH \\n(dn+.5v +.ne \\n(BHu+.5v +.ie "\\$2"adjust-for-leading-newline" \{\ +\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.el \{\ +\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.in 0 +.sp -.5v +.nf +.BX +.in +.sp .5v +.fi +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BM/EM - put colored marker in margin next to block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BM +.if t \{\ +.br +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EM +.if t \{\ +.br +.di +.ll +.gcolor +.nr BH \\n(dn +.ne \\n(BHu +\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] +.in 0 +.nf +.BX +.in +.fi +.\} +.. +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "Name" +fluxbox \- A lightweight window manager for the X Windowing System +.SH "Synopsis" +.sp +\fBfluxbox\fR [\-rc \fIrcfile\fR] [\-log \fIlogfile\fR] [\-display \fIdisplay\fR] [\-screen all|\fIscr\fR,\fIscr\fR\&...] [\-verbose] [\-sync] +.sp +\fBfluxbox\fR [\-v | \-version] | [\-h | \-help] | [\-i | \-info] | [\-list\-commands] +.SH "DESCRIPTION" +.sp +\fBfluxbox(1)\fR is a window manager\&. As such it provides configurable window decorations, a root menu to launch applications and a toolbar that shows the current workspace name, a set of application names and the current time\&. There is also a workspace menu to add or remove workspaces\&. +.sp +Fluxbox can iconify (or minimize) windows to the toolbar One click and they reappear\&. A double\-click on the titlebar of the window will \fIshade\fR it; i\&.e\&. the window will disappear, and only the titlebar will remain visible\&. +.sp +There are also two areas commonly used by small applets: the `slit\' can be used to dock small applications; e\&.g\&. most of the \(lqbbtools\(rq and \(lqWindow Maker dockapps\(rq can use the slit, and the `systray\' which lives in the toolbar supports standard system tray icons provided by some applications\&. +.sp +Fluxbox uses its own graphics class to render its images on the fly\&. By using style files, you can determine in great detail how your desktop looks\&. fluxbox styles are compatible with those of Blackbox 0\&.65 or earlier versions, so users migrating can still use their current favourite themes\&. +.sp +Most of the default keyboard and mouse button actions mentioned in this manual can be changed and configured in the `keys\' file\&. This powerful configuration file can also be used to automate almost any action you may want to perform, from launching applications to moving windows around the screen\&. See \fBfluxbox\-keys(5)\fR for details\&. +.sp +Fluxbox can also remember certain attributes of individual application windows and restore these settings the next time the window opens\&. See the \fBfluxbox\-apps(5)\fR for details\&. +.sp +Fluxbox supports the majority of the Extended Window Manager Hints (EWMH) specification, as well as numerous other Window Hinting standards\&. This allows all compliant window managers to provide a common interface to standard features used by applications and desktop utilities\&. +.SH "OPTIONS" +.PP +\fB\-display\fR \fIdisplay\fR +.RS 4 +Start fluxbox on the specified display\&. Programs started by fluxbox will share the DISPLAY environment variable also\&. +.RE +.PP +\fB\-h\fR, \fB\-help\fR +.RS 4 +Display command line options\&. +.RE +.PP +\fB\-i\fR, \fB\-info\fR +.RS 4 +Display useful information concerning the defaults and compiled\-in options\&. +.RE +.PP +\fB\-log\fR \fIlogfile\fR +.RS 4 +Starting fluxbox with this option will designate a file in which you want to log events to\&. +.RE +.PP +\fB\-rc\fR \fIrcfile\fR +.RS 4 +Use a different config file other than the default +\fB~/\&.fluxbox/init\fR\&. +.RE +.PP +\fB\-v\fR, \fB\-version\fR +.RS 4 +The version of fluxbox installed\&. +.RE +.PP +\fB\-screen\fR all|\fIscr\fR,\fIscr\fR\&... +.RS 4 +Run on specified screens only or all (by default)\&. +.RE +.PP +\fB\-verbose\fR +.RS 4 +Print more information in process\&. +.RE +.PP +\fB\-sync\fR +.RS 4 +Synchronize with the X server for debugging\&. +.RE +.PP +\fB\-list\-commands\fR +.RS 4 +Lists all available internal commands\&. +.RE +.SH "STARTING FLUXBOX" +.sp +\fBfluxbox(1)\fR comes with a program called \fBstartfluxbox(1)\fR usually located wherever you installed fluxbox\&. This script provides you with many options and variables that can be set when starting fluxbox\&. To actually call fluxbox and begin using it, you should place \(lqexec startfluxbox\(rq in your \fB~/\&.xinitrc\fR as the last executed command\&. This is assuming that the location of \fBfluxbox(1)\fR and \fBstartfluxbox(1)\fR are in your shell\'s $PATH\&. Also note that you may need to create the \fB~/\&.xinitrc\fR file or your setup may use \fB~/\&.xsession\fR instead, depending on your X setup\&. Some X login managers like \fBgdm(1)\fR or \fBkdm(1)\fR may simply provide a \(lqFluxbox\(rq session for you without having to alter any settings\&. +.sp +By using fluxbox \-i you\'ll see the defaults used by \fBfluxbox(1)\fR\&. These are what fluxbox looks for upon startup\&. In the list of \(lqDefaults:\(rq you\'ll see a menu file location, this is where you can provide a system\-wide menu file for your users\&. +.sp +On exit or restart, fluxbox will save user defaults in the file \fB~/\&.fluxbox/init\fR\&. Resources in this file can also be edited by hand, see the \fBRESOURCES\fR section for more details\&. \fBfluxbox(1)\fR also has many tools to edit these; look through the main menu once fluxbox has started to find different ways of managing your session\&. +.SH "USING FLUXBOX" +.sp +When using fluxbox for the first time, users who are more accustomed to full desktop environments such as KDE or Gnome may be a little surprised by the minimal screen content\&. fluxbox is designed to be fast and powerful, so it may take a bit of getting used to \(em however, the rewards are worthwhile\&. +.sp +In this section, we\'ll give a quick summary of the common things\&. However, we recommend that you consult the referenced sections of this manual to further develop your understanding of what you can do with fluxbox\&. +.SS "Root Window (Main)" +.sp +Looking at the fluxbox desktop immediately after startup you\'ll generally see only one thing: the toolbar\&. If you right\-click (mouse button 3) somewhere on the desktop, you can access the Root Menu\&. A middle\-click (mouse button 2) on the desktop shows you the Workspace Menu\&. +.SS "Root Menu and Workspace Menu" +.sp +From the RootMenu you can launch applications and configure fluxbox\&. The WorkspaceMenu shows all windows and on which workspaces they are\&. See section \fBMENUS\fR on how to customize these menus\&. +.SS "Toolbar" +.sp +The toolbar contains any combination of the following tools, by default in this order: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBWorkspace Name\fR: Name of the current visible workspace +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBWorkspace Arrows\fR: Previous/Next Workspace +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBIconbar\fR: List of windows managed by fluxbox +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBWindow Arrows\fR: Previous/Next Application Window +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBSystem Tray\fR: Area for applets +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBClock\fR: Date and Time +.RE +.sp +The contents and behavior of the toolbar can be configured, see the \fBTOOLBAR\fR section for details\&. +.SS "Slit" +.sp +Initially you won\'t be able to see the slit\&. It is there, but it isn\'t being used yet, which confuses some people initially\&. Think of it as a dock where you can place smaller programs\&. If you\'ve looked at any screenshots on the official fluxbox web site, you will have noticed some small programs on the edge of some of the screens\&. These were more than likely docked programs in the slit\&. To learn more about the slit, we have an entire \fBSLIT\fR section below that goes into detail about the options you have\&. +.SS "Layers" +.sp +fluxbox manages the following layers (from highest to lowest): +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Above Dock +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Dock +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Top +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Normal +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Bottom +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Desktop +.RE +.sp +Windows on a higher layer will always appear above those on a lower one\&. These layers can be used on application windows, the slit or the toolbar\&. You can assign applications to a certain layer by specifying it in the `apps\' file or through the WindowMenu\&. We discuss the `apps\' file in \fBfluxbox\-apps(5)\fR\&. We discuss the WindowMenu in the \fBMENUS\fR section\&. We discuss layers in more detail in the \fBLAYERS\fR section\&. +.SS "Focus Model" +.sp +The window that has the focus is the one that receives key and mouse events\&. The focus model is selectable via the Configuration menu located in the root menu\&. We\'ll discuss the different types of focus below in the \fBFOCUS MODEL\fR section\&. +.SS "Windows" +.sp +A left\-click (mouse button 1) on any part of the window\'s border will raise it\&. Dragging then moves the window to another part of the desktop\&. A right click and drag on the border resizes the window\&. Dragging the resize grips at the left and right bottom corners also will resize the window\&. Middle clicking on a border or titlebar will immediately lower the window\&. Right clicking on the titlebar opens the Window menu\&. The commands unique to this menu are discussed in detail in the \fBWindow Menu\fR section\&. +.SS "Tabs" +.sp +fluxbox allows windows to be `grouped\' by middle clicking and holding on a window\'s tab and dragging it onto another window\&. This `tabbing\' allows you to put multiple applications in one location on the desktop and do several operations (for example, moving or resizing) to all windows in the group\&. By default, tabs are located just above the window, but they may be embedded in the titlebar or moved to other locations on the outside of the window\&. Configuration is discussed in TAB OPTIONS section\&. +.sp +You can also set up automatic grouping using the `apps\' file\&. See \fBGROUP SECTIONS\fR in \fBfluxbox\-apps(5)\fR for details\&. +.SS "Key Bindings" +.sp +There are a number of key bindings set up by default, which can be configured and extended to just about anything you can imagine with the keyboard\&. See \fBfluxbox\-keys(5)\fR for details on how to do this\&. +.sp +The default bindings set up by fluxbox are as follows: +.sp +Mouse clicks on the empty desktop: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBLeft\-click\fR +(Button 1): hides all fluxbox menus +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBMiddle\-click\fR +(Button 2): shows the Workspace Menu +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBRight\-click\fR +(Button 3): shows the Root Menu +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBScroll wheel\fR +(Buttons 4 and 5): jump to the previous/next workspace +.RE +.sp +Mouse gestures on a window: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBALT+Drag Left\-click\fR +anywhere on a window moves the window\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBALT+Drag Right\-click\fR +anywhere on a window resizes the window\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBALT+Middle\-click\fR +anywhere on a window lowers the current window\&. +.RE +.sp +Mouse gestures on a window\'s titlebar: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBCTRL+Drag Left\-click\fR +on a window\'s titlebar lets you drag to attach the window to another\'s tab group +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBDouble Left\-click\fR +on a window\'s titlebar shades the window +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBMiddle\-click\fR +on a window\'s titlebar lowers the window +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBRight\-click\fR +on a window\'s titlebar pops up the +\fBWindow Menu\fR +.RE +.sp +Mouse gestures on the toolbar: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBScroll wheel\fR +on the toolbar cycles through windows +.RE +.sp +Keyboard bindings: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBALT+Tab\fR +/ +\fBALT+Shift+Tab\fR: Cycle through windows +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBWIN+Tab\fR +/ +\fBWIN+Shift+Tab\fR: Cycle through tabs +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBWin+1\fR +\(-> +\fBWin+9\fR: Select the 1st \(-> 9th tab in the current window +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBALT+F1\fR: Run +\fBxterm(1)\fR +to open a new terminal +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBALT+F2\fR: Run +\fBfbrun(1)\fR +for a small \(lqrun program\(rq dialog +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBALT+F4\fR: Close the current window +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBALT+F5\fR: Kill the current window (like +\fBxkill(1)\fR) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBALT+F9\fR: Minimize (iconify) the current window +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBALT+F10\fR: Maximize the current window +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBALT+F11\fR: Full\-screen the current window +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBALT+Space\fR: Open the +\fBWindow Menu\fR +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBCTRL+ALT+Del\fR: Exit fluxbox (log out) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBCTRL+ALT+Left\fR +/ +\fBCTRL+ALT+Right\fR: Go to the previous/next workspace +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBWIN+Left\fR +/ +\fBWIN+Right\fR: Send the current window to the previous/next workspace, but remain on this workspace +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBCTRL+WIN+Left\fR +/ +\fBCTRL+WIN+Right\fR: Take the current window to the previous/next workspace, and switch to that workspace +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBCTRL+F1\fR +\(-> +\fBCTRL+F12\fR: Switch to the 1st \(-> 12th workspace +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBWIN+F1\fR +\(-> +\fBWIN+F12\fR: Send the current window to a specific workspace +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBCTRL+WIN+F1\fR +\(-> +\fBCTRL+WIN+F12\fR: Take the current window to a specific workspace +.RE +.SH "MENUS" +.sp +fluxbox provides a popup menu facility that is used by a few different types of native menus\&. +.sp +When a menu is open, you can click on items with the mouse to activate them\&. Some special menu items react slightly differently depending on the mouse button you use, but normally you will want to use a left\-click (button 1)\&. +.sp +You can also use the the keyboard arrow key to navigate, or even type the first few letters of the item\'s label to select it, and \(lqenter\(rq to activate the item\&. +.sp +Normally activating a menu item should close the menu\&. You can also right\-click the title are of a menu or press \(lqesc\(rq to close it without activating an item\&. +.SS "Root Menu" +.sp +The root menu is where you can launch commonly\-used applications and change different aspects of fluxbox by simply clicking on a menu item\&. By default it is opened by a right\-click on the empty area of the desktop\&. +.sp +The contents of this menu can be configured, see \fBfluxbox\-menu(5)\fR for details\&. +.sp +The default menu, which is created by the \(lqfluxbox\-generate_menu\(rq command, contains menus for installed applications, as well as a special \(lqFluxbox menu\(rq item with the items detailed below: +.PP +\fBConfigure\fR +.RS 4 +The next level under this menu is where you can set certain resources and really begin to customize the look and feel of your desktop\&. See the +\fBConfigure Menu\fR +section below for more details\&. +.RE +.PP +\fBSystem Styles\fR +.RS 4 +This is where the standard styles are listed\&. You can select one of these by clicking on it, and it will be applied immediately\&. System styles are located in +\fB@pkgdatadir@/styles/\fR +upon a default install\&. Remember that you can confirm this with fluxbox \-i\&. +.RE +.PP +\fBUser Styles\fR: +.RS 4 +This is where your custom styles are listed\&. It will list any styles from +\fB~/\&.fluxbox/styles/\fR, which may be styles you grab from the Internet, or your own custom styles, provided you follow the standards described in +\fBfluxbox\-style(5)\fR\&. +.RE +.PP +\fBWorkspace List\fR: +.RS 4 +This is the same as the +\fBWorkspace Menu\fR +detailed below\&. +.RE +.PP +\fBTools\fR: +.RS 4 +Listed here are different tools that you can use\&. You can rename your workspace, run programs from a command line or regenerate your menu\&. +.RE +.PP +\fBWindow Managers\fR: +.RS 4 +Allows you to switch your window manager\&. (Only listed if you have other window managers/desktop environments installed\&.) +.RE +.PP +\fBLock Screen\fR: +.RS 4 +Locks the screen, if a suitable locking program has been detected\&. +.RE +.PP +\fBFluxbox Command\fR: +.RS 4 +A little Commandline will popup where you can enter a fluxbox command\&. These commands are the same as those detailed in +\fBfluxbox\-keys(5)\fR\&. +.RE +.PP +\fBReload config\fR: +.RS 4 +Use this to reload the fluxbox configuration files\&. You must do this after editing the `keys\' file, `init\' file, or the current style\&. +.RE +.PP +\fBRestart\fR: +.RS 4 +Restart the whole darn thing\&. This starts a completely new fluxbox process, rereads files and redraws all graphical elements\&. Running applications will remain open, however, and restored to the same workspaces they were previously in once fluxbox returns\&. +.RE +.PP +\fBExit\fR: +.RS 4 +Exits fluxbox, which in turn either shuts down the X Window server or returns you to the graphical login screen\&. +.RE +.SS "Configuration Menu" +.sp +This menu offers the opportunity to set up fluxbox\&. It contains many options which can be altered manually in the `init\' file, but this is an easier and faster way to change the most common settings\&. +.sp +All changes take effect immediately\&. +.PP +\fBFocus Model\fR: +.RS 4 +Lets you configure the window focus model\&. For details, see +\fBFOCUS MODEL\fR, below\&. +.RE +.PP +\fBMaximize Options\fR: +.RS 4 +Lets you configure what happens when you maximize a window\&. The four options are: +.PP +\fBFull Maximization\fR: +.RS 4 +Normally, a maximized window will not overlap the toolbar, slit, or any docked windows (like panels)\&. Enabling this option allows maximized windows to be as large as the actual screen resolution\&. +.RE +.PP +\fBIgnore Resize Increment\fR: +.RS 4 +Normally, terminal windows specify a \(lqresize increment\(rq which mean fluxbox will only resize the window to an even multiple of the character size\&. Enabling this option will ignore this specification when maximizing\&. +.RE +.PP +\fBDisable Moving\fR / \fBDisable Resizing\fR: +.RS 4 +Normally, maximized windows can still be moved and resized\&. Enabling these options prevents these behaviour\&. +.RE +.RE +.PP +\fBTab Options\fR: +.RS 4 +Lets you configure the properties of tabs\&. Detailed in +\fBTAB OPTIONS\fR, below\&. +.RE +.PP +\fBSlit\fR: +.RS 4 +This menu can also be found by right\-clicking the slit (if visible)\&. Find more information about this menu\'s options in the +\fBSlit Menu\fR +section, below\&. +.RE +.PP +\fBToolbar\fR: +.RS 4 +This menu can also be found by right\-clicking any non\-icon part of the toolbar\&. Find more information about this menu\'s options in the +\fBToolbar Menu\fR +section, below\&. +.RE +.PP +\fBTransparency\fR: +.RS 4 +This sets the default transparency for a focused windows, unfocused window and the menu\&. Use the left mouse button to decrease and the right mouse button to increase the value\&. 0 is invisible, 255 is not transparent at all\&. +.sp +The transparency of individual application windows can be overridden in the `apps\' file (\fBfluxbox\-apps(5)\fR)\&. +.sp +The +\fBForce Pseudo Transparency\fR +option will force fluxbox to ignore the xcomposite extension and use pseudo\-transparency instead of true transparency\&. Note: When pseudo\-transparency is on, the transparency values here only affect titlebars, not window contents\&. +.RE +.PP +\fBOpaque Window Moving\fR: +.RS 4 +If enabled, you will see the window content while dragging it\&. Otherwise only an outline of the window will be shown\&. +.RE +.PP +\fBWorkspace Warping\fR: +.RS 4 +If enabled, you can drag windows from one workspace to another\&. The previous workspace is to the left, the next workspace is to the right\&. +.RE +.SS "Window Menu" +.sp +The Window menu is displayed when you right click on the titlebar of a window\&. +.sp +To customize this menu, see the \fBWINDOW MENU\fR section of \fBfluxbox\-menu(5)\fR\&. +.sp +By default, this menu contains: +.PP +\fBShade\fR: +.RS 4 +Shade the window (display the titlebar only)\&. +.RE +.PP +\fBStick\fR: +.RS 4 +(Un)Stick window\&. A `stuck\' window will always be displayed on all workspaces\&. +.RE +.PP +\fBSend To\&...\fR: +.RS 4 +Send window to another workspace\&. When you select the workspace with a middle click, fluxbox will send you along with the application to the selected workspace\&. +.RE +.PP +\fBMaximize\fR: +.RS 4 +(Un)Maximize window\&. Depending on your toolbar and slit configuration, maximize may cover them\&. You can use the different mouse buttons for different aspects of maximize function\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Button 1 (Un)Maximize as normal\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Button 2 (Un)Maximize window vertically\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Button 3 (Un)Maximize window horizontally\&. +.RE +.RE +.PP +\fBIconify\fR: +.RS 4 +Iconify (or minimize) a window\&. The `icon\' can be found in the Icons submenu of the workspace menu as well as in the toolbar (if a Toolbar mode showing Icons is selected)\&. +.RE +.PP +\fBRaise\fR: +.RS 4 +Raise the window above all others in the same layer\&. +.RE +.PP +\fBLower\fR: +.RS 4 +Lower the window below all others in the same layer\&. +.RE +.PP +\fBLayer\&...\fR: +.RS 4 +Change the layer of this window\&. See +\fBLAYERS\fR +for more details\&. +.RE +.PP +\fBTransparency\fR: +.RS 4 +Change this window\'s transparency, overriding the defaults from the +\fBConfiguration Menu\fR\&. +.RE +.PP +\fBRemember\&...\fR: +.RS 4 +Specify which window settings should be stored in the `apps\' file and resumed the next time this window is opened\&. +.sp +Specifically the setting you may store are: +.PP +\fBWorkpace:\fR +.RS 4 +Open this in the same workspace as where the window currently resides\&. +.RE +.PP +\fBJump to workspace:\fR +.RS 4 +When +\fBWorkspace\fR +is selected, fluxbox will jump to the appropriate workspace when this window is opened there\&. If not selected, the window will open in the background\&. +.RE +.PP +\fBHead\fR: +.RS 4 +For xinerama users only, start this window on the current head (or screen)\&. +.RE +.PP +\fBDimensions\fR: +.RS 4 +Record the current window height and width\&. +.RE +.PP +\fBPosition\fR: +.RS 4 +Record the current X and Y coordinates of the window\&. +.RE +.PP +\fBSticky\fR: +.RS 4 +Record whether the window is on all desktops, or not\&. +.RE +.PP +\fBDecorations\fR: +.RS 4 +Record the current set of decorations (title bar, grips, tabs, etc) on the window\&. +.RE +.PP +\fBShaded\fR: +.RS 4 +Record whether the window is shaded (or rolled\-up) or not\&. +.RE +.PP +\fBMinimized\fR: +.RS 4 +Record whether the window is iconified (or minimized) or not\&. +.RE +.PP +\fBMaximized\fR: +.RS 4 +Record whether the window is maximized or not\&. +.RE +.PP +\fBFullscreen\fR: +.RS 4 +Record whether the window is in fullscreen mode or not\&. +.RE +.PP +\fBTransparency\fR: +.RS 4 +Record the current +\fBTransparency\fR +settings\&. +.RE +.PP +\fBLayer\fR: +.RS 4 +Record the current layer\&. +.RE +.PP +\fBSave on close\fR: +.RS 4 +If selected, any of the above items which are also selected will be updated with the window\'s current values as it is closed\&. +.RE +.sp +These are is covered in more detail in +\fBfluxbox\-apps(5)\fR\&. +.RE +.PP +\fBClose\fR: +.RS 4 +Close the application softly\&. +.RE +.PP +\fBKill\fR: +.RS 4 +Kill the window\'s parent process, like +\fBxkill(1)\fR\&. +.RE +.SS "Workspace Menu" +.sp +The workspace menu can be found, by default, by middle\-clicking on the background\&. This menu contains entries to explore the currently defined workspaces, windows, and add/remove/rename workspaces\&. +.PP +\fBIcons\fR: +.RS 4 +This menu shows any iconified (or, minimized) windows\&. Clicking on a window in this menu will raise it on the current workspace\&. +.RE +.PP +\fIWorkspaces\fR: +.RS 4 +The next section provides one submenu per workspace\&. Middle\-clicking on a workspace name will take you to that workspace\&. The submenu contains a list of all open windows on that workspace\&. Clicking on a window name will take you to that window and raise it, changing the active workspace if necessary\&. +.RE +.PP +\fBNew Workspace\fR: +.RS 4 +This entry adds a new workspace to the end of the list of current workspaces\&. +.RE +.PP +\fBEdit current workspace name\fR: +.RS 4 +Pops up a dialog to enter a new name for the current workspace\&. +.RE +.PP +\fBRemove Last\fR: +.RS 4 +Remove the last workspace in the list\&. Any windows curretly open there will be sent to the next\-to\-last workspace\&. +.RE +.SH "TOOLBAR" +.sp +The toolbar is a small area to display information like a clock, workspace name, a system tray or a taskbar (iconbar) that can contain the running programs\&. The color, look, font etc\&. is defined in the \fBSTYLE\fR\&. +.sp +The tools in the toolbar can be enabled/disabled in the `init\' file with the \fBsession\&.screen0\&.toolbar\&.tools\fR resource\&. See the \fBRESOURCES\fR section for details on how to alter this value\&. +.sp +The possible tools are: +.PP +\fBClock\fR: +.RS 4 +This will show an area to display a clock and the date according to the format specification listed in "man strtftime" +.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)\&. +.RE +.PP +\fBSystemtray\fR: +.RS 4 +The Systemtray can hold applications that are made to use it\&. +.RE +.PP +\fBWorkspaceName\fR: +.RS 4 +This displays the name of the current workspace\&. +.RE +.PP +\fBPrevWorkspace\fR: +.RS 4 +This displays an arrow that allows to switch to the workspace left of the current one\&. +.RE +.PP +\fBNextWorkspace\fR: +.RS 4 +This displays an arrow that allows to switch to the workspace right of the current one\&. +.RE +.PP +\fBPrevWindow\fR: +.RS 4 +This displays an arrow that switches focus to the previous visible window on the current workspace\&. +.RE +.PP +\fBNextWindow\fR: +.RS 4 +This displays an arrow that switches focus to the next visible window on the current workspace\&. +.RE +.sp +Other aspects of the toolbar can be configured in two ways: through the toolbar menu, which is accessable in the Configuration part of the RootMenu or with a right click on the edge the toolbar, or by editing the init file (see the \fBRESOURCES\fR section for more information about that)\&. +.SS "Toolbar Menu" +.sp +This menu can be opened by right\-clicking on the toolbar (though not on a window\'s name in the iconbar), or from the \fBConfiguration Menu\fR\&. +.sp +All changes take effect immediately\&. Here are the settings: +.PP +\fBVisible\fR: +.RS 4 +Sets the toolbar either to visible or invisible\&. +.RE +.PP +\fBAuto hide\fR: +.RS 4 +If this is enabled the toolbar will disappear after a defined time when the mouse pointer leaves the toolbar\&. It will slide in when the cursor hits the remaining edge of 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\&. +.RE +.PP +\fBMaximize Over\fR: +.RS 4 +Enabling this option will allow windows to maximize over the toolbar\&. With this switched on they will only expand to the edge of the bar\&. This option may be overridden by the \(lqFull Maximization\(rq from the +\fBConfiguration Menu\fR\&. If that option is enabled, this option will have no effect\&.\&. +.RE +.PP +\fBLayer\&...\fR: +.RS 4 +This sets the layer on which the toolbar is set\&. With this you can set the toolbar to "Always on top"\&. +.RE +.PP +\fBPlacement\fR: +.RS 4 +Sets the toolbar to any edge of the screen, either centered or aligned with a corner\&. +.RE +.PP +\fBAlpha\fR: +.RS 4 +This sets the alpha value for the toolbar\&. Use the left mouse button to decrease and the right mouse button to increase the value\&. 0 is invisible, 255 is not transparent at all\&. +.RE +.PP +\fBIconbar Mode\fR: +.RS 4 +Specifies various modes of the iconbar\'s operation\&. +.sp +The first section outlines what types of windows will be shown in the iconbar: +.PP +\fBNone\fR: +.RS 4 +Will not show any windows +.RE +.PP +\fBIcons\fR: +.RS 4 +Shows windows from all workspaces that are iconified (or, minimized) +.RE +.PP +\fBNoIcons\fR: +.RS 4 +Shows windows from all workspaces that are not iconified +.RE +.PP +\fBWorkspaceIcons\fR: +.RS 4 +Shows windows from the current workspace that are iconified +.RE +.PP +\fBWorkspaceNoIcons\fR: +.RS 4 +Shows windows from the current workspace that are not iconified +.RE +.PP +\fBWorkspace\fR: +.RS 4 +Shows all windows (iconified or not) from the current workspace +.RE +.PP +\fBAll Windows\fR: +.RS 4 +Shows all windows (iconified or not) from all workspaces +.RE +.sp +The next section specifies the alignment of the window names shown in the iconbar\&. The with is specified via the +\fBsession\&.screen0\&.iconbar\&.iconWidth\fR +resource: +.PP +\fBLeft\fR: +.RS 4 +All icons will be left\-aligned with the width set in the `init\' file +.RE +.PP +\fBRelative\fR: +.RS 4 +All icons will be sized evenly to fill the iconbar completely +.RE +.PP +\fBRight\fR: +.RS 4 +All icons will be right\-aligned with the width set in the `init\' file +.RE +.sp +The last option in this submenu is: +.PP +\fBShow Pictures\fR: +.RS 4 +If enabled the iconbar will show the application\'s icon (if provided by the application) +.RE +.RE +.PP +\fBClock\fR: +.RS 4 +Lets you switch between the 00:00am \- 11:59pm and 00:00 \- 23:59 notation +.RE +.PP +\fBEdit Clock Format\fR: +.RS 4 +clicking this entry will pop up a dialog window in which the clock format can be set according to +\fIman strftime\fR +(or +\fIman date\fR)\&. +.RE +.SH "FOCUS MODEL" +.sp +The Focus Model defines how windows gain focus (i\&.e\&. become the active window, which receives keyboard and mouse events)\&. The focus model can be changed in the configuration menu (usually located under \fIfluxbox menu\fR in the Root Menu\&. +.sp +There are two main aspects of the focus model: how windows gain focus and how tabs gain focus\&. Each of these has two options: focus follows mouse and click to focus\&. Focus follows mouse means that windows will gain focus when the mouse hovers over them\&. Click to focus means that windows will gain focus when the mouse clicks on them\&. +.sp +Thus, there are four main options when choosing a focus model\&. You should choose one of the first two and one of the last two\&. They are: +.PP +\fBClick To Focus\fR: +.RS 4 +Click to focus windows\&. +.RE +.PP +\fBMouse Focus\fR: +.RS 4 +Window focus follows mouse\&. +.RE +.PP +\fBClickTabFocus\fR: +.RS 4 +Click to focus tabs\&. +.RE +.PP +\fBMouseTabFocus\fR: +.RS 4 +Tab focus follows mouse\&. +.RE +.sp +There are three more settings in the \(lqFocus Model\(rq menu: +.PP +\fBFocus New Windows\fR: +.RS 4 +If enabled, a new window will grab X focus as soon as it is opened\&. +.RE +.PP +\fBAuto Raise\fR +.RS 4 +If enabled, focusing on a new window will automatically raise that window above all others within its layer\&. When disabled, you must explicitly raise a focused window using the window menu, keybinding, or +\fBClick Raises\fR\&. +.RE +.PP +\fBClick Raises\fR +.RS 4 +If enabled, clicking anywhere on a window will raise it above all others within its layer\&. +.RE +.SH "TAB OPTIONS" +.sp +This section of fluxbox configuration menu lets you configure many features of tabs\&. Inside of it there are three main options: +.PP +\fBPlacement\fR: +.RS 4 +You can choose where the external tabs will be positioned relative to the window\&. For these options to work, +\fITabs in Titlebar\fR +must be off\&. +.RE +.PP +\fBTabs in Titlebar\fR: +.RS 4 +When this option is on, tabs are fixed in window titlebar and the width varies according to the amount of windows grouped\&. +.RE +.PP +\fBMaximize Over\fR: +.RS 4 +When this option is on, maximizing a window will disregard the size and location of external tabs, which means they may be pushed out of the screen entirely\&. +.RE +.PP +\fBExternal Tab Width\fR: +.RS 4 +This specifies in pixels the width of external tabs\&. +.RE +.SH "STYLES" +.sp +fluxbox enables you to use specialized files that contain \fBX(1)\fR resources to specify colors, textures, pixmaps and fonts, and thus the overall look of your window borders, menus and the toolbar\&. +.sp +The default installation of fluxbox provides some of these style files\&. See \fBfluxbox\-style(5)\fR to accommodate the growing number of style components\&. +.SS "Style Overlay" +.sp +In addition to the style file, the overlay file, whose location is specified by \fBsession\&.screen0\&.styleOverlay\fR (default: \fB~/\&.fluxbox/overlay\fR) can be used to set style resources that override all styles\&. For more information about which parts of fluxbox can be controlled by the overlay file, see \fBfluxbox\-style(5)\fR\&. +.SH "THE SLIT" +.sp +The slit is a special fluxbox window frame that can contain dockable applications, such as \(lqbbtools\(rq or \(lqwindow maker dockapps\(rq\&. +.sp +When applications are run in the slit they have no window borders of their own; instead they are framed in the slit, and they are always visible in the current workspace\&. +.sp +Most dockable applications use the \-w option to run in the slit\&. For example, you could put in your \fB~/\&.fluxbox/startup\fR: +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +bbmail \-w & +bbpager \-w & +wmdrawer & +exec fluxbox +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.sp +To use the slit you must have it compiled into fluxbox\&. This is the default setting\&. +.SS "Slit Menu" +.sp +This menu can be opened by right\-clicking on the slit (though not on an application running within the slit), or from the \fBConfiguration Menu\fR\&. +.sp +All changes take effect immediately\&. Here are the settings: +.PP +\fBPlacement\fR: +.RS 4 +This lets you set the position of the slit\&. +.RE +.PP +\fBLayer\fR: +.RS 4 +See +\fBLAYERS\fR +for details on the layer order\&. +.RE +.PP +\fBAuto hide\fR: +.RS 4 +If this is enabled the slit will disappear after a defined time when the mouse pointer leaves the slit\&. It will slide in when the cursor hits the remaining edge of 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 +\fBConfiguration Menu\fR\&. If that option is enabled, this option will have no effect\&.\&. +.RE +.PP +\fBAlpha\fR: +.RS 4 +This sets the alpha value for the slit\&. Use the left mouse button to decrease and the right mouse button to increase the value\&. 0 is invisible, 255 is not transparent at all\&. +.RE +.PP +\fBClients\fR: +.RS 4 +This submenu lets you reorder the the applications running in the slit\&. You are able to hide apps from the slit by unselecting them in the list showing\&. This will not kill the app\&. You can make them re\-appear by selecting them in the list\&. The "Save SlitList" option saves the new order to you slitlist located in +\fB~/\&.fluxbox/slitlist\fR\&. See the next section for details\&. +.RE +.SS "Slitlist File" +.sp +fluxbox\'s slitlist file is available for those that use dockapps in the slit\&. This file helps fluxbox keep track of the \fBorder\fR of the dockapps when in the slit\&. The file is generally located at \fB~/\&.fluxbox/slitlist\fR\&. +.sp +A simple procedure for getting the slit sequences the way you like it is: 1\&. Run fluxbox with no pre\-loaded dockapps 2\&. Run dockapps individually in the order you want them 3\&. Add dockapps to your \fBstartfluxbox(1)\fR script +.sp +This sequence will be saved by default to \fB~/\&.fluxbox/slitlist\fR and will be remembered for future instances of fluxbox\&. +.sp +Users are free to manually edit the slitlist file\&. It is a simple list of window names, as given by \fBxprop(1)\fR, one per dockapp\&. Similar to the init file it should not be edited while fluxbox is running\&. Otherwise changes may get overwritten\&. +.sp +The user also has the option of choosing a different path for the slitlist file, by setting the \fBsession\&.session0\&.slitlistFile\fR resource\&. +.SH "LAYERS" +.sp +Layers affect the way that windows will overlap each other on the screen\&. Windows on a higher layer will always appear above those on a lower one, whether they are focused or not\&. By default, fluxbox uses 13 layers, starting from 1 (highest)\&. The total number of layers can be changed by using the \fBsession\&.numLayers\fR resource\&. +.sp +There are two ways to assign a window to a different layer\&. When the window is open, you may select the layer in the `Layer \&...\' submenu of the window menu\&. The menu gives six choices for the layer, which fluxbox manages by name\&. The names are (from highest to lowest layer): +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +2 \- Above Dock +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +4 \- Dock +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +6 \- Top +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +8 \- Normal +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +10 \- Bottom +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +12 \- Desktop +.RE +.sp +The other way to set the layer for a window is through the `apps\' file\&. This method is described in \fBfluxbox\-apps(5)\fR\&. +.SH "RESOURCES" +.sp +Usually the \fB~/\&.fluxbox/init\fR resource file is created and maintained by fluxbox itself\&. You can use the \fBConfigure Menu\fR, mentioned above, to set most of these options\&. However, we\'ll cover all of the resource options that are available to the user\&. If you edit this file while fluxbox is running, you must \(lqreconfigure\(rq to reload the resource options\&. +.sp +When running fluxbox in a multiple\-screen environment the screen0 key can also be screen1, screen2, to customize the behavior of fluxbox on each desktop accordingly\&. Here are the resources that are currently available: +.PP +\fBsession\&.screen0\&.window\&.{focus|unfocus}\&.alpha\fR: \fIinteger\fR +.RS 4 +These resources are available to the user to set different levels of transparency for different components of fluxbox\&. Each one accepts a value between 0\-255, 255 being opaque and 0 being completely transparent\&. +.sp +Default: +\fB255\fR +.RE +.PP +\fBsession\&.screen0\&.{slit|toolbar}\&.autoHide\fR: \fIboolean\fR +.RS 4 +The autoHide resources allow the user to set the behavior of the toolbar and slit\&. This behavior can be that they disappear when they are not being used actively by the user, or they remain visible at all times\&. +.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\&. +.sp +Default: +\fBDock\fR +.RE +.PP +\fBsession\&.screen0\&.{slit|toolbar}\&.placement\fR: \fIplacement\fR +.RS 4 +These allow users to place the slit and toolbar where they like\&. +.PP +Possible options are: +.RS 4 + +\fBBottomLeft\fR +\fBBottomCenter\fR +\fBBottomRight\fR +\fBLeftBottom\fR +\fBLeftCenter\fR +\fBLeftTop\fR +\fBRightBottom\fR +\fBRightCenter\fR +\fBRightTop\fR +\fBTopLeft\fR +\fBTopCenter\fR +\fBTopRight\fR +.RE +.sp +Slit default: +\fBTopRight\fR +.sp +Toolbar default: +\fBBottomCenter\fR +.RE +.PP +\fBsession\&.screen0\&.{slit|toolbar|tabs}\&.maxOver\fR: \fIboolean\fR +.RS 4 +Setting these to True will allow application windows to maximize over the complete screen\&. Setting to False allows the slit, toolbar, and external tabs to hold their territory and will always be visible when an application is maximized\&. +.sp +Default: +\fBFalse\fR +.RE +.PP +\fBsession\&.screen0\&.toolbar\&.height\fR: \fIinteger\fR +.RS 4 +Set the height of the toolbar\&. If the value is set to 0, the style file will gain control over the toolbar height\&. It is possible to set a fixed height by changing this value to something greater than 0\&. +.sp +Default: +\fB0\fR +.RE +.PP +\fBsession\&.screen0\&.toolbar\&.visible\fR: \fIboolean\fR +.RS 4 +The user can set whether they want to have a toolbar on screen at all\&. Setting to False removes the toolbar from the screen\&. +.sp +Default: +\fBTrue\fR +.RE +.PP +\fBsession\&.screen0\&.toolbar\&.widthPercent\fR: \fIinteger\fR +.RS 4 +This resource sets the width percentage of the toolbar on the screen\&. +.sp +Default: +\fB100\fR +.RE +.PP +\fBsession\&.screen0\&.toolbar\&.tools\fR: \fItools\fR +.RS 4 +This resource specifies the tools plugged into the toolbar\&. Read the TOOLBAR section in this manual for a description of each of these\&. They may be specified in any order, delimited by the +\fB,\fR +character\&. They will appear in the order given\&. +.PP +Possible tools: +.RS 4 + +\fBclock\fR +\fBiconbar\fR +\fBnextwindow\fR +\fBprevwindow\fR +\fBnextworkspace\fR +\fBprevworkspace\fR +\fBsystemtray\fR +\fBworkspacename\fR +.RE +.PP +Default: +.RS 4 + +\fBworkspacename, prevworkspace, nextworkspace, iconbar, prevwindow, nextwindow, systemtray, clock\fR +.RE +.RE +.PP +\fBsession\&.screen0\&.{slit|toolbar}\&.onhead\fR: \fIinteger\fR +.RS 4 +For those that use xinerama, users can set this value to the number of the head where they would like to see the slit and toolbar, starting from 1\&. Setting this to 0 will ignore xinerama information\&. +.sp +Default: +\fB0\fR +.RE +.PP +\fBsession\&.screen0\&.iconbar\&.mode\fR: \fIpattern\fR +.RS 4 +This determines which windows will be displayed in the iconbar\&. Any window pattern is acceptable\&. See the section +\fBCLIENT PATTERNS\fR +in either +\fBfluxbox\-keys(5)\fR +or +\fBfluxbox\-apps(5)\fR +for details\&. +.sp +Default: +\fB{static groups} (workspace)\fR +.RE +.PP +\fBsession\&.screen0\&.iconbar\&.usePixmap\fR: \fIboolean\fR +.RS 4 +This is also set in the Iconbar Mode menu\&. When set to True, this will show the native icon of applications\&. +.sp +Default: +\fBTrue\fR +.RE +.PP +\fBsession\&.screen0\&.iconbar\&.iconTextPadding\fR: \fIinteger\fR +.RS 4 +This specifies the space between the window title and the edge of the button\&. +.sp +Default: +\fB10\fR +.RE +.PP +\fBsession\&.screen0\&.iconbar\&.alignment\fR: \fIposition\fR +.RS 4 +This value should be changed in the Iconbar Mode menu\&. +.PP +Available options: +.RS 4 + +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBLeft\fR: Fixed width, aligned left +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBRelative\fR: Width varies to fill the iconbar +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBRight\fR: Fixed width, aligned right +.RE +.RE +.sp +Default: +\fBRelative\fR +.RE +.PP +\fBsession\&.screen0\&.iconbar\&.iconWidth\fR: \fIinteger\fR +.RS 4 +Used to specify the iconbar button width for Left/Right alignment\&. +.sp +Default: +\fB128\fR +.RE +.PP +\fBsession\&.screen0\&.strftimeFormat\fR: \fIdate\fR +.RS 4 +This adjusts the way the current time is displayed in the toolbar\&. The +\fBstrftime(3)\fR +format is used\&. +.sp +Default: +\fB%I:%M %p\fR +.RE +.PP +\fBsession\&.screen0\&.tabs\&.intitlebar\fR: \fIboolean\fR +.RS 4 +This specifies whether tabs should be embedded in the titlebar or placed outside the window\&. +.sp +Default: +\fBTrue\fR +.RE +.PP +\fBsession\&.screen0\&.tab\&.placement\fR: \fIplacement\fR +.RS 4 +This specifies where external tabs will appear on the window\&. It has the same possible values as +\fBsesion\&.screen0\&.{slit|toolbar}\&.placement\fR\&. +.sp +Default: +\fBTopLeft\fR +.RE +.PP +\fBsession\&.screen0\&.tab\&.width\fR: \fIinteger\fR +.RS 4 +This specifies the width of external tabs in pixels\&. +.sp +Default: +\fB64\fR +.RE +.PP +\fBsession\&.screen0\&.focusModel\fR: \fBClickToFocus|MouseFocus\fR +.RS 4 +This controls how windows gain focus via the mouse\&. With `ClickToFocus\', the user must click on the window\&. With `MouseFocus\', windows gain focus whenever the mouse moves over them\&. +.sp +Default: +\fBClickToFocus\fR +.RE +.PP +\fBsession\&.screen0\&.autoRaise\fR: \fIboolean\fR +.RS 4 +When True, this setting automatically raises any window that gains focus\&. +.sp +Default: +\fBTrue\fR +.RE +.PP +\fBsession\&.autoRaiseDelay\fR: \fIinteger\fR +.RS 4 +Adjusts the delay (in milli\-sec) before focused windows will raise when using the Autoraise option\&. +.sp +Default: +\fB250\fR +.RE +.PP +\fBsession\&.screen0\&.clickRaises\fR: \fIboolean\fR +.RS 4 +This setting allows a user to click anywhere on a window to bring it on top of other windows\&. Otherwise, only the titlebar will work\&. +.sp +Default: +\fBTrue\fR +.RE +.PP +\fBsession\&.screen0\&.workspacewarping\fR: \fIboolean\fR +.RS 4 +This setting enables a user to change workspaces by dragging a window across the edge of the screen\&. +.sp +Default: +\fBTrue\fR +.RE +.PP +\fBsession\&.screen0\&.showwindowposition\fR: \fIboolean\fR +.RS 4 +Setting this resource to True shows the user, in a little window, the exact position of the application window while the user is dragging it\&. Allows a precise placement of windows on a screen\&. +.sp +Default: +\fBTrue\fR +.RE +.PP +\fBsession\&.screen0\&.defaultDeco\fR: \fIstring\fR +.RS 4 +This specifies the default window decorations, according to the same options available to the +\fB[Deco]\fR +option in the `apps\' file, described in +\fBfluxbox\-apps(5)\fR\&. +.sp +Default: +\fBNORMAL\fR +.RE +.PP +\fBsession\&.screen0\&.menuDelay\fR: \fIinteger\fR +.RS 4 +This sets the delay in milliseconds for submenus to open when you hover over them or to close when you hover over another item\&. +.sp +Default: +\fB200\fR +.RE +.PP +\fBsession\&.screen0\&.focusNewWindows\fR: \fIboolean\fR +.RS 4 +This sets whether or not new windows will become focused automatically\&. +.sp +Default: +\fBTrue\fR +.RE +.PP +\fBsession\&.screen0\&.workspaceNames\fR: \fInames\fR +.RS 4 +Here is where the user can name their workspaces, in a comma\-delimited list\&. However it is recommended to use the tool available in the Workspace Menu to set these\&. +.sp +Default: +\fBone, two, three, four\fR +.RE +.PP +\fBsession\&.screen0\&.edgeSnapThreshold\fR: \fIinteger\fR +.RS 4 +When moving a window across your screen, fluxbox is able to have it `snap\' 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: +\fB10\fR +.RE +.PP +\fBsession\&.screen0\&.windowPlacement\fR: \fIstrategy\fR +.RS 4 +This resource specifies where to place new windows when not otherwise specified (by the program or the `apps\' file, for example)\&. +.PP +Available strategies: +.RS 4 + +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +RowSmartPlacement: tries to place windows in rows without overlapping +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +ColSmartPlacement: tries to place windows in columns without overlapping +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +CascadePlacement: places windows below the titlebar of the previous one +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +UnderMousePlacement: places new windows underneath the mouse +.RE +.RE +.sp +Default: +\fBRowSmartPlacement\fR +.RE +.PP +\fBsession\&.screen0\&.rowPlacementDirection\fR: \fBLeftToRight\fR|\fBRightToLeft\fR +.RS 4 +These settings control the direction in which windows are tiled using the RowSmartPlacement and ColSmartPlacement strategies described above\&. +.sp +Default: +\fBLeftToRight\fR +.RE +.PP +\fBsession\&.screen0\&.colPlacementDirection\fR: \fBTopToBottom\fR|\fBBottomToTop\fR +.RS 4 +These settings control the direction in which windows are tiled using the RowSmartPlacement and ColSmartPlacement strategies described above\&. +.sp +Default: +\fBTopToBottom\fR +.RE +.PP +\fBsession\&.screen0\&.fullMaximization\fR: \fIboolean\fR +.RS 4 +If this setting is enabled, windows will maximize over the toolbar, slit, and any other window that creates a strut, no matter what their individual settings are\&. +.sp +Default: +\fBFalse\fR +.RE +.PP +\fBsession\&.screen0\&.opaqueMove\fR: \fIboolean\fR +.RS 4 +When moving a window, setting this to True will draw the window contents as it moves (this is nasty on slow systems)\&. If False, it will only draw an outline of the window border\&. +.sp +Default: +\fBTrue\fR +.RE +.PP +\fBsession\&.screen0\&.workspaces\fR: \fIinteger\fR +.RS 4 +Set this to the number of workspaces the users wants\&. +.sp +Default: +\fB4\fR +.RE +.PP +\fBsession\&.cacheLife\fR: \fIminutes\fR +.RS 4 +This tells fluxbox how long unused pixmaps may stay in the X server\'s memory\&. +.sp +Default: +\fB5\fR +.RE +.PP +\fBsession\&.cacheMax\fR: \fIKbSize\fR +.RS 4 +This tells fluxbox how much memory it may use to store cached pixmaps on the X server\&. If your machine runs short of memory, you may lower this value\&. +.sp +Default: +\fB200\fR +.RE +.PP +\fBsession\&.colorsPerChannel\fR: \fIinteger\fR +.RS 4 +This tells fluxbox how many colors to take from the X server on pseudo\-color displays\&. A channel would be red, green, or blue\&. fluxbox will allocate this variable ^ 3 and make them always available\&. Value must be between 2\-6\&. When you run fluxbox on an 8bpp display, you must set this resource to 4\&. +.sp +Default: +\fB4\fR +.RE +.PP +\fBsession\&.doubleClickInterval\fR: \fIinteger\fR +.RS 4 +Adjust the delay in milliseconds between mouse clicks for fluxbox to consider a double click\&. +.sp +Default: +\fB250\fR +.RE +.PP +\fBsession\&.forcePseudoTransparency\fR: \fIboolean\fR +.RS 4 +If you have Xorg\'s composite extension enabled, this setting will force the menu, windows, toolbar, and slit to use pseudo\-transparency instead of true transparency\&. +.sp +Default: +\fBFalse\fR +.RE +.PP +\fBsession\&.ignoreBorder\fR: \fIboolean\fR +.RS 4 +This configures the ability to move windows by dragging the border\&. +.sp +Default: +\fBFalse\fR +.RE +.PP +\fBsession\&.tabPadding\fR: \fIinteger\fR +.RS 4 +This specifies the spacing between tabs\&. +.sp +Default: +\fB0\fR +.RE +.PP +\fBsession\&.tabsAttachArea\fR: \fBWindow|Titlebar\fR +.RS 4 +With this set to `Window\', windows may be grouped by dragging one tab with the middle mouse button and dropping it anywhere on another window\&. With `Titlebar\', the user must drop the tab on the target window\'s titlebar\&. +.sp +Default: +\fBWindow\fR +.RE +.PP +\fBsession\&.titlebar\&.{left|right}\fR: \fIbuttons\fR +.RS 4 +The buttons or icons to place in the titlebar of decorated windows\&. You may specify any number, space\-delimited\&. +.PP +The available options are: +.RS 4 + +\fBClose\fR +\fBMaximize\fR +\fBMenuIcon\fR +\fBMinimize\fR +\fBShade\fR +\fBStick\fR +.RE +.sp +Default left: +\fBStick MenuIcon\fR +.sp +Default right: +\fBShade Minimize Maximize Close\fR +.RE +.sp +All of the \fIlocation\fR resources following require a pathname to their specific files\&. This is where you can specify different files\&. Most of the defaults will be located in the user\'s \fB~/\&.fluxbox\fR directory\&. +.PP +\fBsession\&.appsFile\fR: \fIlocation\fR +.RS 4 +Location of persistent application settings, or the `apps\' file\&. See the +\fBRemember\&...\fR +item in the +\fBWindow Menu\fR +section above or +\fBfluxbox\-apps(5)\fR +for details\&. +.RE +.PP +\fBsession\&.groupFile\fR: \fIlocation\fR +.RS 4 +Deprecated, auto\-grouping is now done in the `apps\' file, see +\fBfluxbox\-apps(5)\fR +for details\&. +.RE +.PP +\fBsession\&.keyFile\fR: \fIlocation\fR +.RS 4 +Location of the keyboard mapping settings, or the `keys\' file\&. See +\fBfluxbox\-keys(5)\fR +for details\&. +.RE +.PP +\fBsession\&.menuFile\fR: \fIlocation\fR +.RS 4 +Location of the Root Menu file\&. See +\fBfluxbox\-menu(5)\fR +for details\&. +.RE +.PP +\fBsession\&.slitlistFile\fR: \fIlocation\fR +.RS 4 +Location of the file used to remember slit client ordering\&. See +\fBSLIT\fR +above for details\&. +.RE +.PP +\fBsession\&.styleFile\fR: \fIlocation\fR +.RS 4 +Location of the currently selected style\&. See +\fBfluxbox\-style(5)\fR +for details\&. +.RE +.PP +\fBsession\&.styleOverlay\fR: \fIlocation\fR +.RS 4 +Location of the style overlay file\&. See +\fBfluxbox\-style(5)\fR +for details\&. +.RE +.PP +\fBsession\&.screen0\&.windowMenu\fR: \fIlocation\fR: +.RS 4 +This optionally specifies the location of a user\-defined window menu\&. If left blank, it will use +\fB~/\&.fluxbox/windowmenu\fR\&. +.sp +Default: +\fBblank\fR +.RE +.SH "ENVIRONMENT" +.PP +\fBHOME\fR +.RS 4 +fluxbox uses +\fB$HOME\fR +to find the \&.fluxbox/init file and to resolve style file and \-directory names\&. +.RE +.PP +\fBDISPLAY\fR +.RS 4 +When no other display was given on the command line, fluxbox will start on the display specified by this variable\&. +.RE +.sp +fluxbox can also take advantage of other environment variables if they are set before fluxbox is started\&. For example, if $TERM is set, then it will be available whenever fluxbox uses the shell, such as the `keys\' file \fBExecCommand\fR or the root menu\'s \fB[exec]\fR tag\&. See \fBfluxbox\-keys(5)\fR and \fBfluxbox\-menu(5)\fR for details\&. +.sp +The `keys\' file also provides two commands that can alter the current environment of fluxbox: \fBSetEnv\fR and \fBExport\fR\&. Any changes made by these commands will also affect the environment as seen by fluxbox and all child processes started after that point\&. See \fBfluxbox\-keys(5)\fR for details\&. +.sp +For more information about environment variables in general, see your shell\'s manual\&. +.SH "SIGNALS" +.sp +fluxbox responds to the following signals: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +SIGHUP fluxbox loads the configuration\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +SIGUSR1 Forces reloading of configuration\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +SIGUSR2 Forces reloading of menu file\&. +.RE +.SH "AUTHORS" +.sp +fluxbox is written and maintained by Henrik Kinnunen <fluxgen at fluxbox org>, Simon Bowden <rathnor at fluxbox org>, Mathias Gumz <akira at fluxbox org>, and Mark Tiefenbruck <mark at fluxbox org>, with contributions and patches merged from many individuals around the world\&. +.sp +Blackbox was written and maintained by Brad Hughes <blackbox at alug org> and Jeff Raven <jraven at psu edu>\&. +.sp +This manpage is the combined work of: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Jim Ramsay <i\&.am at jimramsay com> (>fluxbox\-1\&.0\&.0) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Curt Micol <asenchi at asenchi com> (>fluxbox\-0\&.9\&.11) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Tobias Klausmann <klausman at users sourceforge net> (\(lafluxbox\-0\&.9\&.11) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Grubert <grubert at users sourceforge net> (fluxbox) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Matthew Hawkins <matt at mh dropbear id au> (blackbox) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Wilbert Berendsen <wbsoft at xs4all nl> (blackbox) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Numerous other languages could be available if someone jumps in\&. +.RE +.SH "ONLINE DOCUMENTATION" +.sp +The Official fluxbox website: \m[blue]\fBhttp://www\&.fluxbox\&.org\fR\m[] +.sp +The Official fluxbox wiki: \m[blue]\fBhttp://www\&.fluxbox\-wiki\&.org\fR\m[] +.sp +Many compatible themes: \m[blue]\fBhttp://tenr\&.de\fR\m[] +.SH "BUGS" +.sp +If you find any bugs, please visit the #fluxbox irc channel on irc\&.freenode\&.net or submit them to the bug tracker at \m[blue]\fBhttp://sf\&.net/projects/fluxbox\fR\m[] \&. Or you may subscribe to one of the mailinglists\&. More information can be found on the official website\&. +.SH "SEE ALSO" +.sp +fluxbox\-apps(5) fluxbox\-keys(5) fluxbox\-style(5) fluxbox\-menu(5) fluxbox\-remote(1) fbsetroot(1) fbsetbg(1) fbrun(1) startfluxbox(1)
A doc/fluxbox-apps.5

@@ -0,0 +1,759 @@

+.\" Title: fluxbox-apps +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> +.\" Date: 02/10/2009 +.\" Manual: Fluxbox Manual +.\" Source: fluxbox-apps.txt 1.1.1 +.\" Language: English +.\" +.TH "FLUXBOX\-APPS" "5" "02/10/2009" "fluxbox\-apps\&.txt 1\&.1\&.1" "Fluxbox Manual" +.\" ----------------------------------------------------------------- +.\" * (re)Define some macros +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" toupper - uppercase a string (locale-aware) +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de toupper +.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ +\\$* +.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH-xref - format a cross-reference to an SH section +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de SH-xref +.ie n \{\ +.\} +.toupper \\$* +.el \{\ +\\$* +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH - level-one heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SH +.\" put an extra blank line of space above the head in non-TTY output +.if t \{\ +.sp 1 +.\} +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[an-margin]u +.ti 0 +.HTML-TAG ".NH \\n[an-level]" +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +\." make the size of the head bigger +.ps +3 +.ft B +.ne (2v + 1u) +.ie n \{\ +.\" if n (TTY output), use uppercase +.toupper \\$* +.\} +.el \{\ +.nr an-break-flag 0 +.\" if not n (not TTY), use normal case (not uppercase) +\\$1 +.in \\n[an-margin]u +.ti 0 +.\" if not n (not TTY), put a border/line under subheading +.sp -.6 +\l'\n(.lu' +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SS - level-two heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SS +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[IN]u +.ti \\n[SN]u +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.ps \\n[PS-SS]u +\." make the size of the head bigger +.ps +2 +.ft B +.ne (2v + 1u) +.if \\n[.$] \&\\$* +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BB/BE - put background/screen (filled box) around block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BB +.if t \{\ +.sp -.5 +.br +.in +2n +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EB +.if t \{\ +.if "\\$2"adjust-for-leading-newline" \{\ +.sp -1 +.\} +.br +.di +.in +.ll +.gcolor +.nr BW \\n(.lu-\\n(.i +.nr BH \\n(dn+.5v +.ne \\n(BHu+.5v +.ie "\\$2"adjust-for-leading-newline" \{\ +\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.el \{\ +\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.in 0 +.sp -.5v +.nf +.BX +.in +.sp .5v +.fi +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BM/EM - put colored marker in margin next to block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BM +.if t \{\ +.br +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EM +.if t \{\ +.br +.di +.ll +.gcolor +.nr BH \\n(dn +.ne \\n(BHu +\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] +.in 0 +.nf +.BX +.in +.fi +.\} +.. +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "Name" +fluxbox-apps \- per\-window attribute configuration for fluxbox(1) +.SH "Synopsis" +.sp +~/\&.fluxbox/apps +.SH "SYNTAX" +.sp +Variable parameters are shown in emphasis: \fIargument\fR +.sp +All other characters shown are required verbatim\&. Whitespce is only required to delimit words, but it is fine to add more whitespace\&. +.SH "DESCRIPTION" +.sp +It is possible to force an application to always have the same dimensions, position, and other settings when it is first launched\&. These settings are saved in the `apps\' file\&. +.sp +Most simple settings can be saved using the `Remember\' submenu of the window menu, which can usually be opened with a right\-click on the titlebar\&. More advanced features require manually editing the `apps\' file\&. This may include using \fBGROUP SECTIONS\fR to set up automatic window tab groups\&. +.sp +The file is made up of two main types of sections, apps and groups, detailed below\&. +.SH "APP SECTIONS" +.sp +\fB[app]\fR sections provide settings for individual application windows\&. +.PP +These sections begin with a line of the format: +.RS 4 + +\fB[app]\fR +\fB(\fR\fIpattern\fR\fB)\fR +\fB{\fR\fIcount\fR\fB}\fR +.RE +.sp +The \fIpattern\fR can be one or more patterns which match windows\&. For more details, see \fBCLIENT PATTERNS\fR\&. If you specify more than one \fIpattern\fR, they must ALL match for the settings to be applied\&. +.sp +The \fB{\fR\fIcount\fR\fB}\fR is optional\&. If specified, then the entry will only match at most that many windows at any time\&. If omitted, the default is to apply the settings to all matching windows\&. +.sp +This opening \fB[apps]\fR line is followed by any number of settings for the application\&. See \fBSETTINGS\fR for more details\&. +.PP +Each of these sections ends with the single line: +.RS 4 + +\fB[end]\fR +.RE +.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\&. +.PP +These sections begin with a line of the format: +.RS 4 + +\fB[group]\fR +\fB(\fR\fIpattern\fR\fB)\fR +.RE +.sp +Where the \fIpattern\fR item is optional\&. If specified, this pattern must match for the group to take effect\&. It is common to use non\-window\-specific patterns such as \fB(workspace)\fR here\&. See \fBCLIENT PATTERNS\fR for more details\&. +.sp +This is followed by any number of \fB[app]\fR lines\&. These have a simiar format to the \fB[app]\fR section detailed above in \fBAPP SECTIONS\fR, but do not contain any settings and do not have an associated \fB[end]\fR line\&. +.PP +Like this: +.RS 4 + +\fB[app]\fR +\fB(\fR\fIpattern\fR\fB)\fR +.RE +.sp +This section may also contain settings that are applied to every window in the group\&. See the \fBSETTINGS\fR section for details\&. +.PP +As with \fB[app]\fR sections, each of these sections ends with the single line: +.RS 4 + +\fB[end]\fR +.RE +.SH "SETTINGS" +.sp +These settings may be stored in the `apps\' file\&. A settings line must appear inside either an \fB[app]\fR or \fB[group]\fR section\&. +.PP +The general format is: +.RS 4 + +\fB[\fR\fIsetting\fR\fB]\fR +\fB{\fR\fIvalue\fR\fB}\fR +.RE +.sp +All allowed values are described below, except for \fIbool\fR which can simply have the value \fByes\fR or \fBno\fR, which enables or disables the associated setting, respectively\&. +.PP +\fB[Workspace]\fR {\fInumber\fR} +.RS 4 +Forces the application to open on the +\fInumber\fR +workspace specified\&. Workspaces are set by number, beginning with 0\&. +.RE +.PP +\fB[Jump]\fR {\fIbool\fR} +.RS 4 +Changes the active workspace to the remembered one when the application is opened\&. This is only useful when used in conjunction with +\fI[Workspace]\fR\&. See +\fBEXAMPLES\fR\&. +.RE +.PP +\fB[Head]\fR {\fInumber\fR} +.RS 4 +Forces the application to open on the +\fInumber\fR +head specified (Xinerama only)\&. +.RE +.PP +\fB[Layer]\fR {\fInumber\fR} +.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} +.RS 4 +Opens the application with the specified +\fIwidth\fR +and +\fIheight\fR, in pixels\&. +.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 +\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\&. +.PP +\fIanchor\fR may be set to one of: +.RS 4 + +\fBTopLeft Left BottomLeft Top Center Bottom TopRight Right BottomRight\fR +.RE +.RE +.PP +\fB[Deco]\fR {\fIvalue\fR} +.RS 4 +.PP +Specify the decoration state\&. There are several predefined \fIvalue\fR sets: +.RS 4 +.PP +\fBNORMAL\fR +.RS 4 +Standard decorations +.RE +.PP +\fBNONE\fR +.RS 4 +No decorations +\fBTAB\fR +Like TAB except keep the tabs +.RE +.PP +\fBBorder\fR +.RS 4 +Like NONE except keep the X window border +.RE +.PP +\fBTINY\fR +.RS 4 +Titlebar with only an iconify button +.RE +.PP +\fBTOOL\fR +.RS 4 +Titlebar only +.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\&. +.RE +.RE +.PP +\fB[Shaded]\fR {\fIbool\fR} +.RS 4 +Whether the window is Shaded (rolled\-up) or not\&. +.RE +.PP +\fB[Tab]\fR {\fIbool\fR} +.RS 4 +Whether the window has tabs enabled\&. +.RE +.PP +\fB[FocusHidden]\fR {\fIbool\fR} +.RS 4 +If enabled, the window will not appear in +\fINextWindow\fR/\fIPrevWindow\fR +lists\&. +.RE +.PP +\fB[IconHidden]\fR {\fIbool\fR} +.RS 4 +If enabled, the window will not appear in the icon area of the toolbar\&. +.RE +.PP +\fB[Hidden]\fR {\fIbool\fR} +.RS 4 +A shortcut for setting both +\fBFocusHidden\fR +and +\fBIconHidden\fR +at the same time\&. +.RE +.PP +\fB[Sticky]\fR {\fIbool\fR} +.RS 4 +Specify if an application should be sticky (shown on all workspaces) or not\&. +.RE +.PP +\fB[Minimized]\fR {\fIbool\fR} +.RS 4 +Application should start minimized +.RE +.PP +\fB[Maximized]\fR {\fIvalue\fR} +.RS 4 +.PP +Application should start maximized\&. \fIvalue\fR may be: +.RS 4 +.PP +\fByes\fR +.RS 4 +Fully maximized +.RE +.PP +\fBhorz\fR +.RS 4 +Horizontally maximized +.RE +.PP +\fBvert\fR +.RS 4 +Vertically maximized +.RE +.PP +\fBno\fR +.RS 4 +Not maximized +.RE +.RE +.RE +.PP +\fB[Fullscreen]\fR {\fIbool\fR} +.RS 4 +Application should start in fullscreen mode (fully maximized without any decorations)\&. +.RE +.PP +\fB[Close]\fR {\fIbool\fR} +.RS 4 +Save settings on close\&. By default, application settings are not updated when a window is closed\&. +.RE +.PP +\fB[Alpha]\fR {\fIvalue\fR [\fIvalue\fR]} +.RS 4 +Set the alpha value for this window\&. If two values are given, they correspond to the focused and unfocused transparency, respectively\&. One number only will be used for both values\&. +\fIvalue\fR +is an integer between 0 and 255\&. +.RE +.SH "CLIENT PATTERNS" +.PP +A \fIpattern\fR looks like this: +.RS 4 + +\fB(\fR[\fIpropertyname\fR[!]=]\fIregexp\fR\fB)\fR +\&... +.RE +.sp +Match definitions are enclosed in parentheses \fB(\fR\&...\fB)\fR, and if no \fIpropertyname\fR is given then \fBName\fR is assumed\&. The \fIregexp\fR can contain any regular expression, or the special value \fB[current]\fR, which matches the corresponding value of the currently focused window\&. See \fIregex(7)\fR for more information on acceptable regular expressions\&. +.sp +\fIpropertyname\fR is not case sensitive, whereas the \fIregexp\fR is\&. +.sp +If you specify multiple \fB(\fR\fB\fIpattern\fR\fR) arguments, this implies an AND condition \- All specified patterns must match\&. +.sp +You can use \fB=\fR to test for equality or \fB!=\fR to test for inequality\&. +.PP +The following values are accepted for \fIpropertyname\fR: +.RS 4 +.PP +\fBName\fR +.RS 4 +A string, corresponding to the CLASSNAME property (The first field of WM_CLASS from the output of the +\fBxprop(1)\fR +utility)\&. +.RE +.PP +\fBClass\fR +.RS 4 +A string, corresponding to the CLASSCLASS property (The second field of WM_CLASS from the output of the +\fBxprop(1)\fR +utility)\&. +.RE +.PP +\fBTitle\fR +.RS 4 +A string, corresponding to the window title (WM_NAME from +\fBxprop(1)\fR)\&. +.RE +.PP +\fBRole\fR +.RS 4 +A string, corresponding to the ROLE property (WM_WINDOW_ROLE from +\fBxprop(1)\fR)\&. +.RE +.PP +\fBTransient\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is transient (typically, a popup dialog) or not\&. +.RE +.PP +\fBMaximized\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is maximized 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 +\fBShaded\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is shaded or not\&. +.RE +.PP +\fBStuck\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is sticky (on all workspaces) or not\&. +.RE +.PP +\fBFocusHidden\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window has asked to be left off the focus list (or, the alt\-tab list), or not\&. +.RE +.PP +\fBIconHidden\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window has asked to be left off the icon list (or, the taskbar), or not\&. +.RE +.PP +\fBUrgent\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window has the urgent hint set\&. +.RE +.PP +\fBWorkspace\fR +.RS 4 +A number corresponding to the workspace number to which the window is attached\&. The first workspace here is +\fB0\fR\&. You may also use +\fB[current]\fR +to match the currently visible workspace\&. +.RE +.PP +\fBWorkspaceName\fR +.RS 4 +A string corresponding to the name of the workspace to which the window is attached\&. +.RE +.PP +\fBHead\fR +.RS 4 +The number of the display head to which the window is attached\&. You may match this against the special value +\fB[mouse]\fR +which refers to the head where the mouse pointer currently resides\&. +.RE +.PP +\fBLayer\fR +.RS 4 +The string name of the window\'s layer, which is one of +\fBAboveDock\fR, +\fBDock\fR, +\fBTop\fR, +\fBNormal\fR, +\fBBottom\fR, +\fBDesktop\fR +.RE +.RE +.PP +\fBExample\ \&1.\ \&Matches any windows with the CLASSNAME of "xterm"\fR +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +(xterm) +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&2.\ \&Matches any windows with the same CLASSNAME as the currently focused window\fR +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +(Name=[current]) +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&3.\ \&Matches any windows on the same head as the mouse but on a different layer than the currently focused window\fR +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +(Head=[mouse]) (Layer!=[current]) +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.SH "FILES" +.PP +\fB~/\&.fluxbox/apps\fR +.RS 4 +This is the default location for the application settings\&. +.RE +.SH "RESOURCES" +.PP +\fBsession\&.appsFile:\fR \fIlocation\fR +.RS 4 +This may be set to override the location of the application settings\&. +.RE +.SH "EXAMPLES" +.sp +Here are some interesting and/or useful examples you can do with your apps file\&. +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +# Put the first two windows which end with \'term\' on workspace 1 +[app] (name=\&.*[tT]erm) {2} + [Workspace] {1} +[end] + +# Center kate with a specific size, and update these values when the window is +# closed\&. +[app] (name=kate) + [Dimensions] {1022 747} + [Position] (CENTER) {0 0} + [Close] {yes} +[end] + +# When starting konqueror, jump to workspace 1 first and start it there\&. +[app] (name=konqueror) + [Workspace] {1} + [Jump] {yes} +[end] + +# start all aterm without decorations +[app] (name=aterm) + [Deco] {NONE} +[end] + +# a group with the gimp dock and toolbox +# appears on layer 4 (bottom) +[group] + [app] (name=gimp) (role=gimp\-dock) + [app] (name=gimp) (role=gimp\-toolbox) + [Layer] {4} +[end] +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.SH "AUTHOR and CREDITS" +.sp +This manpage is the combined work of: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Jim Ramsay <i\&.am at jimramsay com> (>fluxbox\-1\&.0\&.0) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Curt Micol <asenchi at asenchi com> (>fluxbox\-0\&.9\&.11) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Tobias Klausmann <klausman at users sourceforge net> (\(lafluxbox\-0\&.9\&.11) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Grubert <grubert at users sourceforge net> (fluxbox) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Matthew Hawkins <matt at mh dropbear id au> (blackbox) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Wilbert Berendsen <wbsoft at xs4all nl> (blackbox) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Numerous other languages could be available if someone jumps in\&. +.RE +.SH "SEE ALSO" +.sp +fluxbox(1), xev(1), xkill(1), regex(7)
M doc/fluxbox-keys.5doc/fluxbox-keys.5

@@ -1,106 +1,274 @@

.\" Title: fluxbox-keys -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> -.\" Date: 08/21/2008 -.\" Manual: -.\" Source: +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> +.\" Date: 02/10/2009 +.\" Manual: Fluxbox Manual +.\" Source: fluxbox-keys.txt 1.1.1 +.\" Language: English .\" -.TH "FLUXBOX\-KEYS" "5" "08/21/2008" "" "" +.TH "FLUXBOX\-KEYS" "5" "02/10/2009" "fluxbox\-keys\&.txt 1\&.1\&.1" "Fluxbox Manual" +.\" ----------------------------------------------------------------- +.\" * (re)Define some macros +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" toupper - uppercase a string (locale-aware) +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de toupper +.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ +\\$* +.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH-xref - format a cross-reference to an SH section +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de SH-xref +.ie n \{\ +.\} +.toupper \\$* +.el \{\ +\\$* +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH - level-one heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SH +.\" put an extra blank line of space above the head in non-TTY output +.if t \{\ +.sp 1 +.\} +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[an-margin]u +.ti 0 +.HTML-TAG ".NH \\n[an-level]" +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +\." make the size of the head bigger +.ps +3 +.ft B +.ne (2v + 1u) +.ie n \{\ +.\" if n (TTY output), use uppercase +.toupper \\$* +.\} +.el \{\ +.nr an-break-flag 0 +.\" if not n (not TTY), use normal case (not uppercase) +\\$1 +.in \\n[an-margin]u +.ti 0 +.\" if not n (not TTY), put a border/line under subheading +.sp -.6 +\l'\n(.lu' +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SS - level-two heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SS +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[IN]u +.ti \\n[SN]u +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.ps \\n[PS-SS]u +\." make the size of the head bigger +.ps +2 +.ft B +.ne (2v + 1u) +.if \\n[.$] \&\\$* +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BB/BE - put background/screen (filled box) around block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BB +.if t \{\ +.sp -.5 +.br +.in +2n +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EB +.if t \{\ +.if "\\$2"adjust-for-leading-newline" \{\ +.sp -1 +.\} +.br +.di +.in +.ll +.gcolor +.nr BW \\n(.lu-\\n(.i +.nr BH \\n(dn+.5v +.ne \\n(BHu+.5v +.ie "\\$2"adjust-for-leading-newline" \{\ +\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.el \{\ +\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.in 0 +.sp -.5v +.nf +.BX +.in +.sp .5v +.fi +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BM/EM - put colored marker in margin next to block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BM +.if t \{\ +.br +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EM +.if t \{\ +.br +.di +.ll +.gcolor +.nr BH \\n(dn +.ne \\n(BHu +\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] +.in 0 +.nf +.BX +.in +.fi +.\} +.. +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l -.SH "NAME" -fluxbox-keys - keyboard shortcuts configuration for fluxbox(1) -.SH "SYNOPSIS" -~/\.fluxbox/keys +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "Name" +fluxbox-keys \- keyboard shortcuts configuration for fluxbox(1) +.SH "Synopsis" .sp +~/\&.fluxbox/keys .SH "SYNTAX" +.sp Variable parameters are shown in emphasis: \fIargument\fR .sp Optional parameters are shown in square brackets: [\fIargument\fR] .sp -All other characters shown are required verbatim\. Whitespace is required where shown, but it is fine to add more whitespace\. -.sp +All other characters shown are required verbatim\&. Whitespace is required where shown, but it is fine to add more whitespace\&. .SH "DESCRIPTION" -The keys file defines the keyboard shortcuts for \fIfluxbox(1)\fR\. .sp -You can customize fluxbox\'s key handling through the ~/\.fluxbox/keys file\. The file consists of lines of the basic format: +The keys file defines the keyboard shortcuts for \fIfluxbox(1)\fR\&. +.sp +You can customize fluxbox\'s key handling through the ~/\&.fluxbox/keys file\&. The file consists of lines of the basic format: .sp \fB[\fR\fB\fImodifiers\fR\fR\fB] \fR\fB\fIkey\fR\fR\fB :\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIarguments\fR\fR\fB \fR\fB\fI\&...\fR\fR\fB]\fR .sp -The space between the \fIkey\fR and the \fB:\fR before the \fIcommand\fR is mandatory\. +The space between the \fIkey\fR and the \fB:\fR before the \fIcommand\fR is mandatory\&. .sp -All modifiers and commands are case\-insensitive\. Some command arguments (especially those that will be passed to the shell) are case\-sensitive\. Some key names are case\-sensitive\. +All modifiers and commands are case\-insensitive\&. Some command arguments (especially those that will be passed to the shell) are case\-sensitive\&. Some key names are case\-sensitive\&. .sp -Lines beginning with a \fI#\fR or \fI!\fR are considered comments and are unread by fluxbox\. +Lines beginning with a \fI#\fR or \fI!\fR are considered comments and are unread by fluxbox\&. +.SH "MODIFIERS" .sp -.SH "MODIFIERS" -You can get a list of possible modifiers by calling `xmodmap \-pm\'\. This also shows you to which keys the modifiers are mapped, but the following modifiers are most commonly used: +You can get a list of possible modifiers by calling `xmodmap \-pm\'\&. This also shows you to which keys the modifiers are mapped, but the following modifiers are most commonly used: .sp \fBShift Control Mod1 Mod4\fR .sp -where \fBMod1\fR is the Alt key on the PC keyboard and \fBMod4\fR is usually a key branded with a familiar company logo\. +where \fBMod1\fR is the Alt key on the PC keyboard and \fBMod4\fR is usually a key branded with a familiar company logo\&. .PP There are also some special modifiers that refer to mouse button presses: .RS 4 .PP \fBOnDesktop\fR .RS 4 -The mouse cursor is over the desktop (root window), and not any window\. +The mouse cursor is over the desktop (root window), and not any window\&. .RE .PP \fBOnToolbar\fR .RS 4 -The mouse cursor is over the toolbar (which is normally at the bottom of the screen)\. +The mouse cursor is over the toolbar (which is normally at the bottom of the screen)\&. .RE .PP \fBOnWindow\fR .RS 4 -The mouse cursor is over a window\. +The mouse cursor is over a window\&. .RE .PP \fBOnTitlebar\fR .RS 4 -The mouse cursor is over a window\'s titlebar\. +The mouse cursor is over a window\'s titlebar\&. .RE .PP \fBDouble\fR .RS 4 -Limits this action to double\-clicks only\. +Limits this action to double\-clicks only\&. .RE .RE .SS "Combining Modifiers" -To combine two or more modifiers, just list them (space\-delimited) in any order\. .sp +To combine two or more modifiers, just list them (space\-delimited) in any order\&. .SH "KEYS" -You may specify a key by its key name (for example, \fBa\fR or \fBspace\fR) or by its numeric keycode (for example, \fB38\fR or \fB0xf3\fR)\. .sp -If you don\'t know the name of a key, you can run \fIxev(1)\fR in a terminal, push the key, and see the name in the output\. If you have some "special" keys that do not produce a key name in the output of \fIxev(1)\fR, you can just use the keycode (NOT the keysym!) in your keys file\. +You may specify a key by its key name (for example, \fBa\fR or \fBspace\fR) or by its numeric keycode (for example, \fB38\fR or \fB0xf3\fR)\&. .sp -Commands can also be bound to mouse button presses, for which the proper "key" name is \fBMouse\fR\fIn\fR where \fIn\fR is the number of the mouse button\. For example, \fBMouse1\fR is the primary button, and \fBMouse4\fR / \fBMouse5\fR are the scroll wheel events, in normal configurations\. \fIxev(1)\fR can also be used to tell the button number\. +If you don\'t know the name of a key, you can run \fIxev(1)\fR in a terminal, push the key, and see the name in the output\&. If you have some "special" keys that do not produce a key name in the output of \fIxev(1)\fR, you can just use the keycode (NOT the keysym!) in your keys file\&. .sp +Commands can also be bound to mouse button presses, for which the proper "key" name is \fBMouse\fR\fIn\fR where \fIn\fR is the number of the mouse button\&. For example, \fBMouse1\fR is the primary button, and \fBMouse4\fR / \fBMouse5\fR are the scroll wheel events, in normal configurations\&. \fIxev(1)\fR can also be used to tell the button number\&. .SH "CHAINING" +.sp Key bindings can be chained in a fashion similar to Emacs key bindings using the syntax: .sp \fB\fImodifiers\-1\fR\fR\fB \fR\fB\fIkey\-1\fR\fR\fB \fR\fB\fImodifiers\-2\fR\fR\fB \fR\fB\fIkey\-2\fR\fR\fB :\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIarguments \&...\fR\fR\fB]\fR .PP -\fBExample\ 1.\ To Bind CTRL+C CTRL+X (Which means, press CTRL+C then CTRL+X) to quit fluxbox\fR +\fBExample\ \&1.\ \&To Bind CTRL+C CTRL+X (Which means, press CTRL+C then CTRL+X) to quit fluxbox\fR .sp +.if n \{\ .RS 4 +.\} +.fam C +.ps -1 .nf +.BB lightgray Control c Control x :Quit +.EB lightgray .fi +.fam +.ps +1 +.if n \{\ .RE +.\} .SH "KEYMODES" -A specific set of key mappings can be activated and de\-activated on\-the\-fly using what are called keymodes\. The syntax to define a mapping in a keymode is: .sp -\fB\fIkeymode\fR\fR\fB: \fR\fB\fImodifiers\fR\fR\fB \fR\fB\fIkey\fR\fR\fB :\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIarguments\fR\fR\fB \fR\fB\fI\&...\fR\fR\fB]\fR +A specific set of key mappings can be activated and de\-activated on\-the\-fly using what are called keymodes\&. The syntax to define a mapping in a keymode is: .sp -Where \fIkeymode\fR is any alpha\-numeric string name\. +\fB\fIkeymode\fR\fR\fB: \fR\fB\fImodifiers\fR\fR\fB \fR\fB\fIkey\fR\fR\fB :\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIarguments\fR\fR\fB \fR\fB\fI\&...\fR\fR\fB]\fR .sp -When this keymode is activated (see the \fBKeyMode\fR command below), all bindings prefaced by that keymode name become active (and all other keybindings will be deactivated) until the keymode changes again\. +Where \fIkeymode\fR is any alpha\-numeric string name\&. .sp +When this keymode is activated (see the \fBKeyMode\fR command below), all bindings prefaced by that keymode name become active (and all other keybindings will be deactivated) until the keymode changes again\&. .SH "COMMANDS" .PP Some commands have multiple names which are shown below as:

@@ -117,41 +285,84 @@ The commands are broken up into sections as follows:

.RS 4 .sp .RS 4 -\h'-04'\(bu\h'+03'Mouse Commands +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Mouse Commands .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Window Commands +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Window Commands .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Workspace Commands +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Workspace Commands .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Menu Commands +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Menu Commands .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Window Manager Commands +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Window Manager Commands .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Special Commands +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Special Commands .RE .RE .SS "Mouse Commands" -These commands may only be bound to mouse buttons (plus modifiers), not keystrokes\. In all cases, the action finishes when the mouse button is released\. +.sp +These commands may only be bound to mouse buttons (plus modifiers), not keystrokes\&. In all cases, the action finishes when the mouse button is released\&. .PP \fBStartMoving\fR .RS 4 -Start dragging to move the window\. +Start dragging to move the window\&. .RE .PP \fBStartResizing\fR [\fIcorner\fR] .RS 4 Start dragging to resize the window as if you had grabbed the window at the specified -\fIcorner\fR\. +\fIcorner\fR\&. .PP By default \fIcorner\fR is \fBBottomRight\fR, but may be overridden with one of: .RS 4

@@ -162,43 +373,44 @@ .RE

.PP \fBStartTabbing\fR .RS 4 -Start dragging to add this window to another\'s tabgroup\. +Start dragging to add this window to another\'s tabgroup\&. .RE .SS "Window Commands" -These commands ordinarily affect only the currently focused window\. The \fBOnWindow\fR modifier and \fBForEach\fR command may affect the window that is used\. +.sp +These commands ordinarily affect only the currently focused window\&. The \fBOnWindow\fR modifier and \fBForEach\fR command may affect the window that is used\&. .PP \fBMinimize\fR | \fBMinimizeWindow\fR | \fBIconify\fR .RS 4 -Minimize the current window, equivalent to the window button\. +Minimize the current window, equivalent to the window button\&. .RE .PP \fBMaximize\fR | \fBMaximizeWindow\fR .RS 4 -Maximize the current window, equivalent to the window button\. +Maximize the current window, equivalent to the window button\&. .RE .PP \fBMaximizeHorizontal\fR / \fBMaximizeVertical\fR .RS 4 -Maximize the current window in one direction only, leaving the other dimension unchanged\. +Maximize the current window in one direction only, leaving the other dimension unchanged\&. .RE .PP \fBRaise\fR / \fBLower\fR .RS 4 -Reorder this window to the top or bottom of the window stack, within its current layer\. See +Reorder this window to the top or bottom of the window stack, within its current layer\&. See \fIfluxbox(1)\fR -for a discussion of layers\. +for a discussion of layers\&. .RE .PP \fBRaiseLayer\fR / \fBLowerLayer\fR .RS 4 -Raise the window up to the layer above, or lower it to the layer below\. See +Raise the window up to the layer above, or lower it to the layer below\&. See \fIfluxbox(1)\fR -for a discussion of layers\. +for a discussion of layers\&. .RE .PP \fBSetLayer\fR \fIlayer\fR .RS 4 -Move the window to the specified layer\. +Move the window to the specified layer\&. \fIlayer\fR should be one of \fBAboveDock\fR,

@@ -206,96 +418,96 @@ \fBDock\fR,

\fBTop\fR, \fBNormal\fR, \fBBottom\fR, -\fBDesktop\fR\. See +\fBDesktop\fR\&. See \fIfluxbox(1)\fR -for a discussion of layers\. +for a discussion of layers\&. .RE .PP \fBClose\fR .RS 4 -Close the current window, equivalent to the window button\. +Close the current window, equivalent to the window button\&. .RE .PP \fBKill\fR | \fBKillWindow\fR .RS 4 Close a window that\'s not responding to \fBClose\fR, like using -xkill\. +\FCxkill\F[]\&. .RE .PP \fBShade\fR | \fBShadeWindow\fR .RS 4 Toggle the \fBshaded\fR -state of the current window, equivalent to the window button\. A +state of the current window, equivalent to the window button\&. A \fBshaded\fR -window appears as only the title bar\. +window appears as only the title bar\&. .RE .PP \fBShadeOn\fR / \fBShadeOff\fR .RS 4 Set the \fBshaded\fR -state of the window to On / Off\. +state of the window to On / Off\&. .RE .PP \fBStick\fR | \fBStickWindow\fR .RS 4 Toggle the \fBsticky\fR -state of the current window, equivalent to the window button\. A +state of the current window, equivalent to the window button\&. A \fBsticky\fR -window is visible on all workspaces\. +window is visible on all workspaces\&. .RE .PP \fBSetDecor\fR \fIdecor\fR .RS 4 -Sets which window decorations will be shown\. +Sets which window decorations will be shown\&. \fIdecor\fR -has the same format as the `\fI parameter in the apps file\. See `man fluxbox\fR -section APPLICATIONS for more info\. +has the same format as the `\fI parameter in the apps file\&. See `man fluxbox\fR +section APPLICATIONS for more info\&. .RE .PP \fBToggleDecor\fR .RS 4 -Toggles the presence of the window decorations (title bar, window buttons, and resize bar)\. +Toggles the presence of the window decorations (title bar, window buttons, and resize bar)\&. .RE .PP \fBNextTab\fR / \fBPrevTab\fR .RS 4 -Cycle to the next / previous tab in the current tab group\. +Cycle to the next / previous tab in the current tab group\&. .RE .PP \fBTab\fR \fInumber\fR .RS 4 Cycle to the given tab in the current tab group, where \fB1\fR -is the first tab\. A negative +is the first tab\&. A negative \fInumber\fR counts from the end of the tab group (\fB\-1\fR is the last tab, \fB\-2\fR -is the next\-to\-last, etc\.)\. +is the next\-to\-last, etc\&.)\&. .RE .PP \fBMoveTabRight\fR / \fBMoveTabLeft\fR .RS 4 -Reorder the tabs in the current tab group, swapping the current tab with the one to the right / left\. +Reorder the tabs in the current tab group, swapping the current tab with the one to the right / left\&. .RE .PP \fBDetachClient\fR .RS 4 -Remove the current tab from the tab group, placing it in its own window\. +Remove the current tab from the tab group, placing it in its own window\&. .RE .PP \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\&. .RE .PP \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\&. .RE .PP \fBResizeHorizontal\fR \fIdelta\-width\fR / \fBResizeVertical\fR \fIdelta\-height\fR

@@ -305,14 +517,14 @@ .RE

.PP \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\&. .sp If either \fIx\fR or \fIy\fR is set to -\fB*\fR, that coordinate will be ignored, and the movement will only take place in one dimension\. +\fB*\fR, that coordinate will be ignored, and the movement will only take place in one dimension\&. .PP The default \fIanchor\fR is the upper left corner, but this may be overridden with one of: .RS 4

@@ -323,119 +535,120 @@ .RE

.PP \fBMove\fR \fIdelta\-x\fR \fIdelta\-y\fR .RS 4 -Moves the window relative to its current position\. Positive numbers refer to right and down, and negative to left and up, respectively\. +Moves the window relative to its current position\&. Positive numbers refer to right and down, and negative to left and up, respectively\&. .RE .PP \fBMoveRight\fR \fId\fR / \fBMoveLeft\fR \fId\fR / \fBMoveUp\fR \fId\fR / \fBMoveDown\fR \fId\fR .RS 4 Moves the window relative to its current position by the number of pixels specified in -\fId\fR\. If the number is negative, it moves in the opposite direction\. +\fId\fR\&. If the number is negative, it moves in the opposite direction\&. .RE .PP \fBTakeToWorkspace\fR \fIworkspace\fR / \fBSendToWorkspace\fR \fIworkspace\fR .RS 4 -Sends you along with the current window to the selected workspace\. SendToWorkspace just sends the window\. The first workspace is number -\fB1\fR, not 0\. +Sends you along with the current window to the selected workspace\&. SendToWorkspace just sends the window\&. The first workspace is number +\fB1\fR, not 0\&. .RE .PP \fBTakeToNextWorkspace\fR [\fIoffset\fR] / \fBTakeToPrevWorkspace\fR [\fIoffset\fR] .RS 4 -Sends you along with the current window to the next or previous workspace\. If you set +Sends you along with the current window to the next or previous workspace\&. If you set \fIoffset\fR to a value greater than the default of -\fB1\fR, it will move you that number of workspaces ahead or behind\. If you go beyond the end of the currently defined workspaces, it will wrap around to the other end automatically\. +\fB1\fR, it will move you that number of workspaces ahead or behind\&. If you go beyond the end of the currently defined workspaces, it will wrap around to the other end automatically\&. .RE .PP \fBSendToNextWorkspace\fR [\fIoffset\fR] / \fBSendToPrevWorkspace\fR [\fIoffset\fR] .RS 4 -Identical to the "TakeTo\&..." commands, but again this sends only the window, and does not move you away from your current workspace\. +Identical to the "TakeTo\&..." commands, but again this sends only the window, and does not move you away from your current workspace\&. .RE .PP \fBSetAlpha\fR [\fIalpha\fR [\fIunfocused\-alpha\fR]] .RS 4 -Sets the alpha value of a window\. +Sets the alpha value of a window\&. .sp Putting a \fB+\fR or \fB\-\fR -in front of the value adds or subtracts from the current value\. A plain integer sets the value explicitly\. +in front of the value adds or subtracts from the current value\&. A plain integer sets the value explicitly\&. .PP no arguments .RS 4 -Resets both focused and unfocused settings to default opacity\. +Resets both focused and unfocused settings to default opacity\&. .RE .PP one argument .RS 4 -Changes both focused and unfocused alpha settings\. +Changes both focused and unfocused alpha settings\&. .RE .PP two arguments .RS 4 -First value becomes the focused alpha, second becomes the unfocused alpha value\. +First value becomes the focused alpha, second becomes the unfocused alpha value\&. .RE .RE .PP \fBSetHead\fR \fInumber\fR .RS 4 -Moves the window to the given display head\. Only available when fluxbox has been compiled with Xinerama support\. +Moves the window to the given display head\&. Only available when fluxbox has been compiled with Xinerama support\&. .RE .PP \fBSendToNextHead\fR [\fIoffset\fR] / \fBSendToPrevHead\fR [\fIoffset\fR] .RS 4 -Sends the current window to the next/previous display head\. If you specify an +Sends the current window to the next/previous display head\&. If you specify an \fIoffset\fR greater than -\fB1\fR, it will move the window that many heads\. If this takes the window beyond the total number of heads, it will wrap around to the beginning\. +\fB1\fR, it will move the window that many heads\&. If this takes the window beyond the total number of heads, it will wrap around to the beginning\&. .RE .SS "Workspace Commands" -These commands affect the entire workspace (or "desktop" as it is sometimes called)\. +.sp +These commands affect the entire workspace (or "desktop" as it is sometimes called)\&. .PP \fBAddWorkspace\fR / \fBRemoveLastWorkspace\fR .RS 4 -Adds or removes a workspace from the end of the list of workspaces\. +Adds or removes a workspace from the end of the list of workspaces\&. .RE .PP \fBNextWorkspace\fR [\fIn\fR] / \fBPrevWorkspace\fR [\fIn\fR] / \fBRightWorkspace\fR [\fIn\fR] / \fBLeftWorkspace\fR [\fIn\fR] .RS 4 -Switch to the Next / Previous workspace\. All versions accept an offset value +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\&. .RE .PP \fBWorkspace\fR \fInumber\fR .RS 4 Jumps to the given workspace -\fInumber\fR\. The first workspace is -\fB1\fR\. +\fInumber\fR\&. The first workspace is +\fB1\fR\&. .RE .PP \fBNextWindow\fR [{\fIoptions\fR}] [\fIpattern\fR] / \fBPrevWindow\fR [{\fIoptions\fR}] [\fIpattern\fR] .RS 4 -Focuses the next / previous window in the focus list\. +Focuses the next / previous window in the focus list\&. .PP \fIoptions\fR is one or more of the following, space delimited: .RS 4 .PP \fBstatic\fR .RS 4 -Instead of moving in order of most\-recent focus, move in order of when the window was opened (or, the order shown in the iconbar)\. +Instead of moving in order of most\-recent focus, move in order of when the window was opened (or, the order shown in the iconbar)\&. .RE .PP \fBgroups\fR .RS 4 -Only include the current tab in windows with multiple tabs\. +Only include the current tab in windows with multiple tabs\&. .RE .sp If \fIpattern\fR -arguments are supplied, only windows that match all the patterns are considered \- all others are skipped\. See the section +arguments are supplied, only windows that match all the patterns are considered \- all others are skipped\&. See the section \fBCLIENT PATTERNS\fR -below for more information\. +below for more information\&. .sp -This pair of commands has a special side\-effect when the keybinding used has a modifier \- It will temporarily raise the cycled window to the front so you can see it, but if you continue holding down the modifier and press the key again (For example, keep holding "Alt" while you tap the "Tab" key a few times), fluxbox will lower the window again when you move on to the next one\. This allows you to preview the windows in order, but does not change the order in doing so\. +This pair of commands has a special side\-effect when the keybinding used has a modifier \- It will temporarily raise the cycled window to the front so you can see it, but if you continue holding down the modifier and press the key again (For example, keep holding "Alt" while you tap the "Tab" key a few times), fluxbox will lower the window again when you move on to the next one\&. This allows you to preview the windows in order, but does not change the order in doing so\&. .RE .RE .PP

@@ -443,20 +656,20 @@ \fBNextGroup\fR [{\fIoptions\fR}] [\fIpattern\fR] / \fBPrevGroup\fR [{\fIoptions\fR}] [\fIpattern\fR]

.RS 4 Equivalent to NextWindow / PrevWindow above, but with the \fBgroups\fR -option forced on\. +option forced on\&. .RE .PP \fBGotoWindow\fR \fInumber\fR [{\fIoptions\fR}] [\fIpattern\fR] .RS 4 Focuses and activates the window at position \fInumber\fR -in the focus list\. The +in the focus list\&. The \fIoptions\fR and \fIpattern\fR arguments have the same meaning as \fBNextWindow\fR -above\. +above\&. .RE .PP \fBActivate\fR [\fIpattern\fR] | \fBFocus\fR [\fIpattern\fR]

@@ -465,64 +678,64 @@ With

\fIpattern\fR, this is an alias for \fBGoToWindow\fR 1 -\fIpattern\fR\. Without, this behaves like a window command, so that OnWindow events can change the focused window\. +\fIpattern\fR\&. Without, this behaves like a window command, so that OnWindow events can change the focused window\&. .RE .PP \fBAttach\fR \fIpattern\fR .RS 4 Combines all windows that match the \fIpattern\fR -into a single tab group\. See +into a single tab group\&. See \fBCLIENT PATTERNS\fR for more about the \fIpattern\fR -arguments\. +arguments\&. .RE .PP \fBFocusLeft\fR / \fBFocusRight\fR / \fBFocusUp\fR / \fBFocusDown\fR .RS 4 -Focus to the next window which is located in the direction specified\. +Focus to the next window which is located in the direction specified\&. .RE .PP \fBArrangeWindows\fR \fIpattern\fR .RS 4 -Tries to arrange all windows on the current workspace so that they overlap the least amount possible\. See +Tries to arrange all windows on the current workspace so that they overlap the least amount possible\&. See \fBCLIENT PATTERNS\fR for more about the \fIpattern\fR -arguments\. +arguments\&. .RE .PP \fBShowDesktop\fR .RS 4 -Minimizes all windows on the current workspace\. If they are already all minimized, then it restores them\. +Minimizes all windows on the current workspace\&. If they are already all minimized, then it restores them\&. .RE .PP \fBDeiconify\fR \fImode\fR \fIdestination\fR .RS 4 -Deiconifies windows (or, restores from a minimized state)\. +Deiconifies windows (or, restores from a minimized state)\&. .PP Where \fImode\fR may be one of: .RS 4 .PP \fBAll\fR .RS 4 -All icons across all workspaces\. +All icons across all workspaces\&. .RE .PP \fBAllWorkspace\fR .RS 4 -All icons on the current workspace\. +All icons on the current workspace\&. .RE .PP \fBLast\fR .RS 4 -The last icon across all workspaces\. +The last icon across all workspaces\&. .RE .PP \fBLastWorkspace\fR (default) .RS 4 -The last icon on the current workspace\. +The last icon on the current workspace\&. .RE .RE .PP

@@ -531,142 +744,155 @@ .RS 4

.PP \fBCurrent\fR (default) .RS 4 -Deiconify to the current workspace\. +Deiconify to the current workspace\&. .RE .PP \fBOriginQuiet\fR .RS 4 -Deiconify to the window\'s original workspace, but does so in the background, without moving you there\. +Deiconify to the window\'s original workspace, but does so in the background, without moving you there\&. .RE .RE .RE .PP \fBSetWorkspaceName\fR \fIname\fR / \fBSetWorkspaceNameDialog\fR .RS 4 -Sets the name of the current workspace\. +Sets the name of the current workspace\&. .RE .PP \fBCloseAllWindows\fR .RS 4 -Closes all windows on all desktops\. +Closes all windows on all desktops\&. .RE .SS "Menu Commands" -These commands open or close fluxbox popup menus\. For more information on what these menus contain or how to configure them, see \fIfluxbox(1)\fR\. +.sp +These commands open or close fluxbox popup menus\&. For more information on what these menus contain or how to configure them, see \fIfluxbox(1)\fR\&. .PP \fBRootMenu\fR / \fBWorkspaceMenu\fR / \fBWindowMenu\fR .RS 4 -Opens the specified menu\. See fluxbox(1) for more details on what these menus contain\. +Opens the specified menu\&. See fluxbox(1) for more details on what these menus contain\&. .RE .PP \fBClientMenu\fR [\fIpattern\fR] .RS 4 -Opens a menu that contains all windows\. If you specify a -\fIpattern\fR, only matching windows will be in the menu\. See +Opens a menu that contains all windows\&. If you specify a +\fIpattern\fR, only matching windows will be in the menu\&. See \fBCLIENT PATTERNS\fR below for more details on the \fIpattern\fR -argument\. +argument\&. .RE .PP \fBCustomMenu\fR \fIpath\fR .RS 4 -Opens a custom menu file\. +Opens a custom menu file\&. .RE .PP \fBHideMenus\fR .RS 4 -Hide all fluxbox popup menus\. +Hide all fluxbox popup menus\&. .RE .SS "Window Manager Commands" -These commands affect the Window Manager, or more than one window\. +.sp +These commands affect the Window Manager, or more than one window\&. .PP \fBRestart\fR [\fIpath\fR] .RS 4 -Restarts fluxbox\. This does not close any running applications\. If the optional +Restarts fluxbox\&. This does not close any running applications\&. If the optional \fIpath\fR -is a path to an executable window manager, that manager is started in place of fluxbox\. +is a path to an executable window manager, that manager is started in place of fluxbox\&. .RE .PP \fBQuit\fR | \fBExit\fR .RS 4 -Exits fluxbox\. This will normally cause X to stop as well and terminate all existing applications, returning you to the login manager or console\. +Exits fluxbox\&. This will normally cause X to stop as well and terminate all existing applications, returning you to the login manager or console\&. .RE .PP \fBReconfig\fR | \fBReconfigure\fR .RS 4 -Reloads all fluxbox configuration files including the keys file, apps file, and init file, if they have changed\. +Reloads all fluxbox configuration files including the keys file, apps file, and init file, if they have changed\&. .RE .PP \fBSetStyle\fR \fIpath\fR .RS 4 Sets the current style to that given in -\fIpath\fR, which must be the full path to a fluxbox style\. +\fIpath\fR, which must be the full path to a fluxbox style\&. .RE .PP \fBReloadStyle\fR .RS 4 -Reloads only the current style\. Useful after editing a style which is currently in use\. +Reloads only the current style\&. Useful after editing a style which is currently in use\&. .RE .PP \fBExecCommand\fR \fIargs \&...\fR | \fBExec\fR \fIargs \&...\fR | \fBExecute\fR \fIargs \&...\fR .RS 4 -Probably the most\-used binding of all\. Passes all the arguments to your +Probably the most\-used binding of all\&. Passes all the arguments to your \fB$SHELL\fR -(or /bin/sh if $SHELL is not set)\. You can use this to launch applications, run shell scripts, etc\. Since all arguments are passed verbatim to the shell, you can use environment variables, pipes, or anything else the shell can do\. Note that processes only see environment variables that were set before fluxbox started (such as in ~/\.fluxbox/startup), or any that are set via the Export or SetEnv commands, below\. +(or /bin/sh if $SHELL is not set)\&. You can use this to launch applications, run shell scripts, etc\&. Since all arguments are passed verbatim to the shell, you can use environment variables, pipes, or anything else the shell can do\&. Note that processes only see environment variables that were set before fluxbox started (such as in ~/\&.fluxbox/startup), or any that are set via the Export or SetEnv commands, below\&. .RE .PP \fBCommandDialog\fR .RS 4 -Pops up a dialog box that lets you type in any of these commands manually\. +Pops up a dialog box that lets you type in any of these commands manually\&. .RE .PP \fBSetEnv\fR \fIname\fR \fIvalue\fR | \fBExport\fR \fIname\fR=\fIvalue\fR .RS 4 -Sets an environment variable in Fluxbox\. It will be passed to any applications spawned by any future ExecCommand commands\. +Sets an environment variable in Fluxbox\&. It will be passed to any applications spawned by any future ExecCommand commands\&. .RE .PP \fBSetResourceValue\fR \fIresourcename\fR \fIresourcevalue\fR | \fBSetResourceValueDialog\fR .RS 4 -Sets a fluxbox resource value, which are normally stored in the init file\. See +Sets a fluxbox resource value, which are normally stored in the init file\&. See \fIfluxbox(1)\fR -for more details on available resources and allowed values\. +for more details on available resources and allowed values\&. .RE .SS "Special Commands" -These commands have special meanings or behaviors\. +.sp +These commands have special meanings or behaviors\&. .PP \fBMacroCmd\fR {\fIcommand1\fR} {\fIcommand2\fR} {\fIcommand3\fR} \fI\&...\fR .RS 4 -Allows you to execute more than one command with one keybinding\. The commands will be executed in series\. The +Allows you to execute more than one command with one keybinding\&. The commands will be executed in series\&. The \fB{\fR \fB}\fR brackets are literally required, as in the following example: .sp +.if n \{\ .RS 4 +.\} +.fam C +.ps -1 .nf +.BB lightgray MacroCmd {MoveTo 0 0} {ResizeTo 1280 800} +.EB lightgray .fi +.fam +.ps +1 +.if n \{\ .RE +.\} .RE .PP \fBDelay\fR {\fIcommand\fR} [\fImicroseconds\fR] .RS 4 Delays running \fIcommand\fR -for the given amount of time\. If the same key binding is activated again, the timer will be restarted\. +for the given amount of time\&. If the same key binding is activated again, the timer will be restarted\&. .RE .PP \fBToggleCmd\fR {\fIcommand1\fR} {\fIcommand2\fR} \fI\&...\fR .RS 4 -Alternates between the commands\. On the first press of the bound key, runs -\fIcommand1\fR\. On the next press, runs -\fIcommand2\fR\. +Alternates between the commands\&. On the first press of the bound key, runs +\fIcommand1\fR\&. On the next press, runs +\fIcommand2\fR\&. .RE .PP \fBBindKey\fR \fIkeybinding\fR .RS 4 Adds the given \fIkeybinding\fR -(which must be a valid key binding as defined in the DESCRIPTION section above) to your keys file\. +(which must be a valid key binding as defined in the DESCRIPTION section above) to your keys file\&. .RE .PP \fBKeyMode\fR \fIkeymode\fR [\fIreturn\-keybinding\fR]

@@ -677,8 +903,8 @@ (or, all key binding lines prefaced with the same

\fIkeymode\fR:) and deactivates all others until the \fIreturn\-keybinding\fR (by default -\fBEscape\fR) is pressed\. The default keymode is named -\fIdefault\fR\. +\fBEscape\fR) is pressed\&. The default keymode is named +\fIdefault\fR\&. .RE .PP \fBForEach\fR {\fIcommand\fR} [{\fIcondition\fR}] | \fBMap\fR {\fIcommand\fR} [{\fIcondition\fR}]

@@ -687,10 +913,10 @@ Runs the given

\fIcommand\fR (normally one from the \fBWindow Commands\fR -section above) on each window\. If you specify a +section above) on each window\&. If you specify a \fIcondition\fR (See -\fBConditions\fR, below) the action will be limited to matching windows\. +\fBConditions\fR, below) the action will be limited to matching windows\&. .RE .PP \fBIf\fR {\fIcondition\fR} {\fIthen\-command\fR} [{\fIelse\-command\fR}] | \fBCond\fR {\fIcondition\fR} {\fIthen\-command\fR} [{\fIelse\-command\fR}]

@@ -700,35 +926,36 @@ \fIcondition\fR

command returns \fBtrue\fR, then run the \fIthen\-command\fR, otherwise run the optional -\fIelse\-command\fR\. See +\fIelse\-command\fR\&. See \fBConditions\fR below for more information on the \fIcondition\fR -argument\. +argument\&. .RE .SS "Conditions" -These special commands are used to match windows conditionally\. They are commonly used by the \fBIf\fR and \fBForEach\fR command\. +.sp +These special commands are used to match windows conditionally\&. They are commonly used by the \fBIf\fR and \fBForEach\fR command\&. .PP \fBMatches\fR \fIpattern\fR .RS 4 Returns \fBtrue\fR if the current window matches the given -\fIpattern\fR\. See +\fIpattern\fR\&. See \fBCLIENT PATTERNS\fR below for details on the \fIpattern\fR -syntax\. +syntax\&. .sp If your key binding uses the \fBOnWindow\fR -modifier, it matches against the window you clicked, not the currently focused window\. +modifier, it matches against the window you clicked, not the currently focused window\&. .sp To check other windows besides the currently focused one, see the \fBEvery\fR and \fBSome\fR -conditions below\. +conditions below\&. .RE .PP \fBSome\fR \fIcondition\fR

@@ -736,7 +963,7 @@ .RS 4

Retuns \fBtrue\fR if any window on any workspace (not just the currently focused one) matches the -\fIcondition\fR\. +\fIcondition\fR\&. .RE .PP \fBEvery\fR \fIcondition\fR

@@ -744,7 +971,7 @@ .RS 4

Retuns \fBtrue\fR if every window on every workspace (not just the current one) matches the -\fIcondition\fR\. +\fIcondition\fR\&. .RE .PP \fBNot\fR \fIcondition\fR

@@ -754,7 +981,7 @@ \fBtrue\fR

if \fIcondition\fR returns -\fBfalse\fR, and vice\-versa\. +\fBfalse\fR, and vice\-versa\&. .RE .PP \fBAnd\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...]

@@ -762,7 +989,7 @@ .RS 4

Returns \fBtrue\fR if and only if all given conditions return -\fBtrue\fR\. +\fBtrue\fR\&. .RE .PP \fBOr\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...]

@@ -770,45 +997,61 @@ .RS 4

Returns \fBtrue\fR if any of the listed conditions return -\fBtrue\fR\. +\fBtrue\fR\&. .RE .PP \fBXor\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...] .RS 4 Returns the boolean \fBxor\fR -of the truth values for all conditions listed\. +of the truth values for all conditions listed\&. .RE .SH "CLIENT PATTERNS" -Many of the more advanced commands take a \fIpattern\fR argument, which allows you to direct the action at a specific window or set of windows which match the properties specified in the \fIpattern\fR\. A \fIpattern\fR looks like this: .sp -([\fIpropertyname\fR[!]=]\fIregexp\fR) \&... +Many of the more advanced commands take a \fIpattern\fR argument, which allows you to direct the action at a specific window or set of windows which match the properties specified in the \fIpattern\fR\&. +.PP +A \fIpattern\fR looks like this: +.RS 4 + +\fB(\fR[\fIpropertyname\fR[!]=]\fIregexp\fR\fB)\fR +\&... +.RE .sp -Match definitions are enclosed in parentheses \fB(\fR\&...\fB)\fR, and if no \fIpropertyname\fR is given then \fBName\fR is assumed\. The \fIregexp\fR can contain any regular expression, or the special value \fB[current]\fR, which matches the corresponding value of the currently focused window\. See \fIregex(7)\fR for more information on acceptable regular expressions\. +Match definitions are enclosed in parentheses \fB(\fR\&...\fB)\fR, and if no \fIpropertyname\fR is given then \fBName\fR is assumed\&. The \fIregexp\fR can contain any regular expression, or the special value \fB[current]\fR, which matches the corresponding value of the currently focused window\&. See \fIregex(7)\fR for more information on acceptable regular expressions\&. .sp -You can use \fB=\fR to test for equality or \fB!=\fR to test for inequality\. +\fIpropertyname\fR is not case sensitive, whereas the \fIregexp\fR is\&. +.sp +If you specify multiple \fB(\fR\fB\fIpattern\fR\fR) arguments, this implies an AND condition \- All specified patterns must match\&. +.sp +You can use \fB=\fR to test for equality or \fB!=\fR to test for inequality\&. .PP The following values are accepted for \fIpropertyname\fR: .RS 4 .PP \fBName\fR .RS 4 -A string, corresponding to the CLASSNAME property\. +A string, corresponding to the CLASSNAME property (The first field of WM_CLASS from the output of the +\fBxprop(1)\fR +utility)\&. .RE .PP \fBClass\fR .RS 4 -A string, corresponding to the CLASSCLASS property\. +A string, corresponding to the CLASSCLASS property (The second field of WM_CLASS from the output of the +\fBxprop(1)\fR +utility)\&. .RE .PP \fBTitle\fR .RS 4 -A string, corresponding to the window title\. +A string, corresponding to the window title (WM_NAME from +\fBxprop(1)\fR)\&. .RE .PP \fBRole\fR .RS 4 -A string, corresponding to the ROLE property\. +A string, corresponding to the ROLE property (WM_WINDOW_ROLE from +\fBxprop(1)\fR)\&. .RE .PP \fBTransient\fR

@@ -816,7 +1059,7 @@ .RS 4

Either \fByes\fR or -\fBno\fR, depending on whether the window is transient (typically, a popup dialog) or not\. +\fBno\fR, depending on whether the window is transient (typically, a popup dialog) or not\&. .RE .PP \fBMaximized\fR

@@ -824,7 +1067,7 @@ .RS 4

Either \fByes\fR or -\fBno\fR, depending on whether the window is maximized or not\. +\fBno\fR, depending on whether the window is maximized or not\&. .RE .PP \fBMinimized\fR

@@ -832,7 +1075,7 @@ .RS 4

Either \fByes\fR or -\fBno\fR, depending on whether the window is minimized (iconified) or not\. +\fBno\fR, depending on whether the window is minimized (iconified) or not\&. .RE .PP \fBShaded\fR

@@ -840,7 +1083,7 @@ .RS 4

Either \fByes\fR or -\fBno\fR, depending on whether the window is shaded or not\. +\fBno\fR, depending on whether the window is shaded or not\&. .RE .PP \fBStuck\fR

@@ -848,7 +1091,7 @@ .RS 4

Either \fByes\fR or -\fBno\fR, depending on whether the window is sticky (on all workspaces) or not\. +\fBno\fR, depending on whether the window is sticky (on all workspaces) or not\&. .RE .PP \fBFocusHidden\fR

@@ -856,7 +1099,7 @@ .RS 4

Either \fByes\fR or -\fBno\fR, depending on whether the window has asked to be left off the focus list (or, the alt\-tab list), or not\. +\fBno\fR, depending on whether the window has asked to be left off the focus list (or, the alt\-tab list), or not\&. .RE .PP \fBIconHidden\fR

@@ -864,7 +1107,7 @@ .RS 4

Either \fByes\fR or -\fBno\fR, depending on whether the window has asked to be left off the icon list (or, the taskbar), or not\. +\fBno\fR, depending on whether the window has asked to be left off the icon list (or, the taskbar), or not\&. .RE .PP \fBUrgent\fR

@@ -872,25 +1115,27 @@ .RS 4

Either \fByes\fR or -\fBno\fR, depending on whether the window has the urgent hint set\. +\fBno\fR, depending on whether the window has the urgent hint set\&. .RE .PP \fBWorkspace\fR .RS 4 -A number corresponding to the workspace number to which the window is attached\. The first workspace here is -\fB0\fR\. +A number corresponding to the workspace number to which the window is attached\&. The first workspace here is +\fB0\fR\&. You may also use +\fB[current]\fR +to match the currently visible workspace\&. .RE .PP \fBWorkspaceName\fR .RS 4 -A string corresponding to the name of the workspace to which the window is attached\. +A string corresponding to the name of the workspace to which the window is attached\&. .RE .PP \fBHead\fR .RS 4 -The number of the display head to which the window is attached\. You may match this against the special value +The number of the display head to which the window is attached\&. You may match this against the special value \fB[mouse]\fR -which refers to the head where the mouse pointer currently resides\. +which refers to the head where the mouse pointer currently resides\&. .RE .PP \fBLayer\fR

@@ -905,110 +1150,209 @@ \fBDesktop\fR

.RE .RE .PP -\fBExample\ 2.\ Matches any windows with the CLASSNAME of "xterm"\fR +\fBExample\ \&2.\ \&Matches any windows with the CLASSNAME of "xterm"\fR .sp +.if n \{\ .RS 4 +.\} +.fam C +.ps -1 .nf +.BB lightgray (xterm) +.EB lightgray .fi +.fam +.ps +1 +.if n \{\ .RE +.\} .PP -\fBExample\ 3.\ Matches any windows with the same CLASSNAME as the currently focused window\fR +\fBExample\ \&3.\ \&Matches any windows with the same CLASSNAME as the currently focused window\fR .sp +.if n \{\ .RS 4 +.\} +.fam C +.ps -1 .nf +.BB lightgray (Name=[current]) +.EB lightgray .fi +.fam +.ps +1 +.if n \{\ .RE +.\} .PP -\fBExample\ 4.\ Matches any windows on the same head as the mouse but on a different layer than the currently focused window\fR +\fBExample\ \&4.\ \&Matches any windows on the same head as the mouse but on a different layer than the currently focused window\fR .sp +.if n \{\ .RS 4 +.\} +.fam C +.ps -1 .nf +.BB lightgray (Head=[mouse]) (Layer!=[current]) +.EB lightgray .fi +.fam +.ps +1 +.if n \{\ .RE +.\} .SH "FILES" .PP -~/\.fluxbox/keys +~/\&.fluxbox/keys .RS 4 -This is the default location for the keybinding definitions\. +This is the default location for the keybinding definitions\&. .RE .PP -/usr/X11R6/include/X11/keysymdef\.h +/usr/X11R6/include/X11/keysymdef\&.h .RS 4 -X key names are in this file\. +X key names are in this file\&. .RE .PP /usr/X11R6/lib/X11/XKeysymDB .RS 4 -X key names are also in this file\. +X key names are also in this file\&. .RE .SH "RESOURCES" .PP -session\.keyFile: <location> +session\&.keyFile: <location> .RS 4 -This may be set to override the location of the keybinding definitions\. +This may be set to override the location of the keybinding definitions\&. .RE .SH "ENVIRONMENT" -Remember that \fBExecCommand\fR command can take advantage of other environment variables if they are set before fluxbox is started, or via the \fBExport\fR or \fBSetEnv\fR commands\. For example, if \fB$TERM\fR is set, it could be use like this: .sp +Remember that \fBExecCommand\fR command can take advantage of other environment variables if they are set before fluxbox is started, or via the \fBExport\fR or \fBSetEnv\fR commands\&. For example, if \fB$TERM\fR is set, it could be use like this: .sp +.if n \{\ .RS 4 +.\} +.fam C +.ps -1 .nf +.BB lightgray Mod1 x :ExecCommand $TERM +.EB lightgray .fi +.fam +.ps +1 +.if n \{\ .RE -For more information about environment variables, see your shell\'s manual\. +.\} .sp +For more information about environment variables, see your shell\'s manual\&. .SH "EXAMPLES" -Here are some interesting and/or useful examples you can do with your keys file\. .sp +Here are some interesting and/or useful examples you can do with your keys file\&. .sp +.if n \{\ .RS 4 +.\} +.fam C +.ps -1 .nf +.BB lightgray # Mod4+drag moves a window OnWindow Mod4 Mouse1 :StartMoving -# If any xterm windows are open, cycle through them\. If none are open, open +# If any xterm windows are open, cycle through them\&. If none are open, open # one: Mod4 t :If {Some Matches (xterm)} {NextWindow (xterm)} {Exec xterm} # Set a different wallpaper on every workspace: -ChangeWorkspace :Exec fbsetbg ~/\.fluxbox/bg$(xprop \-root _NET_CURRENT_DESKTOP | awk \'{print $3}\')\.png +ChangeWorkspace :Exec fbsetbg ~/\&.fluxbox/bg$(xprop \-root _NET_CURRENT_DESKTOP | awk \'{print $3}\')\&.png +.EB lightgray .fi +.fam +.ps +1 +.if n \{\ .RE -.SH "AUTHOR AND CREDITS" -This manpage is the combined work of: +.\} +.SH "AUTHOR and CREDITS" .sp +This manpage is the combined work of: .sp .RS 4 -\h'-04'\(bu\h'+03'Jim Ramsay <i\.am at jimramsay com> (>fluxbox\-1\.0\.0) +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Jim Ramsay <i\&.am at jimramsay com> (>fluxbox\-1\&.0\&.0) .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Curt Micol <asenchi at asenchi com> (>fluxbox\-0\.9\.11) +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Curt Micol <asenchi at asenchi com> (>fluxbox\-0\&.9\&.11) .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Tobias Klausmann <klausman at users sourceforge net> (⇐fluxbox\-0\.9\.11) +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Tobias Klausmann <klausman at users sourceforge net> (\(lafluxbox\-0\&.9\&.11) .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Grubert <grubert at users sourceforge net> (fluxbox) +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Grubert <grubert at users sourceforge net> (fluxbox) .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Matthew Hawkins <matt at mh dropbear id au> (blackbox) +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Matthew Hawkins <matt at mh dropbear id au> (blackbox) .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Wilbert Berendsen <wbsoft at xs4all nl> (blackbox) +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Wilbert Berendsen <wbsoft at xs4all nl> (blackbox) .RE .sp .RS 4 -\h'-04'\(bu\h'+03'Numerous other languages could be available if someone jumps in\. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Numerous other languages could be available if someone jumps in\&. .RE .SH "SEE ALSO" -fluxbox(1), xev(1), xkill(1), regex(7) .sp +fluxbox(1), xev(1), xkill(1), regex(7)