path: root/doc/fluxbox.1.in

'\" t
.\"     Title: fluxbox
.\"    Author: Henrik Kinnunen <fluxgen@fluxbox.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 08 February 2015
.\"    Manual: Fluxbox Manual
.\"    Source: fluxbox.txt
.\"  Language: English
.\"
.TH "FLUXBOX" "1" "08 February 2015" "fluxbox\&.txt" "Fluxbox Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * 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] [\-no\-slit] [\-no\-toolbar] [\-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 \(oqslit\(cq 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 \(oqsystray\(cq 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 \(oqkeys\(cq 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\-no\-slit\fR
.RS 4
Do not use the container for DockApps (aka the Slit)
.RE
.PP
\fB\-no\-toolbar\fR
.RS 4
Do not use the toolbar
.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\(cqs $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\(cqll see the defaults used by \fBfluxbox(1)\fR\&. These are what fluxbox looks for upon startup\&. In the list of \(lqDefaults:\(rq you\(cqll 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\(cqll 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\(cqll 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\(cqt be able to see the slit\&. It is there, but it isn\(cqt being used yet, which confuses some people initially\&. Think of it as a dock where you can place smaller programs\&. If you\(cqve 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 \(oqapps\(cq file or through the WindowMenu\&. We discuss the \(oqapps\(cq 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\(cqll 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\(cqs 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 \(oqgrouped\(cq by middle clicking and holding on a window\(cqs tab and dragging it onto another window\&. This \(oqtabbing\(cq 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 \(oqapps\(cq 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\(cqs 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\(cqs titlebar lets you drag to attach the window to another\(cqs 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\(cqs 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\(cqs 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\(cqs 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\(cqs 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\&.
.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 \(oqkeys\(cq file, \(oqinit\(cq 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
.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 \(oqinit\(cq 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\(cqs 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\(cqs 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 \(oqapps\(cq 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 \(oqstuck\(cq 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 \(oqicon\(cq 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\(cqs transparency, overriding the defaults from the
\fBConfiguration Menu\fR\&.
.RE
.PP
\fBRemember\&...\fR
.RS 4
Specify which window settings should be stored in the \(oqapps\(cq 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\(cqs 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\(cqs 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 currently 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 \(oqinit\(cq 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\&. Also, one is able to switch to the workspace left of the current one with a left click and to the workspace right of the current one with a right click\&.
.RE
.PP
\fBPrevWorkspace\fR
.RS 4
This displays an arrow that allows one to switch to the workspace left of the current one\&.
.RE
.PP
\fBNextWorkspace\fR
.RS 4
This displays an arrow that allows one 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 accessible in the Configuration part of the RootMenu or with a middle 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\(cqs 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\(cqs 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 width 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 \(oqinit\(cq 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 \(oqinit\(cq file
.RE
.sp
The last option in this submenu is:
.PP
\fBShow Pictures\fR:
.RS 4
If enabled the iconbar will show the application\(cqs 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\&.
.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
.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
.\}
.nf
bbmail \-w &
bbpager \-w &
wmdrawer &
exec fluxbox
.fi
.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\(cqs 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\&. Fluxbox uses 13 layers, starting from 1 (highest)\&.
.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 \(oqLayer \&...\(cq 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 \(oqapps\(cq 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\(cqll 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 BottomCenter BottomRight LeftBottom LeftCenter LeftTop RightBottom RightCenter RightTop TopLeft TopCenter TopRight\fR
.RE
.sp
Slit default:
\fBRightBottom\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 iconbar nextwindow prevwindow nextworkspace prevworkspace systemtray workspacename\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
for slit,
\fB1\fR
for toolbar
.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%k:%M\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|StrictMouseFocus\fR
.RS 4
This controls how windows gain focus via the mouse\&. With \(oqClickToFocus\(cq, the user must click on the window\&. With \(oqMouseFocus\(cq, windows gain focus whenever the mouse moves over them, but only when the mouse is moving\&. With \(oqStrictMouseFocus\(cq, windows gain focus whenever the mouse enters any exposed area, even if this is due to layer changes, window movement, changing desktops, closing windows, etc\&.
.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:
\fBFalse\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 \(oqapps\(cq 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:
\fBWorkspace 1, Workspace 2, Workspace 3, Workspace 4\fR
.RE
.PP
\fBsession\&.screen0\&.edgeSnapThreshold\fR: \fIinteger\fR
.RS 4
When moving a window across your screen, fluxbox is able to have it \(oqsnap\(cq to the edges of the screen and other windows for easy placement\&. This variable tells fluxbox the distance (in pixels) at which the window will jump to the edge\&.
.sp
Default:
\fB10\fR
.RE
.PP
\fBsession\&.screen0\&.edgeResizeSnapThreshold\fR: \fIinteger\fR
.RS 4
When resizing a window by grabbing a corner, fluxbox is able to have it \(oqsnap\(cq to the edges of the screen and other windows for easy placement\&. This variable tells fluxbox the distance (in pixels) at which the window corner will jump to the edge\&.
.sp
Default:
\fB0\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 \(oqapps\(cq 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\(cqs 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\(cqs 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 \(oqWindow\(cq, windows may be grouped by dragging one tab with the middle mouse button and dropping it anywhere on another window\&. With \(oqTitlebar\(cq, the user must drop the tab on the target window\(cqs 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 Maximize MenuIcon Minimize Shade Stick LHalf RHalf\fR
.RE
.sp
Default left:
\fBStick\fR
.sp
Default right:
\fBShade Minimize Maximize Close\fR
.sp
\fILHalf\fR
and
\fIRHalf\fR
are buttons to quickly place a window into the left and right half of the current monitor\&.
.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\(cqs \fB~/\&.fluxbox\fR directory\&.
.PP
\fBsession\&.appsFile\fR: \fIlocation\fR
.RS 4
Location of persistent application settings, or the \(oqapps\(cq 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 \(oqapps\(cq 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 \(oqkeys\(cq 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
.PP
\fBsession\&.menuSearch\fR: \fBnowhere\fR|\fBitemstart\fR|\fBsomewhere\fR
.RS 4
This setting controls the way the menu search feature works\&.
.RE
.PP
Available options:
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
nowhere: disables the menu search
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
itemstart: typed text matches at the start of a menu items
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
somewhere: typed text matches somewhere in a menu item
.RE
.RE
.sp
+ Default: \fBitemstart\fR
.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 \(oqkeys\(cq file \fBExecCommand\fR or the root menu\(cqs \fB[exec]\fR tag\&. See \fBfluxbox\-keys(5)\fR and \fBfluxbox\-menu(5)\fR for details\&.
.sp
The \(oqkeys\(cq 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\(cqs 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
.\}
SIGUSR1 restarts fluxbox\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
SIGUSR2 Forces reloading of configuration\&.
.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)
.SH "AUTHOR"
.PP
\fBHenrik Kinnunen\fR <\&fluxgen@fluxbox\&.org\&>
.RS 4
Author.
.RE