all repos — fluxbox @ a85866175a368c14c7b0e9294c98e5676647e161

custom fork of the fluxbox windowmanager

Created fluxbox-menu(5)

This separates the menu-syntax portions of fluxbox.txt out into its own man
page, and includes a rather large rewrite of much of fluxbox.txt, as well as
small improvements in other pages.
Jim Ramsay i.am@jimramsay.com
commit

a85866175a368c14c7b0e9294c98e5676647e161

parent

6beb1f96b25cd4ce23395d6666aa8ea22038817e

M doc/Makefile.amdoc/Makefile.am

@@ -2,12 +2,12 @@ # doc/Makefile.am for Fluxbox 0.9 - an X11 Window manager

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

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

# SRC1 = fluxbox.txt fluxbox-remote.txt -SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt +SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt MAN = $(SRC1:.txt=.1.in) $(SRC5:.txt=.5.in)
M doc/asciidoc/fluxbox-apps.txtdoc/asciidoc/fluxbox-apps.txt

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

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

@@ -27,10 +27,13 @@ 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. +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. + +You do not need to ``reload'' fluxbox after editing the apps file, the changes +should be rescanned when the next window is opened. The file is made up of two main types of sections, apps and groups, detailed below.
M doc/asciidoc/fluxbox-keys.txtdoc/asciidoc/fluxbox-keys.txt

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

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

@@ -40,6 +40,9 @@ key names are case-sensitive.

Lines beginning with a '#' or '!' are considered comments and are unread by fluxbox. + +You will need to ``reload'' fluxbox after editing the keys file so it picks up +your change. MODIFIERS ---------

@@ -418,17 +421,26 @@ ~~~~~~~~~~~~~

These commands open or close fluxbox popup menus. For more information on what these menus contain or how to configure them, see 'fluxbox(1)'. -*RootMenu* / *WorkspaceMenu* / *WindowMenu*:: - Opens the specified menu. See fluxbox(1) for more details on what - these menus contain. +*RootMenu*;; + Opens the root menu. See *ROOT MENU* in *fluxbox-menu(5)* for details. + +*WorkspaceMenu*;; + Opens a menu showing all workspaces and windows. See *Workspace Menu* in + *fluxbox(1)* for details. + +*WindowMenu*;; + Opens a menu containing actions for the current window. See *WINDOW MENU* in + *fluxbox-menu(5)* for details. *ClientMenu* ['pattern']:: - Opens a menu that contains all windows. If you specify a 'pattern', - only matching windows will be in the menu. See *CLIENT PATTERNS* - below for more details on the 'pattern' argument. + Opens a menu that contains all windows. If you specify a 'pattern', only + matching windows will be in the menu. Selecting a window will jump to that + workspace and raise the window. See *CLIENT PATTERNS* below for more details + on the 'pattern' argument. *CustomMenu* 'path':: - Opens a custom menu file. + Opens a custom menu file. This 'path' must be a valid menu file in the same + format as detailed by the *ROOT MENU* section of *fluxbox-menu(5)*. *HideMenus*:: Hide all fluxbox popup menus.

@@ -466,8 +478,9 @@ 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. + as in *\~/.fluxbox/startup*), or any that are set via the *Export* or + *SetEnv* commands, below. See *fluxbox(1)* for more details on the + *ENVIRONMENT* and *\~/.fluxbox/startup* file. *CommandDialog*:: Pops up a dialog box that lets you type in any of these commands

@@ -568,16 +581,16 @@ include::client-patterns.txt[]

FILES ----- -~/.fluxbox/keys:: +*\~/.fluxbox/keys*:: This is the default location for the keybinding definitions. -/usr/X11R6/include/X11/keysymdef.h:: +*/usr/X11R6/include/X11/keysymdef.h*:: X key names are in this file. -/usr/X11R6/lib/X11/XKeysymDB:: +*/usr/X11R6/lib/X11/XKeysymDB*:: X key names are also in this file. RESOURCES --------- -session.keyFile: <location>:: +*session.keyFile:* 'location':: This may be set to override the location of the keybinding definitions. ENVIRONMENT
A doc/asciidoc/fluxbox-menu.txt

@@ -0,0 +1,345 @@

+fluxbox-menu(5) +=============== +Jim Ramsay <i.am@jimramsay.com> +v1.1.2, 12 February 2009 +:man source: fluxbox-menu.txt +:man version: {revision} +:man manual: Fluxbox Manual + +NAME +---- +fluxbox-menu - fluxbox(1) menu syntax + +SYNOPSIS +-------- +@pkgdatadir@/menu + +~/.fluxbox/menu + +~/.fluxbox/windowmenu + +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 +----------- +There are two types of menus in fluxbox which can be configured. + +The first is the root menu, which normally appears when you right-click on the +desktop. + +The first is the *ROOT MENU* (Or right-click menu), is usually bound to a +right-click on the desktop, though this binding can be changed in the `keys' +file (*fluxbox-keys(5)*). This same syntax is used for the *CustomMenu* command, +also mentioned in *fluxbox-keys(5)*. + +Fluxbox installs a default root menu file in *@pkgdatadir@/menu*. You can also +use fluxbox -i to confirm this location. Of course this system-wide menu can be +customized for all users at once, but it is also possible to create an +individual menu file for each user. By convention, users create a menu file in +*~/.fluxbox/menu*. Once you've created your own menu file, you'll want to make +sure that you properly declare this location in your `init' file so that fluxbox +knows where to look. See *RESOURCES*, below for details. + +The second type is the *WINDOW MENU*, which defines the contents of the menu +which appears when you right-click on a window's titlebar or iconbar. This opens +a menu file as defined by *~/.fluxbox/windowmenu*. If this file does not exist, +fluxbox will copy in the default from *@pkgdatadir@/windowmenu*. + +You do not need to ``reload'' fluxbox after editing the apps file, the changes +should be taken into account the next time you open the menu. + +ROOT MENU +--------- +The root menu must begin with a *[begin]* tag and end with an *[end]* tag, and +every tag must be on its own line. + +There are up to four fields in a menu line. They are of the form::: + ['tag'] ('label') {'command'} <'icon'> + +The <'icon'> field is always optional when show below. If specified, the 'icon' +will be scaled down and displayed in the menu alongside the text label of the +item. It must be in .xpm or .png format. + +Any line that starts with a '#' or '!' is considered a comment and ignored by +fluxbox. Also, in the label/command/filename fields you can escape any +character. Using '\\' inserts a literal back-slash into the +label/command/filename field. + +You may enter labels, commands, and icons using characters from any *iconv(1)* +language/locale by specifying the encoding used via the *[encoding]* tag, +detailed below. + +Structural Tags +~~~~~~~~~~~~~~~ +*[begin]* ('title');; + This tells fluxbox to start parsing the menu file. This tag is required for + fluxbox to read your menu file. If it cannot find it, the system default menu + is used in its place. The 'title' appears at the top of the menu. And *[end]* + tag is required to end the menu. + +*[submenu]* ('label') {'title'} <'icon'>;; + This tells fluxbox to create and parse a new menu, which is inserted as a + submenu into the parent menu. These menus are parsed recursively, so there is + no limit to the number of levels or nested submenus you can have. The 'label' + is the text that will appear in the parent menu, and the 'title' is shown at + the top of the submenu. If omitted, the 'title' will be the same as the + 'label'. An *[end]* tag is required to end the submenu. + +*[end]*;; + This tells fluxbox that it is at the end of a menu. This can either be a + *[submenu]* or the *[begin]* tag of the main root menu. There must be at + least one of these tags in your menu to correspond to the required *[begin]* + tag, and one for each *[submenu]*. + +*[encoding]* {'encoding'};; + This begins an *[encoding]* section and specifies the string encoding of + all strings until the matching *[endencoding]* tag. For a list of available + encodings on your system, run *iconv -l*. + +*[endencoding]*;; + This ends an *[encoding]* section. + +*[include]* ('path');; + Parses the file specified by filename inline with the current menu. The + 'path' can be the full path to a file or it can begin with *~/*, which will + be expanded into your home directory. If 'path' is a directory, then all + files in that directory are included. + +*[separator]*;; + This will create a nice separation line. Useful for splitting up sections in + a ``pretty'' way. The optional 'comment' is not displayed, but can be useful + for internal documentation or script parsing of menu files. + +*[nop]* ('label') <'icon'>;; + Insert a non-operational item into the current menu. This is much like + *[separator]*, but instead of a line, it inserts a 'label'. This can be used + to help format the menu into blocks or sections if so desired. The 'label' is + optional, and if omitted a blank item will be inserted. + +Applications +~~~~~~~~~~~~ +*[exec]* ('label') {'command...'} <'icon'>;; + Inserts a command item into the menu. When you select the menu item from the + menu, fluxbox runs 'command...' in your *$SHELL* (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 te 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). + +Fluxbox Functions +~~~~~~~~~~~~~~~~~ +*[config]* ('label') <'icon'>;; + Inserts a fluxbox native submenu item, containing numerous configuration + options concerning window placement, focus style, window moving style, etc. + See *Configuration Menu* in *fluxbox(1)* for details. + +*[reconfig]* ('label') <'icon'>;; + When selected this item re-reads the current style and menu files and applies + any changes. This is useful for creating a new style or theme, as you don't + have to constantly restart fluxbox every time you save your style. However, + fluxbox automatically rereads the menu whenever it changes. + +*[restart]* ('label') {'command'} <'icon'>;; + This tells fluxbox to restart. If 'command' is supplied, it shuts down and + runs the command (which is commonly the name of another window manager). If + 'command' is omitted, fluxbox restarts itself. + +*[exit]* ('label') <'icon'>;; + Inserts an item that shuts down and exits fluxbox. Any open windows are + reparented to the root window before fluxbox exits. + +*[style]* ('label') {'filename'} <'icon'>;; + This tells fluxbox to insert an item that, when selected, reads style file + named filename and apply the new textures, colors and fonts to the current + running session. + +*[stylesmenu]* ('directory') <'icon'>;; + Reads all filenames from the specified directory, assuming that they are all + valid style files, and creates inline menu items in the current menu for + every filename, that, when selected by the user will apply the selected style + file to the current session. The labels that are created in the menu are the + filenames of the style files. + +*[stylesdir]* ('label') {'directory'} <'icon'>;; + Creates a submenu entry with 'label' (that is also the title of the new + submenu), and inserts in that submenu all filenames in the specified + 'directory', assuming that they are all valid style files (directories are + ignored) in the same way as the *[stylesdir]* command does. Both + *[stylesdir]* and *[stylesmenu]* commands make it possible to install style + files without editing your init file. + +*[wallpapers]* ('directory') {'command'} <'icon'>;; + This inserts a menu item to set the wallpaper for each file in the given + directory. The 'command' is optional, and defaults to *fbsetbg*. + +*[workspaces]* ('label') <'icon'>;; + This tells fluxbox to insert a link to the workspaces menu directly into your + menu. See *Workspace Menu* in *fluxbox(1)* for details. + +*[*'command'*]* ('label') <'icon'>;; + In addition to the commands above, any legal keys file 'command' may be used + as a menu item. See *fluxbox-keys(5)* for more information. + +WINDOW MENU +----------- +Like the *ROOT MENU*, this menu file must start with *[begin]* and end with +*[end]*. However, this file consists of only one *[*'tag'*]* per line with no +labels, commands, or icons. + +The available tags in this menu are: + +*[shade]*;; + Provides a menu item to shade or unshade (or, roll-up) the window. This is + equivalent to the shade titlebar button. + +*[stick]*;; + Provides a menu item to stick or unstick the window. Stuck windows are + displayed on all workspaces. This is equivalent to the stick titlebar button. + +*[maximize]*;; + Provides a menu item to maximize or unmaximize the window, equivalent to the + maximize titlebar button. The button with which you click alters the + behaviour of this item as follows: + + * Button 1 (Un)Maximize as normal. + * Button 2 (Un)Maximize window vertically. + * Button 3 (Un)Maximize window horizontally. + +*[iconify]*;; + Provides a menu item to iconify (or, minimize) the window, equivalent to the + iconify titlebar button. + +*[close]*;; + Closes the window gracefully, equivalent to the titlebar button. + +*[kill]*;; + Kills the window's process, like *xkill(1)*. + +*[raise]*;; + Raise the window to the top of the stack within its layer. + +*[lower]*;; + Lower the window to the bottom of the stack within its layer. + +*[settitledialog]*;; + Opens a dialog which can be used to set the window's title. Some applications + may re-set their own title from time-to-time, wiping out your setting. + +*[sendto]*;; + Sends the window to a different workspace. When you select the workspace with + a middle-click, fluxbox will also change to the new workspace. A regular + click only sends the window. + +*[layer]*;; + Adds a ``Layer...'' submenu which lets you change the layer of this window. + +*[alpha]*;; + Adds a ``Transparency...'' submenu which lets you change the focused and + unfocused transparency of this window. + +*[extramenus]*;; + Adds the ``Remember...'' menu item, which allows you to specify which + settings should be stored in the `apps' file (See *fluxbox-apps(5)* for more + details). + +*[separator]*;; + Adds a horizontal line to the menu + +FILES +----- +*~/.fluxbox/menu*:: + This is the default location for the user's root menu. +*@pkgdatadir@/menu*:: + This is the system-wide root menu file. It will be used if the user's root + menu is missing or unparseable. +*~/.fluxbox/windowmenu*:: + This is the user's window menu definition file +*@pkgdatadir@/menu*:: + This is the default window menu. If the user does not have this file, it will + be copied to *~/.fluxbox/windowmenu* on fluxbox startup. + +RESOURCES +--------- +*session.menuFile:* 'location':: + This may be set to override the location of the user's root menu. + +ENVIRONMENT +----------- +The 'comand...' field of the *[exec]* tag can take advantage of other +environment variables if they are set before fluxbox is started. + +EXAMPLES +-------- +.Root Menu +.... +# fluxbox menu file +[begin] (fluxbox) + [exec] (rxvt) {rxvt -ls} </usr/X11R6/share/icons/terminal.xpm> + [exec] (netscape) {netscape -install} + [exec] (The GIMP) {gimp} + [exec] (XV) {xv} + [exec] (Vim) {rxvt -geometry 132x60 -name VIM -e screen vim} + [exec] (Mutt) {rxvt -name mutt -e mutt} + [submenu] (mozilla) + [exec] (browser) {mozilla -browser} + [exec] (news) {mozilla -news} + [exec] (mail) {mozilla -mail} + [exec] (edit) {mozilla -edit} + [exec] (compose) {mozilla -compose} + [end] + [submenu] (Window Manager) + [exec] (Edit Menus) {nedit ~/.fluxbox/menu} + [submenu] (Style) {Which Style?} + [stylesdir] (~/.fluxbox/styles) + [stylesmenu] (fluxbox Styles) {@pkgdatadir@/styles} + [end] + [config] (Config Options) + [reconfig] (Reconfigure) + [restart] (Restart) + [end] + [exit] (Log Out) +[end] +.... + +.Default Window Menu +.... +[begin] + [shade] + [stick] + [maximize] + [iconify] + [raise] + [lower] + [settitledialog] + [sendto] + [layer] + [alpha] + [extramenus] + [separator] + [close] +[end] +.... + +AUTHOR and CREDITS +------------------ +This manpage is the combined work of: + +- Jim Ramsay <i.am at jimramsay com> (>fluxbox-1.1.1) +- 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) +
M doc/asciidoc/fluxbox-remote.txtdoc/asciidoc/fluxbox-remote.txt

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

fluxbox-remote(1) ================= Mark Tiefenbruck <mark@fluxbox.org> -v1.1.1, 10 February 2009 +v1.1.2, 10 February 2009 :man source: fluxbox-remote.txt :man version: {revision} :man manual: Fluxbox Manual
M doc/asciidoc/fluxbox-style.txtdoc/asciidoc/fluxbox-style.txt

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

fluxbox-style(5) ================ Henrik Kinnunen <fluxgen@fluxbox.org> -v1.1.1, 10 February 2009 +v1.1.2, 10 February 2009 :man source: fluxbox-style.txt :man version: {revision} :man manual: Fluxbox Manual
M doc/asciidoc/fluxbox.txtdoc/asciidoc/fluxbox.txt

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

fluxbox(1) ========== Henrik Kinnunen <fluxgen@fluxbox.org> -v1.1.1, 10 February 2009 +v1.1.2, 10 February 2009 :man source: fluxbox.txt :man version: {revision} :man manual: Fluxbox Manual

@@ -12,90 +12,103 @@ fluxbox - A lightweight window manager for the X Windowing System

SYNOPSIS -------- -'fluxbox' [-rc rcfile] - [-log logfile] - [-display display] - [-screen scr,scr|all] +*fluxbox* [-rc 'rcfile'] + [-log 'logfile'] + [-display 'display'] + [-screen all|'scr','scr'...] [-verbose] [-sync] -'fluxbox' [-v | -version] | +*fluxbox* [-v | -version] | [-h | -help] | [-i | -info] | [-list-commands] DESCRIPTION ----------- -fluxbox(1) 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. The `slit' can be used to dock small applications; e.g. -most of the bbtools can use the slit. +*fluxbox(1)* 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. +Fluxbox can iconify (or minimize) windows to the toolbar One click and they +reappear. A double-click on the titlebar of the window will 'shade' it; i.e. the +window will disappear, and only the titlebar will remain visible. -fluxbox(1) can iconify windows to the toolbar, in addition to adding the window -to the 'Icons' submenu of the workspace menu. One click and they reappear. A -double-click on the titlebar of the window will 'shade' it; i.e. the window -will disappear, and only the titlebar will remain visible. +There are also two areas commonly used by small applets: the `slit' can be used +to dock small applications; e.g. most of the ``bbtools'' and ``Window Maker +dockapps'' can use the slit, and the `systray' which lives in the toolbar +supports standard system tray icons provided by some applications. - -fluxbox(1) uses its own graphics class to render its images on the fly. By using +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. +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 +*fluxbox-keys(5)* for details. -fluxbox(1) supports the majority of the Extended Window Manager Hints (EWMH) +Fluxbox can also remember certain attributes of individual application +windows and restore these settings the next time the window opens. See +the *fluxbox-apps(5)* for details. + +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. OPTIONS ------- --display display:: +*-display* 'display':: Start fluxbox on the specified display. Programs started by fluxbox will share the DISPLAY environment variable also. --h, -help:: +*-h*, *-help*:: Display command line options. --i, -info:: +*-i*, *-info*:: Display useful information concerning the defaults and compiled-in options. --log logfile:: +*-log* 'logfile':: Starting fluxbox with this option will designate a file in which you want to log events to. --rc rcfile:: - Use a different config file other than the default ~/.fluxbox/init. --v, -version:: +*-rc* 'rcfile':: + Use a different config file other than the default *\~/.fluxbox/init*. +*-v*, *-version*:: The version of fluxbox installed. --screen scr,scr|all:: +*-screen* all|'scr','scr'...:: Run on specified screens only or all (by default). --verbose:: +*-verbose*:: Print more information in process. --sync:: +*-sync*:: Synchronize with the X server for debugging. +*-list-commands*:: + Lists all available internal commands. STARTING FLUXBOX ---------------- -fluxbox(1) comes with a program called startfluxbox(8) usually located wherever -you installed fluxbox. This script provides you with many options and +*fluxbox(1)* comes with a program called *startfluxbox(8)* 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 "exec startfluxbox" in your ~/.xinitrc or -~/.xsession (depending on your distribution and/or display manager) as the last -executed command. This is assuming that the location of fluxbox(1) and -startfluxbox(8) are in your shell's $PATH. Also note that you may need to -create the ~/.xinitrc file or your setup may use ~/.xsession instead, -depending on your X setup. For more information on your shell, please visit -your shell's manual page. +begin using it, you should place ``exec startfluxbox'' in your *\~/.xinitrc* as +the last executed command. This is assuming that the location of *fluxbox(1)* +and *startfluxbox(8)* are in your shell's $PATH. Also note that you may need to +create the *\~/.xinitrc* file or your setup may use *\~/.xsession* instead, +depending on your X setup. Some X login managers like *gdm(1)* or *kdm(1)* may +simply provide a ``Fluxbox'' session for you without having to alter any +settings. -By using fluxbox -i you'll see the defaults used by fluxbox(1). These are what -fluxbox looks for upon startup. In the list of `Defaults:' you'll see a menu +By using fluxbox -i you'll see the defaults used by *fluxbox(1)*. These are what +fluxbox looks for upon startup. In the list of ``Defaults:'' you'll see a menu file location, this is where you can provide a system-wide menu file for your users. On exit or restart, fluxbox will save user defaults in the file -~/.fluxbox/init. Resources in this file can be edited by hand. fluxbox also -has many tools to edit these; look through the main menu once fluxbox has -started to find different ways of managing your session. +*\~/.fluxbox/init*. Resources in this file can also be edited by hand, see the +*RESOURCES* section for more details. *fluxbox(1)* also has many tools to edit +these; look through the main menu once fluxbox has started to find different +ways of managing your session. USING FLUXBOX -------------

@@ -110,46 +123,47 @@ develop your understanding of what you can do with fluxbox.

Root Window (Main) ~~~~~~~~~~~~~~~~~~ -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 RootMenu. A middle click (mouse button 2) on -the desktop shows you the WorkspaceMenu. +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. -RootMenu and WorkspaceMenu +Root Menu and Workspace Menu ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From the RootMenu you can launch applications and configure fluxbox. The WorkspaceMenu shows all windows and on which workspaces they are. See -section MENUS on how to customize these menus. +section *MENUS* on how to customize these menus. Toolbar ~~~~~~~ -The toolbar contains any combination of the following tools: +The toolbar contains any combination of the following tools, by default in this +order: - *Workspace Name*: Name of the current visible workspace +- *Workspace Arrows*: + Previous/Next Workspace - *Iconbar*: List of windows managed by fluxbox +- *Window Arrows*: + Previous/Next Application Window - *System Tray*: Area for applets - *Clock*: Date and Time -- *Workspace Arrows*: - Previous/Next Workspace -- *Window Arrows*: - Previous/Next Application Window -The contents of the toolbar can be configured in the `init' file. We -discuss the `init' file at great length in the RESOURCES section. +The contents and behavior of the toolbar can be configured, see the *TOOLBAR* +section for details. Slit ~~~~ Initially you won't be able to see the slit. It is there, but it isn't -being used yet. The slit confuses some people initially. Think of it as a dock +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 section below that goes into -detail about the options you have. +To learn more about the slit, we have an entire *SLIT* section below that goes +into detail about the options you have. Layers ~~~~~~

@@ -165,26 +179,26 @@

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 *fluxbox-apps(5)*. -We discuss the WindowMenu in the MENUS section. We discuss layers in more detail -in the LAYERS section. +through the WindowMenu. We discuss the `apps' file in *fluxbox-apps(5)*. We +discuss the WindowMenu in the *MENUS* section. We discuss layers in more detail +in the *LAYERS* section. Focus Model ~~~~~~~~~~~ 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 -FOCUS MODEL section. +*FOCUS MODEL* section. Windows ~~~~~~~ -A left click (mouse button 1) on any part of the window's border will +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 Window Menu section of MENUS. +in detail in the *Window Menu* section. Tabs ~~~~

@@ -197,143 +211,226 @@ titlebar or moved to other locations on the outside of the window. Configuration

is discussed in TAB OPTIONS section. You can also set up automatic grouping using the `apps' file. See *GROUP -SECTIONS* in fluxbox-apps(5) for details. +SECTIONS* in *fluxbox-apps(5)* for details. + +Key Bindings +~~~~~~~~~~~~ +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 +*fluxbox-keys(5)* for details on how to do this. + +The default bindings set up by fluxbox are as follows: + +Mouse clicks on the empty desktop: + +- *Left-click* (Button 1): hides all fluxbox menus +- *Middle-click* (Button 2): shows the Workspace Menu +- *Right-click* (Button 3): shows the Root Menu +- *Scroll wheel* (Buttons 4 and 5): jump to the previous/next workspace + +Mouse gestures on a window: + +- *ALT+Drag Left-click* anywhere on a window moves the window. +- *ALT+Drag Right-click* anywhere on a window resizes the window. +- *ALT+Middle-click* anywhere on a window lowers the current window. + +Mouse gestures on a window's titlebar: + +- *CTRL+Drag Left-click* on a window's titlebar lets you drag to attach the + window to another's tab group +- *Double Left-click* on a window's titlebar shades the window +- *Middle-click* on a window's titlebar lowers the window +- *Right-click* on a window's titlebar pops up the *Window Menu* + +Mouse gestures on the toolbar: + +- *Scroll wheel* on the toolbar cycles through windows + +Keyboard bindings: + +- *ALT+Tab* / *ALT+Shift+Tab*: Cycle through windows +- *WIN+Tab* / *WIN+Shift+Tab*: Cycle through tabs +- *Win+1* -> *Win+9*: Select the 1st -> 9th tab in the current window +- *ALT+F1*: Run *xterm(1)* to open a new terminal +- *ALT+F2*: Run *fbrun(1)* for a small ``run program'' dialog +- *ALT+F4*: Close the current window +- *ALT+F5*: Kill the current window (like *xkill(1)*) +- *ALT+F9*: Minimize (iconify) the current window +- *ALT+F10*: Maximize the current window +- *ALT+F11*: Full-screen the current window +- *ALT+Space*: Open the *Window Menu* +- *CTRL+ALT+Del*: Exit fluxbox (log out) +- *CTRL+ALT+Left* / *CTRL+ALT+Right*: Go to the previous/next workspace +- *WIN+Left* / *WIN+Right*: Send the current window to the previous/next + workspace, but remain on this workspace +- *CTRL+WIN+Left* / *CTRL+WIN+Right*: Take the current window to the previous/next + workspace, and switch to that workspace +- *CTRL+F1* -> *CTRL+F12*: Switch to the 1st -> 12th workspace +- *WIN+F1* -> *WIN+F12*: Send the current window to a specific workspace +- *CTRL+WIN+F1* -> *CTRL+WIN+F12*: Take the current window to a specific workspace MENUS ----- -fluxbox installs a default menu file in @pkgdatadir@/menu. You can also use -fluxbox -i to confirm this action. Of course this system-wide menu can be -customized for all users at once, but it is also possible to create an -individual menu file for each user. By convention, users create a menu file in -~/.fluxbox/menu . Once you've created your own menu file, you'll want to make -sure that you properly declare this location in your `init' file so that fluxbox -knows where to look. The value you'll want to add or change is: +fluxbox provides a popup menu facility that is used by a few different types of +native menus. - session.menuFile: <menufile> +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). -For this change to take effect, fluxbox must be restarted. Be sure that your -menu is usable, then choose `Restart' from the default fluxbox root menu. This -restart is only necessary if you make changes to the `init' file; otherwise, -fluxbox will automatically detect your changes. +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 ``enter'' to activate the +item. + +Normally activating a menu item should close the menu. You can also right-click +the title are of a menu or press ``esc'' to close it without activating an item. Root Menu ~~~~~~~~~ -The root menu is where you can change different aspects of fluxbox by -simply clicking on a menu item. Most of the changes in this menu can also -be done in the `init' file. However it makes it very easy to change -certain options without having to open up an editor and find the resource. -In the root menu, you usually have a `fluxbox menu' or `Settings' submenu, -where you will find lots of different options. We'll take a look at most, -if not all, of those here. +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. + +The contents of this menu can be configured, see *fluxbox-menu(5)* for details. + +The default menu, which is created by the ``fluxbox-generate_menu'' command, +contains menus for installed applications, as well as a special ``Fluxbox menu'' +item with the items detailed below: -- *Configure*: +*Configure*:: 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. + really begin to customize the look and feel of your desktop. See the + *Configure Menu* section below for more details. -- *System Styles*: - This is where the standard styles are listed. You can select one of these - by clicking on it. You may have to `reload' the config or `restart' to get - every graphical element to change to the new style. System styles are - located in @pkgdatadir@/styles/ upon a default install. - Remember that you can confirm this with fluxbox -i. +*System Styles*:: + 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 *@pkgdatadir@/styles/* upon a default install. Remember that you + can confirm this with fluxbox -i. -- *User Styles*: - ~/.fluxbox/styles This is the location where you will store new styles - that you grab from the Internet. If you create your own styles this is - also where you will put yours (provided that you follow the 'standards' - described in fluxbox-style(5)). +*User Styles*::: + This is where your custom styles are listed. It will list any styles from + *\~/.fluxbox/styles/*, which may be styles you grab from the Internet, or + your own custom styles, provided you follow the standards described in + *fluxbox-style(5)*. -- *Workspace List*: - This is a list of the workspaces configured in your `init' file. If there - are programs running on any of the workspaces, they will be listed one - level down. +*Workspace List*::: + This is the same as the *Workspace Menu* detailed below. -- *Tools*: +*Tools*::: Listed here are different tools that you can use. You can rename your workspace, run programs from a command line or regenerate your menu. -- *Window*: +*Window Managers*::: Allows you to switch your window manager. (Only listed if you have other window managers/desktop environments installed.) -- *Lock Screen*: - Locks the screen... +*Lock Screen*::: + Locks the screen, if a suitable locking program has been detected. -- *fluxbox Command*: - A little Commandline will popup where you can enter a fluxbox command. +*Fluxbox Command*::: + A little Commandline will popup where you can enter a fluxbox command. These + commands are the same as those detailed in *fluxbox-keys(5)*. -- *Reload Config*: - Use this to reload any menu files or style files. Just a basic re-read of - the files by a running fluxbox. +*Reload config*::: + Use this to reload the fluxbox configuration files. You must do this after + editing the `keys' file, `init' file, or the current style. -- *Restart*: +*Restart*::: 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. + remain open, however, and restored to the same workspaces they were + previously in once fluxbox returns. -- *Exit: - Exits fluxbox and probably shuts down the X Window server. +*Exit*::: + Exits fluxbox, which in turn either shuts down the X Window server or + returns you to the graphical login screen. Configuration Menu ~~~~~~~~~~~~~~~~~~ This menu offers the opportunity to set up fluxbox. It contains many options -from the init file, but this is an easier and faster way for most users. - -- *Focus Model*: - Please read the FOCUS MODEL section at the end of this manual. +which can be altered manually in the `init' file, but this is an easier and +faster way to change the most common settings. -- *Tab Options*: - Lets you configure the properties of tabs. Detailed in TAB OPTIONS - section. +All changes take effect immediately. -- *Slit*: - This Menu can be opened by right clicking the slit (if visible). Find more - information about this menu's options in the SLIT section. +*Focus Model*::: + Lets you configure the window focus model. For details, see *FOCUS MODEL*, + below. -- *Toolbar*: - Please take a look at the "Configuration via the Toolbar Menu" part of the - TOOLBAR section. +*Maximize Options*::: +Lets you configure what happens when you maximize a window. The four +options are: ++ +-- + *Full Maximization*:;; + 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. + *Ignore Resize Increment*:;; + Normally, terminal windows specify a ``resize increment'' 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. + *Disable Moving* / *Disable Resizing*:;; + Normally, maximized windows can still be moved and resized. Enabling these + options prevents these behaviour. +-- -- *Transparency*: - This sets the transparency for a focused, unfocused window and the menu. +*Tab Options*::: + Lets you configure the properties of tabs. Detailed in *TAB OPTIONS*, + below. -- *Opaque Window Moving*: - If enabled, you will see the window content while dragging it. Otherwise - the window will be shown as a "border". +*Slit*::: + This menu can also be found by right-clicking the slit (if visible). Find more + information about this menu's options in the *Slit Menu* section, below. -- *Full Maximization*: - Enabling this will override the separate settings for the slit/toolbar. - Windows will always maximize over/under both of them. +*Toolbar*::: + 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 *Toolbar + Menu* section, below. -- *Focus New Window*: - If enabled, a newly opened window will gain focus. +*Transparency*::: +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. ++ +The transparency of individual application windows can be overridden in the +`apps' file (*fluxbox-apps(5)*). ++ +The *Force Pseudo Transparency* 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. -- *Windows Warping*: - If enabled, you can drag windows from one workspace to another. +*Opaque Window Moving*::: + If enabled, you will see the window content while dragging it. Otherwise + only an outline of the window will be shown. -- *Click Raises*: - If enabled a click anywhere on a window area (including the decorations) - will raise it. Otherwise you can only raise it by clicking the titlebar. +*Workspace Warping*::: + 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. Window Menu ~~~~~~~~~~~ The Window menu is displayed when you right click on the titlebar of a window. -The options available are: + +To customize this menu, see the *WINDOW MENU* section of *fluxbox-menu(5)*. + +By default, this menu contains: + +*Shade*::: + Shade the window (display the titlebar only). -- *Send To...*: +*Stick*::: + (Un)Stick window. A `stuck' window will always be displayed on all + workspaces. + +*Send To...*::: 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. -- *Shade*: - Shade the window (display the titlebar only). - -- *Iconify*: - Iconify 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). - -- *Maximize*: +*Maximize*::: (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.

@@ -342,353 +439,436 @@ * Button 1 (Un)Maximize as normal.

* Button 2 (Un)Maximize window vertically. * Button 3 (Un)Maximize window horizontally. -- *Raise*: - Raise the window. +*Iconify*::: + 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). -- *Lower*: - Lower the window. +*Raise*::: + Raise the window above all others in the same layer. -- *Stick*: - (Un)Stick window. A `stuck' window will always be displayed on all - workspaces. +*Lower*::: + Lower the window below all others in the same layer. -- *Layer...*: - Change the layer of this window. +*Layer...*::: + Change the layer of this window. See *LAYERS* for more details. + +*Transparency*::: + Change this window's transparency, overriding the defaults from the + *Configuration Menu*. + +*Remember...*::: +Specify which window settings should be stored in the `apps' file and +resumed the next time this window is opened. ++ +Specifically the setting you may store are: ++ +-- +*Workpace:*;; + Open this in the same workspace as where the window currently resides. +*Jump to workspace:*;; + When *Workspace* 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. +*Head*:;; + For xinerama users only, start this window on the current head (or screen). +*Dimensions*:;; + Record the current window height and width. +*Position*:;; + Record the current X and Y coordinates of the window. +*Sticky*:;; + Record whether the window is on all desktops, or not. +*Decorations*:;; + Record the current set of decorations (title bar, grips, tabs, etc) on the window. +*Shaded*:;; + Record whether the window is shaded (or rolled-up) or not. +*Minimized*:;; + Record whether the window is iconified (or minimized) or not. +*Maximized*:;; + Record whether the window is maximized or not. +*Fullscreen*:;; + Record whether the window is in fullscreen mode or not. +*Transparency*:;; + Record the current *Transparency* settings. +*Layer*:;; + Record the current layer. +*Save on close*:;; + If selected, any of the above items which are also selected will be updated + with the window's current values as it is closed. -- *Remember...*: - Specify which window settings should be stored in the `apps' file, - covered in *fluxbox-apps(5)*. +-- ++ +These are is covered in more detail in *fluxbox-apps(5)*. -- *Close*: +*Close*::: Close the application softly. +*Kill*::: + Kill the window's parent process, like *xkill(1)*. + Workspace Menu ~~~~~~~~~~~~~~ -The workspace menu can be found by middle clicking on the background. -A menu will popup giving you the option to add or remove a workspace. -You will also see your workspaces listed there; middle clicking on a -workspace name will take you to that workspace, whereas clicking on a -window name in one of the per-workspace submenus will take you to the -workspace that window is on, and select the window. Last but not least -you will notice the Icons menu. This is for applications which have -been `iconified'. - -Menu Syntax -~~~~~~~~~~~ -There are up to four fields in a menu line. They are of the form: - - [tag] (label|filename) {command|filename} <icon file> - -The supported tags are: - -[begin] (label);; - This tells fluxbox to start parsing the menu file. This tag is required for - fluxbox to read your menu file. If it cannot find it, the system default - menu is used in its place. - -[config] (label);; - Inserts a fluxbox native submenu item, containing numerous configuration - options concerning window placement, focus style, window moving style, etc. - -[end];; - This tells fluxbox that it is at the end of a menu. This can either be a - submenu or the main root menu. There must be at least one of these tags in - your menu to correspond to the required [begin] tag. - -[exec] (label) \{command\};; - Inserts a command item into the menu. When you select the menu item from the - menu, fluxbox runs 'command'. - -[exit] (label);; - Inserts an item that shuts down and exits fluxbox. Any open windows are - reparented to the root window before fluxbox exits. - -[include] (file-or-directory-name);; - Parses the file specified by filename inline with the current menu. The - filename can be the full path to a file or it can begin with ~/, which will - be expanded into your home directory. If the path is a directory, then all - files in the directory are included. - -[nop] (label);; - Insert a non-operational item into the current menu. This can be used to - help format the menu into blocks or sections if so desired. This tag does - support a label, but one is not required in which case a blank item will be - used instead. - -[separator];; - This will create a nice separation line. Useful for splitting up sections in - a 'pretty' way. - -[style] (label) \{filename\};; - This tells fluxbox to insert an item that, when selected, reads style file - named filename and apply the new textures, colors and fonts to the current - running session. - -[stylesmenu] (directory);; - Reads all filenames from the specified directory, assuming that they are all - valid style files, and creates menu items in the current menu for every - filename, that, when selected by the user will apply the selected style file - to the current session. The labels that are created in the menu are the - filenames of the style files. - -[stylesdir] (label) \{directory\};; - Creates a submenu entry with label (that is also the title of the new - submenu), and inserts in that submenu all filenames in the specified - directory, assuming that they are all valid style files (directories are - ignored) in the same way as the [stylesdir] command does. Both [stylesdir] - and [stylesmenu] commands make it possible to install style files without - editing your init file. - -[submenu] (label) \{menutitle\};; - This tells fluxbox to create and parse a new menu. This menu is inserted as - a submenu into the parent menu. These menus are parsed recursively, so there - is no limit to the number of levels or nested submenus you can have. The - title for the new menu is optional, if none is supplied, the new menu's - title is the same as the item label. An [end] tag is required to end the - submenu. - -[reconfig] (label);; - When selected this item re-reads the current style and menu files and - applies any changes. This is useful for creating a new style or theme, as - you don't have to constantly restart fluxbox every time you save your style. - However, fluxbox automatically rereads the menu whenever it changes. - -[restart] (label) \{command\};; - This tells fluxbox to restart. If command is supplied, it shuts down and - runs the command (which is commonly the name of another window manager). If - the command is omitted, fluxbox restarts itself. - -[wallpapers] (directory) \{command\};; - This inserts a menu item to set the wallpaper for each file in the given - directory. The command is optional and defaults to fbsetbg. +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. -[workspaces] (label);; - This tells fluxbox to insert a link to the workspaces menu directly into - your menu. This is handy for those users who can't access the workspace menu - directly (e.g. if you don't have a 3 button mouse, it is rather hard to - middle click to show the workspace menu). +*Icons*::: + This menu shows any iconified (or, minimized) windows. Clicking on a window + in this menu will raise it on the current workspace. -['command'] (label);; - In addition to the commands above, any legal key command may be used as a - menu item. See fluxbox-keys(5) for more information. +'Workspaces'::: + 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. -Any line that starts with a '#' or '!' is considered a comment and ignored by -fluxbox. Also, in the label/command/filename fields you can escape any -character. Using '\\' inserts a literal back-slash into the -label/command/filename field. +*New Workspace*::: + This entry adds a new workspace to the end of the list of current workspaces. -Here is an example menu file: +*Edit current workspace name*::: + Pops up a dialog to enter a new name for the current workspace. ------------------------------------------------------------------- -# fluxbox menu file -[begin] (fluxbox) - [exec] (rxvt) {rxvt -ls} </usr/X11R6/share/icons/terminal.xpm> - [exec] (netscape) {netscape -install} - [exec] (The GIMP) {gimp} - [exec] (XV) {xv} - [exec] (Vim) {rxvt -geometry 132x60 -name VIM -e screen vim} - [exec] (Mutt) {rxvt -name mutt -e mutt} - [submenu] (mozilla) - [exec] (browser) {mozilla -browser} - [exec] (news) {mozilla -news} - [exec] (mail) {mozilla -mail} - [exec] (edit) {mozilla -edit} - [exec] (compose) {mozilla -compose} - [end] - [submenu] (Window Manager) - [exec] (Edit Menus) {nedit ~/.fluxbox/menu} - [submenu] (Style) {Which Style?} - [stylesdir] (~/.fluxbox/styles) - [stylesmenu] (fluxbox Styles) {@pkgdatadir@/styles} - [end] - [config] (Config Options) - [reconfig] (Reconfigure) - [restart] (Restart) - [end] - [exit] (Log Out) -[end] ------------------------------------------------------------------- +*Remove Last*::: + Remove the last workspace in the list. Any windows curretly open there will + be sent to the next-to-last workspace. TOOLBAR ------- 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 style and can't be defined as a global -setting (except with the style overlay). +color, look, font etc. is defined in the *STYLE*. -The tools in the toolbar can be enabled/disabled in the init file with the -arguments given to the line: - - session.screen0.toolbar.tools - -The order and number of tools is freely selectable, but they must be separated -by a ",". E.g.: - - session.screen0.toolbar.tools: workspacename, systemtray, iconbar, clock +The tools in the toolbar can be enabled/disabled in the `init' file with the +*session.screen0.toolbar.tools* resource. See the *RESOURCES* section for +details on how to alter this value. The possible tools are: -- *Clock*: +*Clock*::: This will show an area to display a clock and the date according to the format specification listed in "man strtftime" -- *Iconbar*: +*Iconbar*::: This is the area that contains all windows (all running applications, all minimized windows or maybe no window, all depending on the Toolbar Settings). -- *Systemtray*: +*Systemtray*::: The Systemtray can hold applications that are made to use it. -- *WorkspaceName*: +*WorkspaceName*::: This displays the name of the current workspace. -- *PrevWorkspace*: +*PrevWorkspace*::: This displays an arrow that allows to switch to the workspace left of the current one. -- *NextWorkspace*: +*NextWorkspace*::: This displays an arrow that allows to switch to the workspace right of the current one. -- *PrevWindow*: +*PrevWindow*::: This displays an arrow that switches focus to the previous visible window on the current workspace. -- *NextWindow*: +*NextWindow*::: This displays an arrow that switches focus to the next visible window on the current workspace. - 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 -RESOURCES section for more information about that). +*RESOURCES* section for more information about that). +Toolbar Menu +~~~~~~~~~~~~ +This menu can be opened by right-clicking on the toolbar (though not on a +window's name in the iconbar), or from the *Configuration Menu*. -Configuration via the Toolbar Menu -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -All changes take effect immediately, except for a change of the "Toolbar Alpha", -which needs a restart to make the change visible. Here are the settings: +All changes take effect immediately. Here are the settings: -- *Visible*: +*Visible*::: Sets the toolbar either to visible or invisible. - session.screen0.toolbar.visible: <boolean> - -- *Auto hide*: +*Auto hide*::: 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. + remaining edge of the toolbar. See the *session.autoRaiseDelay* resource for + the delay time. - session.screen0.toolbar.autoHide: <boolean> - session.autoRaiseDelay: <int> - -- *Toolbar width percentage*: - Sets the width of the toolbar in percent. Use the left mouse button to - decrease and the right mouse-button to increase the value. The value can be - from 1-100. +*Toolbar width percentage*::: + 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. - session.screen0.toolbar.widthPercent: <int> - -- *Maximize Over*: - Enabling this option will prevent windows from maximizing over the toolbar. - With this switched on they will only expand to the edge of the bar. To use - this option, "Full Maximization" from the Configuration menu must be - DISABLED. Otherwise this option will not work. - - session.screen0.toolbar.maxOver: <boolean> - session.screen0.fullMaximization: <boolean> +*Maximize Over*::: + 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 ``Full Maximization'' from the *Configuration + Menu*. If that option is enabled, this option will have no effect.. -- *Layer...*: +*Layer...*::: This sets the layer on which the toolbar is set. With this you can set the toolbar to "Always on top". - session.screen0.toolbar.layer: <layer> - -- *Placement*: +*Placement*::: Sets the toolbar to any edge of the screen, either centered or aligned with a corner. - session.screen0.toolbar.placement: <direction> - -- *Alpha*: +*Alpha*::: 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. - session.screen0.toolbar.alpha: <int> +*Iconbar Mode*::: +Specifies various modes of the iconbar's operation. ++ +The first section outlines what types of windows will be shown in the iconbar: ++ +-- +*None*:;; + Will not show any windows +*Icons*:;; + Shows windows from all workspaces that are iconified (or, minimized) +*NoIcons*:;; + Shows windows from all workspaces that are not iconified +*WorkspaceIcons*:;; + Shows windows from the current workspace that are iconified +*WorkspaceNoIcons*:;; + Shows windows from the current workspace that are not iconified +*Workspace*:;; + Shows all windows (iconified or not) from the current workspace +*All Windows*:;; + Shows all windows (iconified or not) from all workspaces + +-- ++ +The next section specifies the alignment of the window names shown in the +iconbar. The with is specified via the *session.screen0.iconbar.iconWidth* +resource: ++ +-- +*Left*:;; + All icons will be left-aligned with the width set in the `init' file +*Relative*:;; + All icons will be sized evenly to fill the iconbar completely +*Right*:;; + All icons will be right-aligned with the width set in the `init' file + +-- ++ +The last option in this submenu is: ++ +*Show Pictures*:;; + If enabled the iconbar will show the application's icon (if provided by the + application) -- *Iconbar Mode*: +*Clock*::: + Lets you switch between the 00:00am - 11:59pm and 00:00 - 23:59 notation - Specifies the mode of the iconbar: +*Edit Clock Format*::: + clicking this entry will pop up a dialog window in which the clock format + can be set according to 'man strftime' (or 'man date'). - - *None*: - will not show any windows - - *Icons*: - shows windows from all workspaces that are minimized (iconified) - - *NoIcons*: - shows windows from all workspaces that are not minimized (iconified) - - *WorkspaceIcons*: - shows windows from the current workspace that are minimized (iconified) - - *WorkspaceNoIcons*: - shows windows from the current workspace that are not minimized - (iconified) - - *Workspace*: - shows all windows from the current workspace - - *All Windows*: - shows all windows from all workspaces +FOCUS MODEL +----------- +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 'fluxbox menu' in the Root Menu. - session.screen0.iconbar.mode: <mode> +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. -- *Alignment*: +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: - - *Left*: - all icons will be left-aligned with the width set in the init file - - *Relative*: - all icons will be sized evenly to fill the iconbar completely - - *Right*: - all icons will be right-aligned with the width set in the init file +*Click To Focus*::: + Click to focus windows. +*Mouse Focus*::: + Window focus follows mouse. +*ClickTabFocus*::: + Click to focus tabs. +*MouseTabFocus*::: + Tab focus follows mouse. - session.screen0.iconbar.alignment: <alignment> - session.screen0.iconbar.iconWidth: <int> +There are three more settings in the ``Focus Model'' menu: +*Focus New Windows*::: + If enabled, a new window will grab X focus as soon as it is opened. -- *Show Pictures*: - If enabled the iconbar will show the application's icon (if provided by the - application) +*Auto Raise*:: + 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 *Click Raises*. - session.screen0.iconbar.usePixmap: <boolean> +*Click Raises*:: + If enabled, clicking anywhere on a window will raise it above all others + within its layer. -- *Clock*: - Lets you switch between the 00:00am - 11:59pm and 00:00 - 23:59 notation +TAB OPTIONS +----------- +This section of fluxbox configuration menu lets you configure many features of +tabs. Inside of it there are three main options: -- *Edit Clock Format*: - clicking this entry will pop up a little window in which the clock format - can be set according to 'man strftime' (or 'man date'). +*Placement*::: + You can choose where the external tabs will be positioned relative to the + window. For these options to work, 'Tabs in Titlebar' must be off. - session.screen0.strftimeFormat: <format> +*Tabs in Titlebar*::: + When this option is on, tabs are fixed in window titlebar and the width + varies according to the amount of windows grouped. + +*Maximize Over*::: + 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. +*External Tab Width*::: + This specifies in pixels the width of external tabs. + +STYLES +------ +fluxbox enables you to use specialized files that contain *X(1)* resources to +specify colors, textures, pixmaps and fonts, and thus the overall look of your +window borders, menus and the toolbar. + +The default installation of fluxbox provides some of these style files. See +*fluxbox-style(5)* to accommodate the growing number of style components. + +Style Overlay +~~~~~~~~~~~~~ +In addition to the style file, the overlay file, whose location is specified by +*session.screen0.styleOverlay* (default: *\~/.fluxbox/overlay*) 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 *fluxbox-style(5)*. + +THE SLIT +-------- +The slit is a special fluxbox window frame that can contain dockable +applications, such as ``bbtools'' or ``window maker dockapps''. + +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. + +Most dockable applications use the -w option to run in the slit. For example, +you could put in your *\~/.fluxbox/startup*: + +.............. +bbmail -w & +bbpager -w & +wmdrawer & +exec fluxbox +.............. + +To use the slit you must have it compiled into fluxbox. This is the default +setting. + +Slit Menu +~~~~~~~~~ +This menu can be opened by right-clicking on the slit (though not on an +application running within the slit), or from the *Configuration Menu*. + +All changes take effect immediately. Here are the settings: + +*Placement*::: + This lets you set the position of the slit. + +*Layer*::: + See *LAYERS* for details on the layer order. + +*Auto hide*::: + 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 *session.autoRaiseDelay* resource for + the delay time. + +*Maximize Over*::: + 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 ``Full Maximization'' from the + *Configuration Menu*. If that option is enabled, this option will have no + effect.. + +*Alpha*::: + 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. + +*Clients*::: + 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 *\~/.fluxbox/slitlist*. See the next section for + details. + +Slitlist File +~~~~~~~~~~~~~ +fluxbox's slitlist file is available for those that use dockapps in the slit. +This file helps fluxbox keep track of the *order* of the dockapps when in the +slit. The file is generally located at *\~/.fluxbox/slitlist*. + +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 startfluxbox(8) script + +This sequence will be saved by default to *\~/.fluxbox/slitlist* and will be +remembered for future instances of fluxbox. + +Users are free to manually edit the slitlist file. It is a simple list of window +names, as given by *xprop(1)*, one per dockapp. Similar to the init file it should +not be edited while fluxbox is running. Otherwise changes may get overwritten. + +The user also has the option of choosing a different path for the slitlist file, +by setting the *session.session0.slitlistFile* resource. + +LAYERS +------ +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 +*session.numLayers* resource. + +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): + +* 2 - Above Dock +* 4 - Dock +* 6 - Top +* 8 - Normal +* 10 - Bottom +* 12 - Desktop + +The other way to set the layer for a window is through the `apps' file. This +method is described in *fluxbox-apps(5)*. RESOURCES --------- -Usually the ~/.fluxbox/init resource file is created and maintained by fluxbox -itself. You can use the [config] menu 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 `reconfigure' to reload the -resource options. +Usually the *\~/.fluxbox/init* resource file is created and maintained by +fluxbox itself. You can use the *Configure Menu*, 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 +``reconfigure'' to reload the resource options. -When running fluxbox in a multiple desktop environment the screen0 key can also -be screen1, screen2, etc. You can customize the behavior of fluxbox on each -desktop accordingly. Here are the resources that are currently available: +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: ................................................................................ session.screen0.window.focus.alpha: <integer> session.screen0.window.unfocus.alpha: <integer> - 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. - Default: 255 + 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. + Default: 255 session.screen0.slit.autoHide: <boolean> session.screen0.toolbar.autoHide: <boolean>

@@ -744,6 +924,8 @@

session.screen0.toolbar.tools: <tools> 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 ',' character. + They will appear in the order given. Possible tools:: - clock - iconbar

@@ -774,7 +956,7 @@ This specifies the space between the window title and the edge of the

button. Default: 10 session.screen0.iconbar.alignment: <position> - This value should be changed in the Iconbar Mode menu. Default: + This value should be changed in the Iconbar Mode menu. Default: Relative Available options:

@@ -844,7 +1026,7 @@ Default: True

session.screen0.workspaceNames: <names> Here is where the user can name their workspaces. However it is - recommended to use the tool available in the Configuration Menu to set + recommended to use the tool available in the Workspace Menu to set these. Default: one, two, three, four session.screen0.edgeSnapThreshold: <integer>

@@ -941,194 +1123,6 @@ options are Close, Maximize, MenuIcon, Minimize, Shade, and Stick.

................................................................................ - -KEYS ----- -You can customize fluxbox's key handling through the ~/.fluxbox/keys file. -See 'fluxbox-keys(5)' for more information on the syntax of this file. - -LAYERS ------- -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 number of layers can be changed by -using the following resource: - - session.numLayers: <integer> - -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): - -* 2 - Above Dock -* 4 - Dock -* 6 - Top -* 8 - Normal -* 10 - Bottom -* 12 - Desktop - -The other way to set the layer for a window is through the `apps' file. This -method is described in *fluxbox-apps(5)*. - - -FOCUS MODEL ------------ -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 'fluxbox menu' in the Root Menu. - -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. - -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: - -- *Click To Focus*: - click to focus windows -- *Mouse Focus*: - window focus follows mouse -- *ClickTabFocus*: - click to focus tabs -- *MouseTabFocus*: - tab focus follows mouse - -There is one more option in the focus model menu. It is called AutoRaise. When -AutoRaise is enabled, focused windows will appear on top of other windows in -the same layer. When AutoRaise is disabled, you must explicitly raise a focused -window, using the window menu or keybinding. - -TAB OPTIONS ------------ -This section of fluxbox configuration menu lets you configure many features of -tabs. Inside of it there are three main options: - -- *Placement*: - You can choose where the external tabs will be positioned relative to the - window. For these options to work, 'Tabs in Titlebar' must be off. - -- *Tabs in Titlebar*: - When this option is on, tabs are fixed in window titlebar and the width - varies according to the amount of windows grouped. - -- *Maximize Over*: - When this option is on, maximizing a window will disregard the size and - location of external tabs. - -- *External Tab Width*: - This specifies in pixels the width of external tabs. - -As with most Fluxbox configurations, these options can be changed by editing the -init file. The resources that you should look at are: - - session.screen0.tabs.intitlebar: <boolean> - session.screen0.tab.width: <integer> - session.screen0.tab.placement: <direction> - -STYLES ------- -fluxbox enables you to use specialized files that contain X(1) resources to -specify colors, textures, pixmaps and fonts, and thus the overall look of your -window borders, menus and the toolbar. - -The default installation of fluxbox provides some of these style files. See -fluxbox-style(5) to accommodate the growing number of style components. - -STYLE OVERLAY -------------- -In addition to the style file, the overlay file, whose location is specified by -session.screen0.styleOverlay (default: ~/.fluxbox/overlay ) 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 fluxbox-style(5). - -THE SLIT --------- -The slit is a special fluxbox window frame that can contain dockable -applications, e.g. 'bbtools' or 'wmapps'. - -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. - -Most dockable applications use the -w option to run in the slit. For example, -you could put in your ~/.xinitrc: - -.............. -bbmail -w & -bbpager -w & -wmdrawer & -exec fluxbox -.............. - -NOTE: -You can also put all of these in the startfluxbox(8) script. This way you -would only need to specify: exec startfluxbox in your ~/.xinitrc. - -To use the slit you must have it compiled into fluxbox. This is the default -setting. - -Slit Menu ---------- -You can right click on the edge of the slit window to get a menu to configure -its position, whether its contained applications should be grouped horizontally -or vertically and whether the slit should hide itself when the mouse moves away. -The slit menu items are described in more detail below: - -- *Placement*: - This lets you set the position of the slit. - -- *Layer*: - Look above for the layer priorities. - -- *Auto hide*: - If enabled, the slit will disappear after a given amount of time and hide - from the view of the user. You can make it appear if you move the mouse to - the edge of the desktop where the slit is positioned. - -- *Maximize over*: - If this is enabled, all windows, if you maximize them, will stretch - over/under the slit. Otherwise the will be limited to the slit's edge. - -- *Alpha*: - By changing the value the slit (only the decoration not the apps in the - slit) will become transparent. 0 (transparent) - 255 (opaque) - -- *Clients*: - 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 appear - by selecting them in the list. The "Save SlitList" option saves the - new order to you slitlist located in ~/.fluxbox (useful if you - reordered the apps with the cycle option). - -Slitlist File -------------- -fluxbox's slitlist file is available for those that use dockapps in the slit. -This file helps fluxbox keep track of the *order* of the dockapps when in the -slit. The file is generally located at ~/.fluxbox/slitlist - -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 auto-run script, or better yet your - startfluxbox(8) script. - -This sequence will be saved by default to ~/.fluxbox/slitlist and will be -remembered for future instances of fluxbox. - -Users are free to manually edit the slitlist file. It is a simple list of window -names, as given by xprop(1), one per dockapp. Similar to the init file it should -not be edited while fluxbox is running. Otherwise changes may get overwritten. - -The user also has the option of choosing a different path for the slitlist file. -The following is the init file component that needs to be changed: - - session.session0.slitlistFile: <filename> - ENVIRONMENT ----------- HOME::

@@ -1141,14 +1135,17 @@ the display specified by this variable.

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 certain commands in the keys -and menu files. So one can do: +available whenever fluxbox uses the shell, such as the `keys' file +*ExecCommand* or the root menu's *[exec]* tag. See *fluxbox-keys(5)* and +*fluxbox-menu(5)* for details. -........................... -Mod1 x ExecCommand :$TERM -........................... +The `keys' file also provides two commands that can alter the current +environment of fluxbox: *SetEnv* and *Export*. Any changes made by these +commands will also affect the environment as seen by fluxbox and all child +processes started after that point. See *fluxbox-keys(5)* for details. -For more information about environment variables, see your shell's manual. +For more information about environment variables in general, see your shell's +manual. SIGNALS -------

@@ -1170,17 +1167,16 @@ Jeff Raven <jraven at psu edu>.

The Official fluxbox website: http://www.fluxbox.org -Many compatible themes: -- http://boxwhore.org -- http://themes.freshmeat.net/ +The Official fluxbox wiki: http://www.fluxbox-wiki.org + +Many compatible themes: http://tenr.de This manpage is the combined work of: +- Jim Ramsay <i.am at jimramsay com> (>fluxbox-1.1.1) - 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)

@@ -1195,6 +1191,6 @@ mailinglists. More information can be found on the official website.

SEE ALSO -------- -fluxbox-apps(5) fluxbox-keys(5) bsetroot(1) fbsetbg(1) fbrun(1) -fluxbox-style(5) fluxbox-remote(1) +fluxbox-apps(5) fluxbox-keys(5) fluxbox-style(5) fluxbox-menu(5) +fluxbox-remote(1) bsetroot(1) fbsetbg(1) fbrun(1)
M doc/fluxbox-apps.5.indoc/fluxbox-apps.5.in

@@ -1,12 +1,12 @@

.\" 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 +.\" Date: 02/17/2009 .\" Manual: Fluxbox Manual -.\" Source: fluxbox-apps.txt 1.1.1 +.\" Source: fluxbox-apps.txt 1.1.2 .\" Language: English .\" -.TH "FLUXBOX\-APPS" "5" "02/10/2009" "fluxbox\-apps\&.txt 1\&.1\&.1" "Fluxbox Manual" +.TH "FLUXBOX\-APPS" "5" "02/17/2009" "fluxbox\-apps\&.txt 1\&.1\&.2" "Fluxbox Manual" .\" ----------------------------------------------------------------- .\" * (re)Define some macros .\" -----------------------------------------------------------------

@@ -180,7 +180,9 @@ .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\&. +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"
M doc/fluxbox-keys.5.indoc/fluxbox-keys.5.in

@@ -1,12 +1,12 @@

.\" Title: fluxbox-keys .\" 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 +.\" Date: 02/17/2009 .\" Manual: Fluxbox Manual -.\" Source: fluxbox-keys.txt 1.1.1 +.\" Source: fluxbox-keys.txt 1.1.2 .\" Language: English .\" -.TH "FLUXBOX\-KEYS" "5" "02/10/2009" "fluxbox\-keys\&.txt 1\&.1\&.1" "Fluxbox Manual" +.TH "FLUXBOX\-KEYS" "5" "02/17/2009" "fluxbox\-keys\&.txt 1\&.1\&.2" "Fluxbox Manual" .\" ----------------------------------------------------------------- .\" * (re)Define some macros .\" -----------------------------------------------------------------

@@ -191,6 +191,8 @@ .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:

@@ -767,15 +769,36 @@ .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 / \fBWorkspaceMenu\fR / \fBWindowMenu\fR +\fBRootMenu\fR .RS 4 -Opens the specified menu\&. See fluxbox(1) for more details on what these menus contain\&. +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\&. See +\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

@@ -784,12 +807,18 @@ .RE

.PP \fBCustomMenu\fR \fIpath\fR .RS 4 -Opens a custom menu file\&. +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

@@ -827,7 +856,18 @@ \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 ~/\&.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 +\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

@@ -1205,23 +1245,23 @@ .RE

.\} .SH "FILES" .PP -~/\&.fluxbox/keys +\fB~/\&.fluxbox/keys\fR .RS 4 This is the default location for the keybinding definitions\&. .RE .PP -/usr/X11R6/include/X11/keysymdef\&.h +\fB/usr/X11R6/include/X11/keysymdef\&.h\fR .RS 4 X key names are in this file\&. .RE .PP -/usr/X11R6/lib/X11/XKeysymDB +\fB/usr/X11R6/lib/X11/XKeysymDB\fR .RS 4 X key names are also in this file\&. .RE .SH "RESOURCES" .PP -session\&.keyFile: <location> +\fBsession\&.keyFile:\fR \fIlocation\fR .RS 4 This may be set to override the location of the keybinding definitions\&. .RE
A doc/fluxbox-menu.5.in

@@ -0,0 +1,680 @@

+.\" Title: fluxbox-menu +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> +.\" Date: 02/17/2009 +.\" Manual: Fluxbox Manual +.\" Source: fluxbox-menu.txt 1.1.2 +.\" Language: English +.\" +.TH "FLUXBOX\-MENU" "5" "02/17/2009" "fluxbox\-menu\&.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-menu \- fluxbox(1) menu syntax +.SH "Synopsis" +.sp +@pkgdatadir@/menu +.sp +~/\&.fluxbox/menu +.sp +~/\&.fluxbox/windowmenu +.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 +There are two types of menus in fluxbox which can be configured\&. +.sp +The first is the root menu, which normally appears when you right\-click on the desktop\&. +.sp +The first is the \fBROOT MENU\fR (Or right\-click menu), is usually bound to a right\-click on the desktop, though this binding can be changed in the `keys\' file (\fBfluxbox\-keys(5)\fR)\&. This same syntax is used for the \fBCustomMenu\fR command, also mentioned in \fBfluxbox\-keys(5)\fR\&. +.sp +Fluxbox installs a default root menu file in \fB@pkgdatadir@/menu\fR\&. You can also use fluxbox \-i to confirm this location\&. Of course this system\-wide menu can be customized for all users at once, but it is also possible to create an individual menu file for each user\&. By convention, users create a menu file in \fB~/\&.fluxbox/menu\fR\&. Once you\'ve created your own menu file, you\'ll want to make sure that you properly declare this location in your `init\' file so that fluxbox knows where to look\&. See \fBRESOURCES\fR, below for details\&. +.sp +The second type is the \fBWINDOW MENU\fR, which defines the contents of the menu which appears when you right\-click on a window\'s titlebar or iconbar\&. This opens a menu file as defined by \fB~/\&.fluxbox/windowmenu\fR\&. If this file does not exist, fluxbox will copy in the default from \fB@pkgdatadir@/windowmenu\fR\&. +.sp +You do not need to \(lqreload\(rq fluxbox after editing the apps file, the changes should be taken into account the next time you open the menu\&. +.SH "ROOT MENU" +.sp +The root menu must begin with a \fB[begin]\fR tag and end with an \fB[end]\fR tag, and every tag must be on its own line\&. +.PP +There are up to four fields in a menu line\&. They are of the form: +.RS 4 +[\fItag\fR] (\fIlabel\fR) {\fIcommand\fR} <\fIicon\fR> +.RE +.sp +The <\fIicon\fR> field is always optional when show below\&. If specified, the \fIicon\fR will be scaled down and displayed in the menu alongside the text label of the item\&. It must be in \&.xpm or \&.png format\&. +.sp +Any line that starts with a \fI#\fR or \fI!\fR is considered a comment and ignored by fluxbox\&. Also, in the label/command/filename fields you can escape any character\&. Using \fI\e\e\fR inserts a literal back\-slash into the label/command/filename field\&. +.sp +You may enter labels, commands, and icons using characters from any \fBiconv(1)\fR language/locale by specifying the encoding used via the \fB[encoding]\fR tag, detailed below\&. +.SS "Structural Tags" +.PP +\fB[begin]\fR (\fItitle\fR) +.RS 4 +This tells fluxbox to start parsing the menu file\&. This tag is required for fluxbox to read your menu file\&. If it cannot find it, the system default menu is used in its place\&. The +\fItitle\fR +appears at the top of the menu\&. And +\fB[end]\fR +tag is required to end the menu\&. +.RE +.PP +\fB[submenu]\fR (\fIlabel\fR) {\fItitle\fR} <\fIicon\fR> +.RS 4 +This tells fluxbox to create and parse a new menu, which is inserted as a submenu into the parent menu\&. These menus are parsed recursively, so there is no limit to the number of levels or nested submenus you can have\&. The +\fIlabel\fR +is the text that will appear in the parent menu, and the +\fItitle\fR +is shown at the top of the submenu\&. If omitted, the +\fItitle\fR +will be the same as the +\fIlabel\fR\&. An +\fB[end]\fR +tag is required to end the submenu\&. +.RE +.PP +\fB[end]\fR +.RS 4 +This tells fluxbox that it is at the end of a menu\&. This can either be a +\fB[submenu]\fR +or the +\fB[begin]\fR +tag of the main root menu\&. There must be at least one of these tags in your menu to correspond to the required +\fB[begin]\fR +tag, and one for each +\fB[submenu]\fR\&. +.RE +.PP +\fB[encoding]\fR {\fIencoding\fR} +.RS 4 +This begins an +\fB[encoding]\fR +section and specifies the string encoding of all strings until the matching +\fB[endencoding]\fR +tag\&. For a list of available encodings on your system, run +\fBiconv \-l\fR\&. +.RE +.PP +\fB[endencoding]\fR +.RS 4 +This ends an +\fB[encoding]\fR +section\&. +.RE +.PP +\fB[include]\fR (\fIpath\fR) +.RS 4 +Parses the file specified by filename inline with the current menu\&. The +\fIpath\fR +can be the full path to a file or it can begin with +\fB~/\fR, which will be expanded into your home directory\&. If +\fIpath\fR +is a directory, then all files in that directory are included\&. +.RE +.PP +\fB[separator]\fR +.RS 4 +This will create a nice separation line\&. Useful for splitting up sections in a \(lqpretty\(rq way\&. The optional +\fIcomment\fR +is not displayed, but can be useful for internal documentation or script parsing of menu files\&. +.RE +.PP +\fB[nop]\fR (\fIlabel\fR) <\fIicon\fR> +.RS 4 +Insert a non\-operational item into the current menu\&. This is much like +\fB[separator]\fR, but instead of a line, it inserts a +\fIlabel\fR\&. This can be used to help format the menu into blocks or sections if so desired\&. The +\fIlabel\fR +is optional, and if omitted a blank item will be inserted\&. +.RE +.SS "Applications" +.PP +\fB[exec]\fR (\fIlabel\fR) {\fIcommand\&...\fR} <\fIicon\fR> +.RS 4 +Inserts a command item into the menu\&. When you select the menu item from the menu, fluxbox runs +\fIcommand\&...\fR +in 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 te 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)\&. +.RE +.SS "Fluxbox Functions" +.PP +\fB[config]\fR (\fIlabel\fR) <\fIicon\fR> +.RS 4 +Inserts a fluxbox native submenu item, containing numerous configuration options concerning window placement, focus style, window moving style, etc\&. See +\fBConfiguration Menu\fR +in +\fBfluxbox(1)\fR +for details\&. +.RE +.PP +\fB[reconfig]\fR (\fIlabel\fR) <\fIicon\fR> +.RS 4 +When selected this item re\-reads the current style and menu files and applies any changes\&. This is useful for creating a new style or theme, as you don\'t have to constantly restart fluxbox every time you save your style\&. However, fluxbox automatically rereads the menu whenever it changes\&. +.RE +.PP +\fB[restart]\fR (\fIlabel\fR) {\fIcommand\fR} <\fIicon\fR> +.RS 4 +This tells fluxbox to restart\&. If +\fIcommand\fR +is supplied, it shuts down and runs the command (which is commonly the name of another window manager)\&. If +\fIcommand\fR +is omitted, fluxbox restarts itself\&. +.RE +.PP +\fB[exit]\fR (\fIlabel\fR) <\fIicon\fR> +.RS 4 +Inserts an item that shuts down and exits fluxbox\&. Any open windows are reparented to the root window before fluxbox exits\&. +.RE +.PP +\fB[style]\fR (\fIlabel\fR) {\fIfilename\fR} <\fIicon\fR> +.RS 4 +This tells fluxbox to insert an item that, when selected, reads style file named filename and apply the new textures, colors and fonts to the current running session\&. +.RE +.PP +\fB[stylesmenu]\fR (\fIdirectory\fR) <\fIicon\fR> +.RS 4 +Reads all filenames from the specified directory, assuming that they are all valid style files, and creates inline menu items in the current menu for every filename, that, when selected by the user will apply the selected style file to the current session\&. The labels that are created in the menu are the filenames of the style files\&. +.RE +.PP +\fB[stylesdir]\fR (\fIlabel\fR) {\fIdirectory\fR} <\fIicon\fR> +.RS 4 +Creates a submenu entry with +\fIlabel\fR +(that is also the title of the new submenu), and inserts in that submenu all filenames in the specified +\fIdirectory\fR, assuming that they are all valid style files (directories are ignored) in the same way as the +\fB[stylesdir]\fR +command does\&. Both +\fB[stylesdir]\fR +and +\fB[stylesmenu]\fR +commands make it possible to install style files without editing your init file\&. +.RE +.PP +\fB[wallpapers]\fR (\fIdirectory\fR) {\fIcommand\fR} <\fIicon\fR> +.RS 4 +This inserts a menu item to set the wallpaper for each file in the given directory\&. The +\fIcommand\fR +is optional, and defaults to +\fBfbsetbg\fR\&. +.RE +.PP +\fB[workspaces]\fR (\fIlabel\fR) <\fIicon\fR> +.RS 4 +This tells fluxbox to insert a link to the workspaces menu directly into your menu\&. See +\fBWorkspace Menu\fR +in +\fBfluxbox(1)\fR +for details\&. +.RE +.PP +\fB[\fR\fIcommand\fR\fB]\fR (\fIlabel\fR) <\fIicon\fR> +.RS 4 +In addition to the commands above, any legal keys file +\fIcommand\fR +may be used as a menu item\&. See +\fBfluxbox\-keys(5)\fR +for more information\&. +.RE +.SH "WINDOW MENU" +.sp +Like the \fBROOT MENU\fR, this menu file must start with \fB[begin]\fR and end with \fB[end]\fR\&. However, this file consists of only one \fB[\fR\fItag\fR\fB]\fR per line with no labels, commands, or icons\&. +.sp +The available tags in this menu are: +.PP +\fB[shade]\fR +.RS 4 +Provides a menu item to shade or unshade (or, roll\-up) the window\&. This is equivalent to the shade titlebar button\&. +.RE +.PP +\fB[stick]\fR +.RS 4 +Provides a menu item to stick or unstick the window\&. Stuck windows are displayed on all workspaces\&. This is equivalent to the stick titlebar button\&. +.RE +.PP +\fB[maximize]\fR +.RS 4 +Provides a menu item to maximize or unmaximize the window, equivalent to the maximize titlebar button\&. The button with which you click alters the behaviour of this item as follows: +.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 +\fB[iconify]\fR +.RS 4 +Provides a menu item to iconify (or, minimize) the window, equivalent to the iconify titlebar button\&. +.RE +.PP +\fB[close]\fR +.RS 4 +Closes the window gracefully, equivalent to the titlebar button\&. +.RE +.PP +\fB[kill]\fR +.RS 4 +Kills the window\'s process, like +\fBxkill(1)\fR\&. +.RE +.PP +\fB[raise]\fR +.RS 4 +Raise the window to the top of the stack within its layer\&. +.RE +.PP +\fB[lower]\fR +.RS 4 +Lower the window to the bottom of the stack within its layer\&. +.RE +.PP +\fB[settitledialog]\fR +.RS 4 +Opens a dialog which can be used to set the window\'s title\&. Some applications may re\-set their own title from time\-to\-time, wiping out your setting\&. +.RE +.PP +\fB[sendto]\fR +.RS 4 +Sends the window to a different workspace\&. When you select the workspace with a middle\-click, fluxbox will also change to the new workspace\&. A regular click only sends the window\&. +.RE +.PP +\fB[layer]\fR +.RS 4 +Adds a \(lqLayer\&...\(rq submenu which lets you change the layer of this window\&. +.RE +.PP +\fB[alpha]\fR +.RS 4 +Adds a \(lqTransparency\&...\(rq submenu which lets you change the focused and unfocused transparency of this window\&. +.RE +.PP +\fB[extramenus]\fR +.RS 4 +Adds the \(lqRemember\&...\(rq menu item, which allows you to specify which settings should be stored in the `apps\' file (See +\fBfluxbox\-apps(5)\fR +for more details)\&. +.RE +.PP +\fB[separator]\fR +.RS 4 +Adds a horizontal line to the menu +.RE +.SH "FILES" +.PP +\fB~/\&.fluxbox/menu\fR +.RS 4 +This is the default location for the user\'s root menu\&. +.RE +.PP +\fB@pkgdatadir@/menu\fR +.RS 4 +This is the system\-wide root menu file\&. It will be used if the user\'s root menu is missing or unparseable\&. +.RE +.PP +\fB~/\&.fluxbox/windowmenu\fR +.RS 4 +This is the user\'s window menu definition file +.RE +.PP +\fB@pkgdatadir@/menu\fR +.RS 4 +This is the default window menu\&. If the user does not have this file, it will be copied to +\fB~/\&.fluxbox/windowmenu\fR +on fluxbox startup\&. +.RE +.SH "RESOURCES" +.PP +\fBsession\&.menuFile:\fR \fIlocation\fR +.RS 4 +This may be set to override the location of the user\'s root menu\&. +.RE +.SH "ENVIRONMENT" +.sp +The \fIcomand\&...\fR field of the \fB[exec]\fR tag can take advantage of other environment variables if they are set before fluxbox is started\&. +.SH "EXAMPLES" +.PP +\fBExample\ \&1.\ \&Root Menu\fR +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +# fluxbox menu file +[begin] (fluxbox) + [exec] (rxvt) {rxvt \-ls} </usr/X11R6/share/icons/terminal\&.xpm> + [exec] (netscape) {netscape \-install} + [exec] (The GIMP) {gimp} + [exec] (XV) {xv} + [exec] (Vim) {rxvt \-geometry 132x60 \-name VIM \-e screen vim} + [exec] (Mutt) {rxvt \-name mutt \-e mutt} + [submenu] (mozilla) + [exec] (browser) {mozilla \-browser} + [exec] (news) {mozilla \-news} + [exec] (mail) {mozilla \-mail} + [exec] (edit) {mozilla \-edit} + [exec] (compose) {mozilla \-compose} + [end] + [submenu] (Window Manager) + [exec] (Edit Menus) {nedit ~/\&.fluxbox/menu} + [submenu] (Style) {Which Style?} + [stylesdir] (~/\&.fluxbox/styles) + [stylesmenu] (fluxbox Styles) {@pkgdatadir@/styles} + [end] + [config] (Config Options) + [reconfig] (Reconfigure) + [restart] (Restart) + [end] + [exit] (Log Out) +[end] +.EB lightgray +.fi +.fam +.ps +1 +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&2.\ \&Default Window Menu\fR +.sp +.if n \{\ +.RS 4 +.\} +.fam C +.ps -1 +.nf +.BB lightgray +[begin] + [shade] + [stick] + [maximize] + [iconify] + [raise] + [lower] + [settitledialog] + [sendto] + [layer] + [alpha] + [extramenus] + [separator] + [close] +[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\&.1\&.1) +.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-remote.1.indoc/fluxbox-remote.1.in

@@ -1,12 +1,12 @@

.\" Title: fluxbox-remote .\" 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 +.\" Date: 02/17/2009 .\" Manual: Fluxbox Manual -.\" Source: fluxbox-remote.txt 1.1.1 +.\" Source: fluxbox-remote.txt 1.1.2 .\" Language: English .\" -.TH "FLUXBOX\-REMOTE" "1" "02/10/2009" "fluxbox\-remote\&.txt 1\&.1\&." "Fluxbox Manual" +.TH "FLUXBOX\-REMOTE" "1" "02/17/2009" "fluxbox\-remote\&.txt 1\&.1\&." "Fluxbox Manual" .\" ----------------------------------------------------------------- .\" * (re)Define some macros .\" -----------------------------------------------------------------
M doc/fluxbox-style.5.indoc/fluxbox-style.5.in

@@ -1,12 +1,12 @@

.\" Title: fluxbox-style .\" 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 +.\" Date: 02/17/2009 .\" Manual: Fluxbox Manual -.\" Source: fluxbox-style.txt 1.1.1 +.\" Source: fluxbox-style.txt 1.1.2 .\" Language: English .\" -.TH "FLUXBOX\-STYLE" "5" "02/10/2009" "fluxbox\-style\&.txt 1\&.1\&.1" "Fluxbox Manual" +.TH "FLUXBOX\-STYLE" "5" "02/17/2009" "fluxbox\-style\&.txt 1\&.1\&.2" "Fluxbox Manual" .\" ----------------------------------------------------------------- .\" * (re)Define some macros .\" -----------------------------------------------------------------
M doc/fluxbox.1.indoc/fluxbox.1.in

@@ -1,12 +1,12 @@

.\" Title: fluxbox .\" 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 +.\" Date: 02/17/2009 .\" Manual: Fluxbox Manual -.\" Source: fluxbox.txt 1.1.1 +.\" Source: fluxbox.txt 1.1.2 .\" Language: English .\" -.TH "FLUXBOX" "1" "02/10/2009" "fluxbox\&.txt 1\&.1\&.1" "Fluxbox Manual" +.TH "FLUXBOX" "1" "02/17/2009" "fluxbox\&.txt 1\&.1\&.2" "Fluxbox Manual" .\" ----------------------------------------------------------------- .\" * (re)Define some macros .\" -----------------------------------------------------------------

@@ -170,71 +170,83 @@ .SH "Name"

fluxbox \- A lightweight window manager for the X Windowing System .SH "Synopsis" .sp -\fIfluxbox\fR [\-rc rcfile] [\-log logfile] [\-display display] [\-screen scr,scr|all] [\-verbose] [\-sync] +\fBfluxbox\fR [\-rc \fIrcfile\fR] [\-log \fIlogfile\fR] [\-display \fIdisplay\fR] [\-screen all|\fIscr\fR,\fIscr\fR\&...] [\-verbose] [\-sync] .sp -\fIfluxbox\fR [\-v | \-version] | [\-h | \-help] | [\-i | \-info] | [\-list\-commands] +\fBfluxbox\fR [\-v | \-version] | [\-h | \-help] | [\-i | \-info] | [\-list\-commands] .SH "DESCRIPTION" .sp -fluxbox(1) 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\&. The `slit\' can be used to dock small applications; e\&.g\&. most of the bbtools can use the slit\&. +\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(1) can iconify windows to the toolbar, in addition to adding the window to the \fIIcons\fR submenu of the workspace menu\&. 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\&. +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 -fluxbox(1) 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\&. +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(1) 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\&. +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 -\-display display +\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 -\-h, \-help +\fB\-h\fR, \fB\-help\fR .RS 4 Display command line options\&. .RE .PP -\-i, \-info +\fB\-i\fR, \fB\-info\fR .RS 4 Display useful information concerning the defaults and compiled\-in options\&. .RE .PP -\-log logfile +\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 -\-rc rcfile +\fB\-rc\fR \fIrcfile\fR .RS 4 -Use a different config file other than the default ~/\&.fluxbox/init\&. +Use a different config file other than the default +\fB~/\&.fluxbox/init\fR\&. .RE .PP -\-v, \-version +\fB\-v\fR, \fB\-version\fR .RS 4 The version of fluxbox installed\&. .RE .PP -\-screen scr,scr|all +\fB\-screen\fR all|\fIscr\fR,\fIscr\fR\&... .RS 4 Run on specified screens only or all (by default)\&. .RE .PP -\-verbose +\fB\-verbose\fR .RS 4 Print more information in process\&. .RE .PP -\-sync +\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 -fluxbox(1) comes with a program called startfluxbox(8) 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 "exec startfluxbox" in your /\&.xinitrc or /\&.xsession (depending on your distribution and/or display manager) as the last executed command\&. This is assuming that the location of fluxbox(1) and startfluxbox(8) are in your shell\'s $PATH\&. Also note that you may need to create the /\&.xinitrc file or your setup may use /\&.xsession instead, depending on your X setup\&. For more information on your shell, please visit your shell\'s manual page\&. +\fBfluxbox(1)\fR comes with a program called \fBstartfluxbox(8)\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(8)\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 fluxbox(1)\&. These are what fluxbox looks for upon startup\&. In the list of `Defaults:\' you\'ll see a menu file location, this is where you can provide a system\-wide menu file for your users\&. +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 ~/\&.fluxbox/init\&. Resources in this file can be edited by hand\&. fluxbox also has many tools to edit these; look through the main menu once fluxbox has started to find different ways of managing your session\&. +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\&.

@@ -242,13 +254,13 @@ .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 RootMenu\&. A middle click (mouse button 2) on the desktop shows you the WorkspaceMenu\&. -.SS "RootMenu and WorkspaceMenu" +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 MENUS on how to customize these menus\&. +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: +The toolbar contains any combination of the following tools, by default in this order: .sp .RS 4 .ie n \{\

@@ -271,7 +283,7 @@ .sp -1

.IP \(bu 2.3 .\} -\fBIconbar\fR: List of windows managed by fluxbox +\fBWorkspace Arrows\fR: Previous/Next Workspace .RE .sp .RS 4

@@ -283,7 +295,7 @@ .sp -1

.IP \(bu 2.3 .\} -\fBSystem Tray\fR: Area for applets +\fBIconbar\fR: List of windows managed by fluxbox .RE .sp .RS 4

@@ -295,7 +307,7 @@ .sp -1

.IP \(bu 2.3 .\} -\fBClock\fR: Date and Time +\fBWindow Arrows\fR: Previous/Next Application Window .RE .sp .RS 4

@@ -307,7 +319,7 @@ .sp -1

.IP \(bu 2.3 .\} -\fBWorkspace Arrows\fR: Previous/Next Workspace +\fBSystem Tray\fR: Area for applets .RE .sp .RS 4

@@ -319,13 +331,13 @@ .sp -1

.IP \(bu 2.3 .\} -\fBWindow Arrows\fR: Previous/Next Application Window +\fBClock\fR: Date and Time .RE .sp -The contents of the toolbar can be configured in the `init\' file\&. We discuss the `init\' file at great length in the RESOURCES section\&. +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\&. The slit 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 section below that goes into detail about the options you have\&. +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):

@@ -396,42 +408,25 @@ .\}

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 MENUS section\&. We discuss layers in more detail in the LAYERS section\&. +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 FOCUS MODEL section\&. +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 Window Menu section of MENUS\&. +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 fluxbox\-apps(5) for details\&. -.SH "MENUS" +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 -fluxbox installs a default menu file in @pkgdatadir@/menu\&. You can also use fluxbox \-i to confirm this action\&. Of course this system\-wide menu can be customized for all users at once, but it is also possible to create an individual menu file for each user\&. By convention, users create a menu file in ~/\&.fluxbox/menu \&. Once you\'ve created your own menu file, you\'ll want to make sure that you properly declare this location in your `init\' file so that fluxbox knows where to look\&. The value you\'ll want to add or change is: +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 -.if n \{\ -.RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.menuFile: <menufile> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ -.RE -.\} -.sp -For this change to take effect, fluxbox must be restarted\&. Be sure that your menu is usable, then choose `Restart\' from the default fluxbox root menu\&. This restart is only necessary if you make changes to the `init\' file; otherwise, fluxbox will automatically detect your changes\&. -.SS "Root Menu" +The default bindings set up by fluxbox are as follows: .sp -The root menu is where you can change different aspects of fluxbox by simply clicking on a menu item\&. Most of the changes in this menu can also be done in the `init\' file\&. However it makes it very easy to change certain options without having to open up an editor and find the resource\&. In the root menu, you usually have a `fluxbox menu\' or `Settings\' submenu, where you will find lots of different options\&. We\'ll take a look at most, if not all, of those here\&. +Mouse clicks on the empty desktop: .sp .RS 4 .ie n \{\

@@ -442,7 +437,8 @@ .sp -1

.IP \(bu 2.3 .\} -\fBConfigure\fR: 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\&. +\fBLeft\-click\fR +(Button 1): hides all fluxbox menus .RE .sp .RS 4

@@ -454,7 +450,8 @@ .sp -1

.IP \(bu 2.3 .\} -\fBSystem Styles\fR: This is where the standard styles are listed\&. You can select one of these by clicking on it\&. You may have to `reload\' the config or `restart\' to get every graphical element to change to the new style\&. System styles are located in @pkgdatadir@/styles/ upon a default install\&. Remember that you can confirm this with fluxbox \-i\&. +\fBMiddle\-click\fR +(Button 2): shows the Workspace Menu .RE .sp .RS 4

@@ -466,9 +463,8 @@ .sp -1

.IP \(bu 2.3 .\} -\fBUser Styles\fR: ~/\&.fluxbox/styles This is the location where you will store new styles that you grab from the Internet\&. If you create your own styles this is also where you will put yours (provided that you follow the -\fIstandards\fR -described in fluxbox\-style(5))\&. +\fBRight\-click\fR +(Button 3): shows the Root Menu .RE .sp .RS 4

@@ -480,8 +476,11 @@ .sp -1

.IP \(bu 2.3 .\} -\fBWorkspace List\fR: This is a list of the workspaces configured in your `init\' file\&. If there are programs running on any of the workspaces, they will be listed one level down\&. +\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 \{\

@@ -492,7 +491,8 @@ .sp -1

.IP \(bu 2.3 .\} -\fBTools\fR: Listed here are different tools that you can use\&. You can rename your workspace, run programs from a command line or regenerate your menu\&. +\fBALT+Drag Left\-click\fR +anywhere on a window moves the window\&. .RE .sp .RS 4

@@ -504,7 +504,8 @@ .sp -1

.IP \(bu 2.3 .\} -\fBWindow\fR: Allows you to switch your window manager\&. (Only listed if you have other window managers/desktop environments installed\&.) +\fBALT+Drag Right\-click\fR +anywhere on a window resizes the window\&. .RE .sp .RS 4

@@ -516,8 +517,11 @@ .sp -1

.IP \(bu 2.3 .\} -\fBLock Screen\fR: Locks the screen\&... +\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 \{\

@@ -528,7 +532,8 @@ .sp -1

.IP \(bu 2.3 .\} -\fBfluxbox Command\fR: A little Commandline will popup where you can enter a fluxbox command\&. +\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

@@ -540,7 +545,8 @@ .sp -1

.IP \(bu 2.3 .\} -\fBReload Config\fR: Use this to reload any menu files or style files\&. Just a basic re\-read of the files by a running fluxbox\&. +\fBDouble Left\-click\fR +on a window\'s titlebar shades the window .RE .sp .RS 4

@@ -552,7 +558,8 @@ .sp -1

.IP \(bu 2.3 .\} -\fBRestart\fR: 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\&. +\fBMiddle\-click\fR +on a window\'s titlebar lowers the window .RE .sp .RS 4

@@ -563,11 +570,13 @@ .el \{\

.sp -1 .IP \(bu 2.3 .\} -*Exit: Exits fluxbox and probably shuts down the X Window server\&. + +\fBRight\-click\fR +on a window\'s titlebar pops up the +\fBWindow Menu\fR .RE -.SS "Configuration Menu" .sp -This menu offers the opportunity to set up fluxbox\&. It contains many options from the init file, but this is an easier and faster way for most users\&. +Mouse gestures on the toolbar: .sp .RS 4 .ie n \{\

@@ -578,20 +587,11 @@ .sp -1

.IP \(bu 2.3 .\} -\fBFocus Model\fR: Please read the FOCUS MODEL section at the end of this manual\&. +\fBScroll wheel\fR +on the toolbar cycles through windows .RE .sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBTab Options\fR: Lets you configure the properties of tabs\&. Detailed in TAB OPTIONS section\&. -.RE +Keyboard bindings: .sp .RS 4 .ie n \{\

@@ -602,7 +602,9 @@ .sp -1

.IP \(bu 2.3 .\} -\fBSlit\fR: This Menu can be opened by right clicking the slit (if visible)\&. Find more information about this menu\'s options in the SLIT section\&. +\fBALT+Tab\fR +/ +\fBALT+Shift+Tab\fR: Cycle through windows .RE .sp .RS 4

@@ -614,7 +616,9 @@ .sp -1

.IP \(bu 2.3 .\} -\fBToolbar\fR: Please take a look at the "Configuration via the Toolbar Menu" part of the TOOLBAR section\&. +\fBWIN+Tab\fR +/ +\fBWIN+Shift+Tab\fR: Cycle through tabs .RE .sp .RS 4

@@ -626,7 +630,9 @@ .sp -1

.IP \(bu 2.3 .\} -\fBTransparency\fR: This sets the transparency for a focused, unfocused window and the menu\&. +\fBWin+1\fR +\(-> +\fBWin+9\fR: Select the 1st \(-> 9th tab in the current window .RE .sp .RS 4

@@ -638,7 +644,9 @@ .sp -1

.IP \(bu 2.3 .\} -\fBOpaque Window Moving\fR: If enabled, you will see the window content while dragging it\&. Otherwise the window will be shown as a "border"\&. +\fBALT+F1\fR: Run +\fBxterm(1)\fR +to open a new terminal .RE .sp .RS 4

@@ -650,7 +658,9 @@ .sp -1

.IP \(bu 2.3 .\} -\fBFull Maximization\fR: Enabling this will override the separate settings for the slit/toolbar\&. Windows will always maximize over/under both of them\&. +\fBALT+F2\fR: Run +\fBfbrun(1)\fR +for a small \(lqrun program\(rq dialog .RE .sp .RS 4

@@ -662,7 +672,7 @@ .sp -1

.IP \(bu 2.3 .\} -\fBFocus New Window\fR: If enabled, a newly opened window will gain focus\&. +\fBALT+F4\fR: Close the current window .RE .sp .RS 4

@@ -674,7 +684,8 @@ .sp -1

.IP \(bu 2.3 .\} -\fBWindows Warping\fR: If enabled, you can drag windows from one workspace to another\&. +\fBALT+F5\fR: Kill the current window (like +\fBxkill(1)\fR) .RE .sp .RS 4

@@ -686,11 +697,8 @@ .sp -1

.IP \(bu 2.3 .\} -\fBClick Raises\fR: If enabled a click anywhere on a window area (including the decorations) will raise it\&. Otherwise you can only raise it by clicking the titlebar\&. +\fBALT+F9\fR: Minimize (iconify) the current window .RE -.SS "Window Menu" -.sp -The Window menu is displayed when you right click on the titlebar of a window\&. The options available are: .sp .RS 4 .ie n \{\

@@ -701,7 +709,7 @@ .sp -1

.IP \(bu 2.3 .\} -\fBSend To\&...\fR: 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\&. +\fBALT+F10\fR: Maximize the current window .RE .sp .RS 4

@@ -713,7 +721,7 @@ .sp -1

.IP \(bu 2.3 .\} -\fBShade\fR: Shade the window (display the titlebar only)\&. +\fBALT+F11\fR: Full\-screen the current window .RE .sp .RS 4

@@ -725,7 +733,8 @@ .sp -1

.IP \(bu 2.3 .\} -\fBIconify\fR: Iconify 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)\&. +\fBALT+Space\fR: Open the +\fBWindow Menu\fR .RE .sp .RS 4

@@ -737,40 +746,7 @@ .sp -1

.IP \(bu 2.3 .\} -\fBMaximize\fR: (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 +\fBCTRL+ALT+Del\fR: Exit fluxbox (log out) .RE .sp .RS 4

@@ -782,7 +758,9 @@ .sp -1

.IP \(bu 2.3 .\} -\fBRaise\fR: Raise the window\&. +\fBCTRL+ALT+Left\fR +/ +\fBCTRL+ALT+Right\fR: Go to the previous/next workspace .RE .sp .RS 4

@@ -794,7 +772,9 @@ .sp -1

.IP \(bu 2.3 .\} -\fBLower\fR: Lower the window\&. +\fBWIN+Left\fR +/ +\fBWIN+Right\fR: Send the current window to the previous/next workspace, but remain on this workspace .RE .sp .RS 4

@@ -806,7 +786,9 @@ .sp -1

.IP \(bu 2.3 .\} -\fBStick\fR: (Un)Stick window\&. A `stuck\' window will always be displayed on all workspaces\&. +\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

@@ -818,7 +800,9 @@ .sp -1

.IP \(bu 2.3 .\} -\fBLayer\&...\fR: Change the layer of this window\&. +\fBCTRL+F1\fR +\(-> +\fBCTRL+F12\fR: Switch to the 1st \(-> 12th workspace .RE .sp .RS 4

@@ -830,8 +814,9 @@ .sp -1

.IP \(bu 2.3 .\} -\fBRemember\&...\fR: Specify which window settings should be stored in the `apps\' file, covered in -\fBfluxbox\-apps(5)\fR\&. +\fBWIN+F1\fR +\(-> +\fBWIN+F12\fR: Send the current window to a specific workspace .RE .sp .RS 4

@@ -843,219 +828,188 @@ .sp -1

.IP \(bu 2.3 .\} -\fBClose\fR: Close the application softly\&. +\fBCTRL+WIN+F1\fR +\(-> +\fBCTRL+WIN+F12\fR: Take the current window to a specific workspace .RE -.SS "Workspace Menu" +.SH "MENUS" .sp -The workspace menu can be found by middle clicking on the background\&. A menu will popup giving you the option to add or remove a workspace\&. You will also see your workspaces listed there; middle clicking on a workspace name will take you to that workspace, whereas clicking on a window name in one of the per\-workspace submenus will take you to the workspace that window is on, and select the window\&. Last but not least you will notice the Icons menu\&. This is for applications which have been `iconified\'\&. -.SS "Menu Syntax" +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 -There are up to four fields in a menu line\&. They are of the form: +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 -.if n \{\ +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 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -[tag] (label|filename) {command|filename} <icon file> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ +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 -.\} -.sp -The supported tags are: .PP -[begin] (label) +\fBSystem Styles\fR .RS 4 -This tells fluxbox to start parsing the menu file\&. This tag is required for fluxbox to read your menu file\&. If it cannot find it, the system default menu is used in its place\&. +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 -[config] (label) +\fBUser Styles\fR: .RS 4 -Inserts a fluxbox native submenu item, containing numerous configuration options concerning window placement, focus style, window moving style, etc\&. +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 -[end] +\fBWorkspace List\fR: .RS 4 -This tells fluxbox that it is at the end of a menu\&. This can either be a submenu or the main root menu\&. There must be at least one of these tags in your menu to correspond to the required [begin] tag\&. +This is the same as the +\fBWorkspace Menu\fR +detailed below\&. .RE .PP -[exec] (label) {command} +\fBTools\fR: .RS 4 -Inserts a command item into the menu\&. When you select the menu item from the menu, fluxbox runs -\fIcommand\fR\&. +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 -[exit] (label) +\fBWindow Managers\fR: .RS 4 -Inserts an item that shuts down and exits fluxbox\&. Any open windows are reparented to the root window before fluxbox exits\&. +Allows you to switch your window manager\&. (Only listed if you have other window managers/desktop environments installed\&.) .RE .PP -[include] (file\-or\-directory\-name) +\fBLock Screen\fR: .RS 4 -Parses the file specified by filename inline with the current menu\&. The filename can be the full path to a file or it can begin with ~/, which will be expanded into your home directory\&. If the path is a directory, then all files in the directory are included\&. +Locks the screen, if a suitable locking program has been detected\&. .RE .PP -[nop] (label) +\fBFluxbox Command\fR: .RS 4 -Insert a non\-operational item into the current menu\&. This can be used to help format the menu into blocks or sections if so desired\&. This tag does support a label, but one is not required in which case a blank item will be used instead\&. +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 -[separator] +\fBReload config\fR: .RS 4 -This will create a nice separation line\&. Useful for splitting up sections in a -\fIpretty\fR -way\&. +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 -[style] (label) {filename} +\fBRestart\fR: .RS 4 -This tells fluxbox to insert an item that, when selected, reads style file named filename and apply the new textures, colors and fonts to the current running session\&. +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 -[stylesmenu] (directory) +\fBExit\fR: .RS 4 -Reads all filenames from the specified directory, assuming that they are all valid style files, and creates menu items in the current menu for every filename, that, when selected by the user will apply the selected style file to the current session\&. The labels that are created in the menu are the filenames of the style files\&. +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 -[stylesdir] (label) {directory} +\fBFocus Model\fR: .RS 4 -Creates a submenu entry with label (that is also the title of the new submenu), and inserts in that submenu all filenames in the specified directory, assuming that they are all valid style files (directories are ignored) in the same way as the [stylesdir] command does\&. Both [stylesdir] and [stylesmenu] commands make it possible to install style files without editing your init file\&. +Lets you configure the window focus model\&. For details, see +\fBFOCUS MODEL\fR, below\&. .RE .PP -[submenu] (label) {menutitle} +\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 -This tells fluxbox to create and parse a new menu\&. This menu is inserted as a submenu into the parent menu\&. These menus are parsed recursively, so there is no limit to the number of levels or nested submenus you can have\&. The title for the new menu is optional, if none is supplied, the new menu\'s title is the same as the item label\&. An [end] tag is required to end the submenu\&. +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 -[reconfig] (label) +\fBIgnore Resize Increment\fR: .RS 4 -When selected this item re\-reads the current style and menu files and applies any changes\&. This is useful for creating a new style or theme, as you don\'t have to constantly restart fluxbox every time you save your style\&. However, fluxbox automatically rereads the menu whenever it changes\&. +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 -[restart] (label) {command} +\fBDisable Moving\fR / \fBDisable Resizing\fR: .RS 4 -This tells fluxbox to restart\&. If command is supplied, it shuts down and runs the command (which is commonly the name of another window manager)\&. If the command is omitted, fluxbox restarts itself\&. +Normally, maximized windows can still be moved and resized\&. Enabling these options prevents these behaviour\&. +.RE .RE .PP -[wallpapers] (directory) {command} +\fBTab Options\fR: .RS 4 -This inserts a menu item to set the wallpaper for each file in the given directory\&. The command is optional and defaults to fbsetbg\&. +Lets you configure the properties of tabs\&. Detailed in +\fBTAB OPTIONS\fR, below\&. .RE .PP -[workspaces] (label) +\fBSlit\fR: .RS 4 -This tells fluxbox to insert a link to the workspaces menu directly into your menu\&. This is handy for those users who can\'t access the workspace menu directly (e\&.g\&. if you don\'t have a 3 button mouse, it is rather hard to middle click to show the workspace menu)\&. +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 -[\fIcommand\fR] (label) +\fBToolbar\fR: .RS 4 -In addition to the commands above, any legal key command may be used as a menu item\&. See fluxbox\-keys(5) for more information\&. +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 -.sp -Any line that starts with a \fI#\fR or \fI!\fR is considered a comment and ignored by fluxbox\&. Also, in the label/command/filename fields you can escape any character\&. Using \fI\e\e\fR inserts a literal back\-slash into the label/command/filename field\&. +.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 -Here is an example menu file: +The transparency of individual application windows can be overridden in the `apps\' file (\fBfluxbox\-apps(5)\fR)\&. .sp -.if n \{\ +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 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -# fluxbox menu file -[begin] (fluxbox) - [exec] (rxvt) {rxvt \-ls} </usr/X11R6/share/icons/terminal\&.xpm> - [exec] (netscape) {netscape \-install} - [exec] (The GIMP) {gimp} - [exec] (XV) {xv} - [exec] (Vim) {rxvt \-geometry 132x60 \-name VIM \-e screen vim} - [exec] (Mutt) {rxvt \-name mutt \-e mutt} - [submenu] (mozilla) - [exec] (browser) {mozilla \-browser} - [exec] (news) {mozilla \-news} - [exec] (mail) {mozilla \-mail} - [exec] (edit) {mozilla \-edit} - [exec] (compose) {mozilla \-compose} - [end] - [submenu] (Window Manager) - [exec] (Edit Menus) {nedit ~/\&.fluxbox/menu} - [submenu] (Style) {Which Style?} - [stylesdir] (~/\&.fluxbox/styles) - [stylesmenu] (fluxbox Styles) {@pkgdatadir@/styles} - [end] - [config] (Config Options) - [reconfig] (Reconfigure) - [restart] (Restart) - [end] - [exit] (Log Out) -[end] -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ +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 -.\} -.SH "TOOLBAR" +.SS "Window Menu" .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 style and can\'t be defined as a global setting (except with the style overlay)\&. +The Window menu is displayed when you right click on the titlebar of a window\&. .sp -The tools in the toolbar can be enabled/disabled in the init file with the arguments given to the line: +To customize this menu, see the \fBWINDOW MENU\fR section of \fBfluxbox\-menu(5)\fR\&. .sp -.if n \{\ +By default, this menu contains: +.PP +\fBShade\fR: .RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.screen0\&.toolbar\&.tools -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ +Shade the window (display the titlebar only)\&. .RE -.\} -.sp -The order and number of tools is freely selectable, but they must be separated by a ","\&. E\&.g\&.: -.sp -.if n \{\ +.PP +\fBStick\fR: .RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.screen0\&.toolbar\&.tools: workspacename, systemtray, iconbar, clock -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ +(Un)Stick window\&. A `stuck\' window will always be displayed on all workspaces\&. .RE -.\} -.sp -The possible tools are: -.sp +.PP +\fBSend To\&...\fR: .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBClock\fR: This will show an area to display a clock and the date according to the format specification listed in "man strtftime" +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 \{\

@@ -1065,8 +1019,7 @@ .el \{\

.sp -1 .IP \(bu 2.3 .\} - -\fBIconbar\fR: This is the area that contains all windows (all running applications, all minimized windows or maybe no window, all depending on the Toolbar Settings)\&. +Button 1 (Un)Maximize as normal\&. .RE .sp .RS 4

@@ -1077,8 +1030,7 @@ .el \{\

.sp -1 .IP \(bu 2.3 .\} - -\fBSystemtray\fR: The Systemtray can hold applications that are made to use it\&. +Button 2 (Un)Maximize window vertically\&. .RE .sp .RS 4

@@ -1089,371 +1041,418 @@ .el \{\

.sp -1 .IP \(bu 2.3 .\} - -\fBWorkspaceName\fR: This displays the name of the current workspace\&. +Button 3 (Un)Maximize window horizontally\&. +.RE .RE -.sp +.PP +\fBIconify\fR: .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBPrevWorkspace\fR: This displays an arrow that allows to switch to the workspace left of the current one\&. +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 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBNextWorkspace\fR: This displays an arrow that allows to switch to the workspace right of the current one\&. +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 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBPrevWindow\fR: This displays an arrow that switches focus to the previous visible window on the current workspace\&. +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 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBNextWindow\fR: This displays an arrow that switches focus to the next visible window on the current workspace\&. +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 -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 RESOURCES section for more information about that)\&. -.SS "Configuration via the Toolbar Menu" +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 -All changes take effect immediately, except for a change of the "Toolbar Alpha", which needs a restart to make the change visible\&. Here are the settings: +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 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBVisible\fR: Sets the toolbar either to visible or invisible\&. -.sp -.if n \{\ +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 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.screen0\&.toolbar\&.visible: <boolean> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ +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 -.sp +.PP +\fBWorkspaceName\fR: .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBAuto hide\fR: 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\&. -.sp -.if n \{\ +This displays the name of the current workspace\&. +.RE +.PP +\fBPrevWorkspace\fR: .RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.screen0\&.toolbar\&.autoHide: <boolean> -session\&.autoRaiseDelay: <int> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ +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 -.sp +.PP +\fBPrevWindow\fR: .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBToolbar width percentage\fR: Sets the width of the toolbar in percent\&. Use the left mouse button to decrease and the right mouse\-button to increase the value\&. The value can be from 1\-100\&. +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 -.if n \{\ +All changes take effect immediately\&. Here are the settings: +.PP +\fBVisible\fR: .RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.screen0\&.toolbar\&.widthPercent: <int> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ +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 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBMaximize Over\fR: Enabling this option will prevent windows from maximizing over the toolbar\&. With this switched on they will only expand to the edge of the bar\&. To use this option, "Full Maximization" from the Configuration menu must be DISABLED\&. Otherwise this option will not work\&. -.sp -.if n \{\ +Will not show any windows +.RE +.PP +\fBIcons\fR: .RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.screen0\&.toolbar\&.maxOver: <boolean> -session\&.screen0\&.fullMaximization: <boolean> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ +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 -.sp +.PP +\fBWorkspaceIcons\fR: .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBLayer\&...\fR: This sets the layer on which the toolbar is set\&. With this you can set the toolbar to "Always on top"\&. -.sp -.if n \{\ +Shows windows from the current workspace that are iconified +.RE +.PP +\fBWorkspaceNoIcons\fR: .RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.screen0\&.toolbar\&.layer: <layer> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ +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 -.sp +.PP +\fBAll Windows\fR: .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBPlacement\fR: Sets the toolbar to any edge of the screen, either centered or aligned with a corner\&. +Shows all windows (iconified or not) from all workspaces +.RE .sp -.if n \{\ +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 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.screen0\&.toolbar\&.placement: <direction> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ +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 -.sp +.PP +\fBRight\fR: .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBAlpha\fR: 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\&. +All icons will be right\-aligned with the width set in the `init\' file +.RE .sp -.if n \{\ +The last option in this submenu is: +.PP +\fBShow Pictures\fR: .RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.screen0\&.toolbar\&.alpha: <int> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ +If enabled the iconbar will show the application\'s icon (if provided by the application) .RE -.\} .RE -.sp +.PP +\fBClock\fR: .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBIconbar Mode\fR: +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 -.if n \{\ +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 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -Specifies the mode of the iconbar: -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ +Click to focus windows\&. .RE -.\} +.PP +\fBMouse Focus\fR: +.RS 4 +Window focus follows mouse\&. .RE -.sp +.PP +\fBClickTabFocus\fR: .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBNone\fR: will not show any windows +Click to focus tabs\&. .RE -.sp +.PP +\fBMouseTabFocus\fR: .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBIcons\fR: shows windows from all workspaces that are minimized (iconified) +Tab focus follows mouse\&. .RE .sp +There are three more settings in the \(lqFocus Model\(rq menu: +.PP +\fBFocus New Windows\fR: .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBNoIcons\fR: shows windows from all workspaces that are not minimized (iconified) +If enabled, a new window will grab X focus as soon as it is opened\&. .RE -.sp +.PP +\fBAuto Raise\fR .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBWorkspaceIcons\fR: shows windows from the current workspace that are minimized (iconified) +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 -.sp +.PP +\fBClick Raises\fR .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBWorkspaceNoIcons\fR: shows windows from the current workspace that are not minimized (iconified) +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 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBWorkspace\fR: shows all windows from the current workspace +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 -.sp +.PP +\fBTabs in Titlebar\fR: .RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBAll Windows\fR: shows all windows from all workspaces +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

@@ -1462,7 +1461,10 @@ .fam C

.ps -1 .nf .BB lightgray -session\&.screen0\&.iconbar\&.mode: <mode> +bbmail \-w & +bbpager \-w & +wmdrawer & +exec fluxbox .EB lightgray .fi .fam

@@ -1470,19 +1472,65 @@ .ps +1

.if n \{\ .RE .\} -.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 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBAlignment\fR: +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 startfluxbox(8) 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 \{\

@@ -1492,8 +1540,7 @@ .el \{\

.sp -1 .IP \(bu 2.3 .\} - -\fBLeft\fR: all icons will be left\-aligned with the width set in the init file +2 \- Above Dock .RE .sp .RS 4

@@ -1504,8 +1551,7 @@ .el \{\

.sp -1 .IP \(bu 2.3 .\} - -\fBRelative\fR: all icons will be sized evenly to fill the iconbar completely +4 \- Dock .RE .sp .RS 4

@@ -1516,25 +1562,7 @@ .el \{\

.sp -1 .IP \(bu 2.3 .\} - -\fBRight\fR: all icons will be right\-aligned with the width set in the init file -.sp -.if n \{\ -.RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.screen0\&.iconbar\&.alignment: <alignment> -session\&.screen0\&.iconbar\&.iconWidth: <int> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ -.RE -.\} +6 \- Top .RE .sp .RS 4

@@ -1545,24 +1573,7 @@ .el \{\

.sp -1 .IP \(bu 2.3 .\} - -\fBShow Pictures\fR: If enabled the iconbar will show the application\'s icon (if provided by the application) -.sp -.if n \{\ -.RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.screen0\&.iconbar\&.usePixmap: <boolean> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ -.RE -.\} +8 \- Normal .RE .sp .RS 4

@@ -1573,8 +1584,7 @@ .el \{\

.sp -1 .IP \(bu 2.3 .\} - -\fBClock\fR: Lets you switch between the 00:00am \- 11:59pm and 00:00 \- 23:59 notation +10 \- Bottom .RE .sp .RS 4

@@ -1585,33 +1595,15 @@ .el \{\

.sp -1 .IP \(bu 2.3 .\} - -\fBEdit Clock Format\fR: clicking this entry will pop up a little window in which the clock format can be set according to -\fIman strftime\fR -(or -\fIman date\fR)\&. +12 \- Desktop +.RE .sp -.if n \{\ -.RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.screen0\&.strftimeFormat: <format> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ -.RE -.\} -.RE +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 ~/\&.fluxbox/init resource file is created and maintained by fluxbox itself\&. You can use the [config] menu 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 `reconfigure\' to reload the resource options\&. +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 desktop environment the screen0 key can also be screen1, screen2, etc\&. You can customize the behavior of fluxbox on each desktop accordingly\&. Here are the resources that are currently available: +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: .sp .if n \{\ .RS 4

@@ -1622,10 +1614,10 @@ .nf

.BB lightgray session\&.screen0\&.window\&.focus\&.alpha: <integer> session\&.screen0\&.window\&.unfocus\&.alpha: <integer> - 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\&. - Default: 255 + 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\&. + Default: 255 session\&.screen0\&.slit\&.autoHide: <boolean> session\&.screen0\&.toolbar\&.autoHide: <boolean>

@@ -1681,6 +1673,8 @@

session\&.screen0\&.toolbar\&.tools: <tools> 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 \',\' character\&. + They will appear in the order given\&. Possible tools:: \- clock \- iconbar

@@ -1711,7 +1705,7 @@ This specifies the space between the window title and the edge of the

button\&. Default: 10 session\&.screen0\&.iconbar\&.alignment: <position> - This value should be changed in the Iconbar Mode menu\&. Default: + This value should be changed in the Iconbar Mode menu\&. Default: Relative Available options:

@@ -1781,7 +1775,7 @@ Default: True

session\&.screen0\&.workspaceNames: <names> Here is where the user can name their workspaces\&. However it is - recommended to use the tool available in the Configuration Menu to set + recommended to use the tool available in the Workspace Menu to set these\&. Default: one, two, three, four session\&.screen0\&.edgeSnapThreshold: <integer>

@@ -1882,368 +1876,6 @@ .ps +1

.if n \{\ .RE .\} -.SH "KEYS" -.sp -You can customize fluxbox\'s key handling through the ~/\&.fluxbox/keys file\&. See \fIfluxbox\-keys(5)\fR for more information on the syntax of this file\&. -.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 number of layers can be changed by using the following resource: -.sp -.if n \{\ -.RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.numLayers: <integer> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ -.RE -.\} -.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 "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: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBClick To Focus\fR: click to focus windows -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBMouse Focus\fR: window focus follows mouse -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBClickTabFocus\fR: click to focus tabs -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBMouseTabFocus\fR: tab focus follows mouse -.RE -.sp -There is one more option in the focus model menu\&. It is called AutoRaise\&. When AutoRaise is enabled, focused windows will appear on top of other windows in the same layer\&. When AutoRaise is disabled, you must explicitly raise a focused window, using the window menu or keybinding\&. -.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: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBPlacement\fR: 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 -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBTabs in Titlebar\fR: When this option is on, tabs are fixed in window titlebar and the width varies according to the amount of windows grouped\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBMaximize Over\fR: When this option is on, maximizing a window will disregard the size and location of external tabs\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBExternal Tab Width\fR: This specifies in pixels the width of external tabs\&. -.RE -.sp -As with most Fluxbox configurations, these options can be changed by editing the init file\&. The resources that you should look at are: -.sp -.if n \{\ -.RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.screen0\&.tabs\&.intitlebar: <boolean> -session\&.screen0\&.tab\&.width: <integer> -session\&.screen0\&.tab\&.placement: <direction> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ -.RE -.\} -.SH "STYLES" -.sp -fluxbox enables you to use specialized files that contain X(1) 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 fluxbox\-style(5) to accommodate the growing number of style components\&. -.SH "STYLE OVERLAY" -.sp -In addition to the style file, the overlay file, whose location is specified by session\&.screen0\&.styleOverlay (default: ~/\&.fluxbox/overlay ) 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 fluxbox\-style(5)\&. -.SH "THE SLIT" -.sp -The slit is a special fluxbox window frame that can contain dockable applications, e\&.g\&. \fIbbtools\fR or \fIwmapps\fR\&. -.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 ~/\&.xinitrc: -.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 -NOTE: You can also put all of these in the startfluxbox(8) script\&. This way you would only need to specify: exec startfluxbox in your ~/\&.xinitrc\&. -.sp -To use the slit you must have it compiled into fluxbox\&. This is the default setting\&. -.SH "Slit Menu" -.sp -You can right click on the edge of the slit window to get a menu to configure its position, whether its contained applications should be grouped horizontally or vertically and whether the slit should hide itself when the mouse moves away\&. The slit menu items are described in more detail below: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBPlacement\fR: This lets you set the position of the slit\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBLayer\fR: Look above for the layer priorities\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBAuto hide\fR: If enabled, the slit will disappear after a given amount of time and hide from the view of the user\&. You can make it appear if you move the mouse to the edge of the desktop where the slit is positioned\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBMaximize over\fR: If this is enabled, all windows, if you maximize them, will stretch over/under the slit\&. Otherwise the will be limited to the slit\'s edge\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBAlpha\fR: By changing the value the slit (only the decoration not the apps in the slit) will become transparent\&. 0 (transparent) \- 255 (opaque) -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} - -\fBClients\fR: 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 appear by selecting them in the list\&. The "Save SlitList" option saves the new order to you slitlist located in ~/\&.fluxbox (useful if you reordered the apps with the cycle option)\&. -.RE -.SH "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 ~/\&.fluxbox/slitlist -.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 auto\-run script, or better yet your startfluxbox(8) script\&. -.sp -This sequence will be saved by default to ~/\&.fluxbox/slitlist 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 xprop(1), 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\&. The following is the init file component that needs to be changed: -.sp -.if n \{\ -.RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -session\&.session0\&.slitlistFile: <filename> -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ -.RE -.\} .SH "ENVIRONMENT" .PP HOME

@@ -2256,25 +1888,11 @@ .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 certain commands in the keys and menu files\&. So one can do: +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 -.if n \{\ -.RS 4 -.\} -.fam C -.ps -1 -.nf -.BB lightgray -Mod1 x ExecCommand :$TERM -.EB lightgray -.fi -.fam -.ps +1 -.if n \{\ -.RE -.\} +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, see your shell\'s manual\&. +For more information about environment variables in general, see your shell\'s manual\&. .SH "SIGNALS" .sp fluxbox responds to the following signals:

@@ -2319,9 +1937,22 @@ Blackbox was written and maintained by Brad Hughes <blackbox at alug org> and Jeff Raven <jraven at psu edu>\&.

.sp The Official fluxbox website: \m[blue]\fBhttp://www\&.fluxbox\&.org\fR\m[] .sp -Many compatible themes: \- \m[blue]\fBhttp://boxwhore\&.org\fR\m[] \- \m[blue]\fBhttp://themes\&.freshmeat\&.net/\fR\m[] +The Official fluxbox wiki: \m[blue]\fBhttp://www\&.fluxbox\-wiki\&.org\fR\m[] +.sp +Many compatible themes: \m[blue]\fBhttp://tenr\&.de\fR\m[] .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\&.1\&.1) +.RE .sp .RS 4 .ie n \{\

@@ -2393,4 +2024,4 @@ .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) bsetroot(1) fbsetbg(1) fbrun(1) fluxbox\-style(5) fluxbox\-remote(1) +fluxbox\-apps(5) fluxbox\-keys(5) fluxbox\-style(5) fluxbox\-menu(5) fluxbox\-remote(1) bsetroot(1) fbsetbg(1) fbrun(1)