added new `fluxbox-keys' man page
Jim Ramsay i.am@jimramsay.com
7 files changed,
2602 insertions(+),
1847 deletions(-)
M
doc/Makefile.am
→
doc/Makefile.am
@@ -5,7 +5,7 @@ SUBDIRS = ru
CLEANFILES = fluxbox.1 fluxstyle.1 MAINTAINERCLEANFILES = Makefile.in man_MANS = fluxbox.1 fbsetroot.1 fbrun.1 fbsetbg.1 \ - startfluxbox.1 fluxstyle.1 fbrun.1 + startfluxbox.1 fluxstyle.1 fbrun.1 fluxbox-keys.5 EXTRA_DIST=fluxbox.1.in fbsetroot.1 fbrun.1 startfluxbox.1 fbsetbg.1 \ fluxstyle.1.in CODESTYLE distclean-local:
A
doc/asciidoc/fluxbox-keys.txt
@@ -0,0 +1,677 @@
+fluxbox-keys(5) +=============== +Jim Ramsay <i.am@jimramsay.com> +v1.1.0, 22 July, 2008 + +NAME +---- +fluxbox-keys - keyboard shortcuts configuration for fluxbox(1) + +SYNOPSIS +-------- +~/.fluxbox/keys + +SYNTAX +------ +Variable parameters are shown in emphasis: 'argument' + +Optional parameters are shown in square brackets: ['argument'] + +All other characters shown are required verbatim. Whitespace is required +where shown, but it is fine to add more whitespace. + +DESCRIPTION +----------- +The keys file defines the keyboard shortcuts for 'fluxbox(1)'. + +You can customize fluxbox's key handling through the ~/.fluxbox/keys file. The +file consists of lines of the basic format: + +*['modifiers'] 'key' :'command' ['arguments' '...']* + +The space between the 'key' and the *:* before the 'command' is mandatory. + +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. + +Lines beginning with a '#' or '!' are considered comments and are unread by +fluxbox. + +MODIFIERS +--------- +You can get a list of possible modifiers by calling `xmodmap -pm'. This also +shows you to which keys the modifiers are mapped, but the following modifiers +are most commonly used: + +*Shift Control Mod1 Mod4* + +where *Mod1* is the Alt key on the PC keyboard and *Mod4* is usually a key +branded with a familiar company logo. + +There are also some special modifiers that refer to mouse button presses::: +*OnDesktop*;; + The mouse cursor is over the desktop (root window), and not any + window. +*OnToolbar*;; + The mouse cursor is over the toolbar (which is normally at the bottom + of the screen). +*OnWindow*;; + The mouse cursor is over a window. +*OnTitlebar*;; + The mouse cursor is over a window's titlebar. +*Double*;; + Limits this action to double-clicks only. + +Combining Modifiers +~~~~~~~~~~~~~~~~~~~ +To combine two or more modifiers, just list them (space-delimited) in any +order. + +KEYS +---- +You may specify a key by its key name (for example, *a* or *space*) or by its +numeric keycode (for example, *38* or *0xf3*). + +If you don't know the name of a key, you can run 'xev(1)' in a terminal, push +the key, and see the name in the output. If you have some "special" keys that +do not produce a key name in the output of 'xev(1)', you can just use the +keycode (NOT the keysym!) in your keys file. + +Commands can also be bound to mouse button presses, for which the proper "key" +name is *Mouse*'n' where 'n' is the number of the mouse button. For example, +*Mouse1* is the primary button, and *Mouse4* / *Mouse5* are the scroll wheel +events, in normal configurations. 'xev(1)' can also be used to tell the button +number. + +//////////////// +There are some special "keys" that let you bind events to non-keyboard events::: +*ChangeWorkspace*;; + Fires when the workspace changes +TODO: Advanced users only? +*FocusIn* / *FocusOut*;; + Fires when the focus is given to or removed from a window. It may be + useful to combine this with the 'If' command, in the section *Special + Commands* below. +*MouseOver* / *MouseOut*;; + Fires when the mouse cursor enters or leaves a specific area of the + screen. It may be useful to combine this with the 'On*' modifiers + detailed above and/or the 'If' command. + +//////////////// +CHAINING +-------- +Key bindings can be chained in a fashion similar to Emacs key bindings using the +syntax: + +*'modifiers-1' 'key-1' 'modifiers-2' 'key-2' :'command' ['arguments ...']* + +.To Bind CTRL+C CTRL+X (Which means, press CTRL+C then CTRL+X) to quit fluxbox +........ +Control c Control x :Quit +........ + +KEYMODES +-------- +A specific set of key mappings can be activated and de-activated on-the-fly +using what are called keymodes. The syntax to define a mapping in a keymode +is: + +*'keymode': 'modifiers' 'key' :'command' ['arguments' '...']* + +Where 'keymode' is any alpha-numeric string name. + +When this keymode is activated (see the *KeyMode* command below), all bindings +prefaced by that keymode name become active (and all other keybindings will be +deactivated) until the keymode changes again. + +COMMANDS +-------- +Some commands have multiple names which are shown below as::: + CMD1 | CMD2 + +Related commands have been grouped below as::: + CMD1 / CMD2 + +The commands are broken up into sections as follows::: +- Mouse Commands +- Window Commands +- Workspace Commands +- Menu Commands +- Window Manager Commands +- Special Commands + +Mouse Commands +~~~~~~~~~~~~~~ +These commands may only be bound to mouse buttons (plus modifiers), not +keystrokes. In all cases, the action finishes when the mouse button is +released. + +*StartMoving*:: + Start dragging to move the window. + +*StartResizing* ['corner']:: +Start dragging to resize the window as if you had grabbed the window +at the specified 'corner'. ++ +By default 'corner' is *BottomRight*, but may be overridden with one of:;; +*NearestCorner NearestEdge Center TopLeft Top TopRight Left Right BottomLeft +BottomRight* + +*StartTabbing*:: + Start dragging to add this window to another's tabgroup. + +Window Commands +~~~~~~~~~~~~~~~ +These commands affect only the currently focused window. + +*Activate* | *Focus*:: + Set the focus to the window matching the argument, and raise it. + +*Minimize* | *MinimizeWindow* | *Iconify*:: + Minimize the current window, equivalent to the window button. + +*Maximize* | *MaximizeWindow*:: + Maximize the current window, equivalent to the window button. + +*MaximizeHorizontal* / *MaximizeVertical*:: + Maximize the current window in one direction only, leaving the other + dimension unchanged. + +*Raise* / *Lower*:: + Reorder this window to the top or bottom of the window stack, within + its current layer. See 'fluxbox(1)' for a discussion of layers. + +*RaiseLayer* / *LowerLayer*:: + Raise the window up to the layer above, or lower it to the layer + below. See 'fluxbox(1)' for a discussion of layers. + +*Close*:: + Close the current window, equivalent to the window button. + +*Kill* | *KillWindow*:: + Close a window that's not responding to *Close*, like using `xkill`. + +*Shade* | *ShadeWindow*:: + Toggle the *shaded* state of the current window, equivalent to the + window button. A *shaded* window appears as only the title bar. + +*ShadeOn* / *ShadeOff*:: + Set the *shaded* state of the window to On / Off. + +*Stick* | *StickWindow*:: + Toggle the *sticky* state of the current window, equivalent to the + window button. A *sticky* window is visible on all workspaces. + +*ToggleDecor*:: + Toggles the presence of the window decorations (title bar, window + buttons, and resize bar). + +*NextTab* / *PrevTab*:: + Cycle to the next / previous tab in the current tab group. + +*Tab* 'number':: + Cycle to the given tab in the current tab group, where *1* is the + first tab. A negative 'number' counts from the end of the tab group + (*-1* is the last tab, *-2* is the next-to-last, etc.). + +*MoveTabRight* / *MoveTabLeft*:: + Reorder the tabs in the current tab group, swapping the current tab + with the one to the right / left. + +*DetachClient*:: + Remove the current tab from the tab group, placing it in its own window. + +*ResizeTo* 'width' 'height':: + Resizes the window to the given width and height. + +*Resize* 'delta-width' 'delta-height':: + Resizes the window relative to the current width and height. + +*ResizeHorizontal* 'delta-width' / *ResizeVertical* 'delta-height':: + Resizes the window in one dimension only + +*MoveTo* 'x' 'y' ['anchor']:: +Moves the window to the given coordinates, given in pixels. ++ +If either 'x' or 'y' is set to *\**, that coordinate will be ignored, and the +movement will only take place in one dimension. ++ +The default 'anchor' is the upper left corner, but this may be overridden with one of:;; +*UpperLeft LowerLeft UpperRight LowerRight* + +*Move* 'delta-x' 'delta-y':: + Moves the window relative to its current position. Positive numbers + refer to right and down, and negative to left and up, respectively. + +*MoveRight* 'd' / *MoveLeft* 'd' / *MoveUp* 'd' / *MoveDown* 'd':: + Moves the window relative to its current position by the number of + pixels specified in 'd'. If the number is negative, it moves in the + opposite direction. + +*TakeToWorkspace* 'workspace' / *SendToWorkspace* 'workspace':: + Sends you along with the current window to the selected workspace. + SendToWorkspace just sends the window. The first workspace is number + *1*, not 0. + +*TakeToNextWorkspace* ['offset'] / *TakeToPrevWorkspace* ['offset']:: + Sends you along with the current window to the next or previous + workspace. If you set 'offset' to a value greater than the default of + *1*, it will move you that number of workspaces ahead or behind. If + you go beyond the end of the currently defined workspaces, it will + wrap around to the other end automatically. + +*SendToNextWorkspace* ['offset'] / *SendToPrevWorkspace* ['offset']:: + Identical to the "TakeTo..." commands, but again this sends only the + window, and does not move you away from your current workspace. + +*SetAlpha* ['alpha' ['unfocused-alpha']]:: +Sets the alpha value of a window. ++ +Putting a *+* or *-* in front of +the value adds or subtracts from the current value. A plain integer +sets the value explicitly. ++ +no arguments;; + Resets both focused and unfocused settings to default opacity. +one argument;; + Changes both focused and unfocused alpha settings. +two arguments;; + First value becomes the focused alpha, second becomes the unfocused + alpha value. + +*SetHead* 'number':: + Moves the window to the given display head. Only available when fluxbox + has been compiled with Xinerama support. + +Workspace Commands +~~~~~~~~~~~~~~~~~~ +These commands affect the entire workspace (or "desktop" as it is sometimes +called). + +*AddWorkspace* / *RemoveLastWorkspace*:: + Adds or removes a workspace from the end of the list of workspaces. + +*NextWorkspace* ['n'] / *PrevWorkspace* ['n'] / *RightWorkspace* ['n'] / *LeftWorkspace* ['n']:: + Switch to the Next / Previous workspace. All versions accept an + offset value 'n', which defaults to *1* and refers to the number of + workspaces to move at one time. {Next,Prev}Workspace wrap around when + going past the last workspace, whereas {Right,Left}Workspace do not. + +*Workspace* 'number':: + Jumps to the given workspace 'number'. The first workspace is *1*. + +*NextWindow* [{'options'}] ['pattern'] / *PrevWindow* [{'options'}] ['pattern']:: +Focuses and activates the next / previous window in the focus list. ++ +'options' is one or more of the following, space delimited:;; ++ +-- + *static*;; + Instead of moving in order of most-recent focus, move in + order of when the window was opened (or, the order shown in + the iconbar). + *groups*;; + Only include the current tab in windows with multiple tabs. +-- ++ +If 'pattern' arguments are supplied, only windows that match all the +patterns are considered - all others are skipped. See the section *CLIENT +PATTERNS* below for more information. ++ +This pair of commands has a special side-effect when the keybinding used has a +modifier - It will temporarily raise the cycled window to the front so you can +see it, but if you continue holding down the modifier and press the key again +(For example, keep holding "Alt" while you tap the "Tab" key a few times), +fluxbox will lower the window again when you move on to the next one. This +allows you to preview the windows in order, but does not change the order in +doing so. + +*NextGroup* [{'options'}] ['pattern'] / *PrevGroup* [{'options'}] ['pattern']:: + Equivalent to NextWindow / PrevWindow above, but with the *groups* + option forced on. + +*GotoWindow* 'number' [{'options'}] ['pattern']:: + Focuses and activates the window at position 'number' in the focus + list. The 'options' and 'pattern' arguments have the same meaning as + *NextWindow* above. + +*Attach* 'pattern':: + Combines all windows that match the 'pattern' into a single tab group. + See *CLIENT PATTERNS* for more about the 'pattern' arguments. + +*FocusLeft* / *FocusRight* / *FocusUp* / *FocusDown*:: + Focus to the next window which is located in the direction specified. + +*ArrangeWindows* 'pattern':: + Tries to arrange all windows on the current workspace so that they + overlap the least amount possible. See *CLIENT PATTERNS* for more about + the 'pattern' arguments. + +*ShowDesktop*:: + Iconifies all windows. + +*Deiconify* 'mode' 'destination':: +Deiconifies windows (or, restores from a minimized state). ++ +Where 'mode' may be one of:;; ++ +-- + *All*;; + All icons across all workspaces. + *AllWorkspace*;; + All icons on the current workspace. + *Last*;; + The last icon across all workspaces. + *LastWorkspace* (default);; + The last icon on the current workspace. + +-- ++ +And 'destination' may be one of:;; ++ +-- + *Current* (default);; + Deiconify to the current workspace. +////// + TODO: Leave this out until it is stable! + *Origin*;; + Deiconify to the window's original workspace, and moves you + there.... sometimes? +////// + *OriginQuiet*;; + Deiconify to the window's original workspace, but does so in + the background, without moving you there. +-- + +*SetWorkspaceName* 'name' / *SetWorkspaceNameDialog*:: + Sets the name of the current workspace. + +*CloseAllWindows*:: + Closes all windows on all desktops. + +Menu Commands +~~~~~~~~~~~~~ +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. + +*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. + +*CustomMenu* 'path':: + Opens a custom menu file. + +*HideMenus*:: + Hide all fluxbox popup menus. + +Window Manager Commands +~~~~~~~~~~~~~~~~~~~~~~~ +These commands affect the Window Manager, or more than one window. + +*Restart* ['path']:: + Restarts fluxbox. This does not close any running applications. If + the optional 'path' is a path to an executable window manager, that + manager is started in place of fluxbox. + +*Quit* | *Exit*:: + Exits fluxbox. This will normally cause X to stop as well and + terminate all existing applications, returning you to the login + manager or console. + +*Reconfig* | *Reconfigure*:: + Reloads all fluxbox configuration files including the keys file, apps + file, and init file, if they have changed. + +*SetStyle* 'path':: + Sets the current style to that given in 'path', which must be the full + path to a fluxbox style. + +*ReloadStyle*:: + Reloads only the current style. Useful after editing a style which is + currently in use. + +*ExecCommand* 'args ...' | *Exec* 'args ...' | *Execute* 'args ...':: + Probably the most-used binding of all. Passes all the arguments to + 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 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. + +*CommandDialog*:: + Pops up a dialog box that lets you type in any of these commands + manually. + +*SetEnv* 'name' 'value' | *Export* 'name'='value':: + Sets an environment variable in Fluxbox. It will be passed to any + applications spawned by any future ExecCommand commands. + +*SetResourceValue* 'resourcename' 'resourcevalue' | *SetResourceValueDialog*:: + Sets a fluxbox resource value, which are normally stored in the init + file. See 'fluxbox(1)' for more details on available resources and + allowed values. + +Special Commands +~~~~~~~~~~~~~~~~ +These commands have special meanings or behaviors. + +*MacroCmd* {'command1'} {'command2'} {'command3'} '...':: + Allows you to execute more than one command with one keybinding. The + commands will be executed in series. The *{* *}* brackets are + literally required, as in the following example: + + MacroCmd {MoveTo 0 0} {ResizeTo 1280 800} + +*Delay* {'command'} ['microseconds']:: + Delays running 'command' for the given amount of time. If the same + key binding is activated again, the timer will be restarted. + +*ToggleCmd* {'command1'} {'command2'} '...':: + Alternates between the commands. On the first press of the bound + key, runs 'command1'. On the next press, runs 'command2'. + +*BindKey* 'keybinding':: + Adds the given 'keybinding' (which must be a valid key binding as + defined in the DESCRIPTION section above) to your keys file. + +*KeyMode* 'keymode' ['return-keybinding']:: + Activates the named 'keymode' (or, all key binding lines prefaced + with the same 'keymode':) and deactivates all others until the + 'return-keybinding' (by default *Escape*) is pressed. The default + keymode is named 'default'. + +*ForEach* {'command'} [{'condition'}] | *Map* {'command'} [{'condition'}]:: + Runs the given 'command' (normally one from the *Window Commands* + section above) on each window. If you specify a 'condition' (See + *Conditions*, below) the action will be limited to matching windows. + +*If* {'condition'} {'then-command'} [{'else-command'}] | *Cond* {'condition'} {'then-command'} [{'else-command'}]:: + If the 'condition' command returns *true*, then run the + 'then-command', otherwise run the optional 'else-command'. See + *Conditions* below for more information on the 'condition' argument. + +Conditions +~~~~~~~~~~ +These special commands are used to match windows conditionally. They are +commonly used by the *If* and *ForEach* command. + +*Matches* 'pattern':: +Returns *true* if the current window matches the given 'pattern'. See *CLIENT +PATTERNS* below for details on the 'pattern' syntax. ++ +If your key binding uses the *OnWindow* modifier, it matches against the window +you clicked, not the currently focused window. ++ +To check other windows besides the currently focused one, see the *Every* and +*Some* conditions below. + +*Some* 'condition':: + Retuns *true* if any window on any workspace (not just the currently + focused one) matches the 'condition'. + +*Every* 'condition':: + Retuns *true* if every window on every workspace (not just the + current one) matches the 'condition'. + +*Not* 'condition':: + Returns *true* if 'condition' returns *false*, and vice-versa. + +*And* {'condition1'} {'condition2'} [{'condition3'} ...]:: + Returns *true* if and only if all given conditions return *true*. + +*Or* {'condition1'} {'condition2'} [{'condition3'} ...]:: + Returns *true* if any of the listed conditions return *true*. + +*Xor* {'condition1'} {'condition2'} [{'condition3'} ...]:: + Returns the boolean *xor* of the truth values for all conditions + listed. + +CLIENT PATTERNS +--------------- +Many of the more advanced commands take a 'pattern' argument, which allows you +to direct the action at a specific window or set of windows which match the +properties specified in the 'pattern'. A 'pattern' looks like this: + +(['propertyname'[!]=]'regexp') ... + +That is, one or more match definitions, followed by an optional limit on the +number of windows to match. + +Match definitions are enclosed in parentheses *(*...*)*, and if no +'propertyname' is given then *Name* is assumed. The 'regexp' can contain any +regular expression, or the special value *[current]*, which matches the +corresponding value of the currently focused window. See 'regex(7)' for more +information on acceptable regular expressions. + +You can use *=* to test for equality or *!=* to test for inequality. + +The following values are accepted for 'propertyname'::: +*Name*;; + A string, corresponding to the CLASSNAME property. +*Class*;; + A string, corresponding to the CLASSCLASS property. +*Title*;; + A string, corresponding to the window title. +*Role*;; + A string, corresponding to the ROLE property. +*Transient*;; + Either *yes* or *no*, depending on whether the window is transient + (typically, a popup dialog) or not. +*Maximized*;; + Either *yes* or *no*, depending on whether the window is maximized or + not. +*Minimized*;; + Either *yes* or *no*, depending on whether the window is minimized + (iconified) or not. +*Shaded*;; + Either *yes* or *no*, depending on whether the window is shaded or + not. +*Stuck*;; + Either *yes* or *no*, depending on whether the window is sticky (on + all workspaces) or not. +*FocusHidden*;; + Either *yes* or *no*, depending on whether the window has asked to be + left off the focus list (or, the alt-tab list), or not. +*IconHidden*;; + Either *yes* or *no*, depending on whether the window has asked to be + left off the icon list (or, the taskbar), or not. +*Urgent*;; + Either *yes* or *no*, depending on whether the window has the urgent + hint set. +*Workspace*;; + A number corresponding to the workspace number to which the window is + attached. The first workspace here is *0*. +*WorkspaceName*;; + A string corresponding to the name of the workspace to which the + window is attached. +*Head*;; + The number of the display head to which the window is attached. You + may match this against the special value *[mouse]* which refers to the + head where the mouse pointer currently resides. +*Layer*;; + The string name of the window's layer, which is one of + *Above Dock*, *Dock*, *Top*, *Normal*, *Bottom*, *Desktop* + +.Matches any windows with the CLASSNAME of "xterm" +.......... +(xterm) +.......... + +.Matches any windows with the same CLASSNAME as the currently focused window +.......... +(Name=[current]) +.......... + +.Matches any windows on the same head as the mouse but on a different layer than the currently focused window +........... +(Head=[mouse]) (Layer!=[current]) +........... + +FILES +----- +~/.fluxbox/keys:: + This is the default location for the keybinding definitions. +/usr/X11R6/include/X11/keysymdef.h:: + X key names are in this file. +/usr/X11R6/lib/X11/XKeysymDB:: + X key names are also in this file. + +RESOURCES +--------- +session.keyFile: <location>:: + This may be set to override the location of the keybinding definitions. + +ENVIRONMENT +----------- +Remember that *ExecCommand* command can take advantage of other environment +variables if they are set before fluxbox is started, or via the *Export* or +*SetEnv* commands. For example, if *$TERM* is set, it could be use like this: + +........................... +Mod1 x :ExecCommand $TERM +........................... + +For more information about environment variables, see your shell's manual. + +EXAMPLES +-------- +Here are some interesting and/or useful examples you can do with your keys +file. + +.................. +# Mod4+drag moves a window +OnWindow Mod4 Mouse1 :StartMoving + +# If any xterm windows are open, cycle through them. If none are open, open +# one: +Mod4 t :If {Some Matches (xterm)} {NextWindow (xterm)} {Exec xterm} + +# Set a different wallpaper on every workspace: +ChangeWorkspace :Exec fbsetbg ~/.fluxbox/bg$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}').png +.................. + +AUTHOR and CREDITS +------------------ +This manpage is the combined work of: + +- Jim Ramsay <i.am at jimramsay com> (>fluxbox-1.0.0) +- Curt Micol <asenchi at asenchi com> (>fluxbox-0.9.11) +- Tobias Klausmann <klausman at users sourceforge net> (<=fluxbox-0.9.11) +- Grubert <grubert at users sourceforge net> (fluxbox) +- Matthew Hawkins <matt at mh dropbear id au> (blackbox) +- Wilbert Berendsen <wbsoft at xs4all nl> (blackbox) + +- Numerous other languages could be available if someone jumps in. + +SEE ALSO +-------- +fluxbox(1), xev(1), xkill(1), regex(7) +
M
doc/asciidoc/fluxbox.1
→
doc/asciidoc/fluxbox.1
@@ -1,11 +1,11 @@
.\" Title: fluxbox .\" Author: .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> -.\" Date: 06/03/2008 +.\" Date: 08/04/2008 .\" Manual: .\" Source: .\" -.TH "FLUXBOX" "1" "06/03/2008" "" "" +.TH "FLUXBOX" "1" "08/04/2008" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only)@@ -1091,457 +1091,8 @@ options are Close, Maximize, MenuIcon, Minimize, Shade, and Stick\.
.fi .RE .SH "KEYS" -You can customize fluxbox\'s key handling through the ~/\.fluxbox/keys file\. The file takes the format of: -.sp -.sp -.RS 4 -.nf -[keymode:] <modifier> <key> :<command> <operation> -.fi -.RE -In the example below, Mod1 is the \fIALT\fR key on the PC keyboard and Mod4 is one of the three extra keys on a pc104 branded with a familiar company logo\. Lines beginning with a \fI#\fR or \fI!\fR are considered comments and unread by fluxbox\. -.sp -You can get a list of possible modifiers by calling \fIxmodmap \-pm\fR\. This also shows you to which keys the modifiers are mapped\. Additionally there is the \fIOnDesktop\fR modifier\. To find valid keynames check the following files: -.sp -.sp -.RS 4 -.nf -/usr/X11R6/include/X11/keysymdef\.h -/usr/X11R6/lib/X11/XKeysymDB -.fi -.RE -Furthermore you can use Mouse1, Mouse2, etc to define actions for your mouse buttons\. -.sp -.sp -.RS 4 -.nf -# fluxbox keys file\. -Mod1 Tab :NextWindow -Mod1 Shift Tab :PrevWindow -Mod1 F1 :Workspace 1 -Mod1 F2 :Workspace 2 -Mod1 F3 :Workspace 3 -Mod1 F4 :Workspace 4 -Mod1 F5 :Workspace 5 -Mod1 F6 :Workspace 6 -Mod1 F7 :Workspace 7 -Mod1 F8 :Workspace 8 -Mod1 F9 :Workspace 9 -Mod4 b :PrevWorkspace -Mod4 c :Minimize -Mod4 r :ExecCommand rxvt -Mod4 v :NextWorkspace -Mod4 x :Close -Mod4 m :RootMenu -Control n Mod1 n :NextTab -.fi -.RE -As you can see from the last line, keybindings can be chained in a fashion similar to Emacs keybindings\. -.sp -Some things to know: \- Commands are case\-insensitive\. \- Workspace numbering starts at "1"\. \- Some commands have synonyms\. \- The space between the last key and the :Command is mandatory\. -.sp -Here are fluxbox key commands to use: -.sp -.SS "Window Manager Commands" -.sp -.RS 4 -\h'-04'\(bu\h'+03'Restart <argument> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Quit -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Reconfigure -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'SetStyle <argument> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'ExecCommand <argument> -.RE -.SS "Currently Focused Window Commands" -.sp -.RS 4 -\h'-04'\(bu\h'+03'Minimize -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'MinimizeWindow -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Iconify -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Maximize -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'MaximizeWindow -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'MaximizeHorizontal -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'MaximizeVertical -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'ResizeTo <width> <height> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Resize <delta\-width> <delta\-height> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'ResizeHorizontal <delta\-width> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'ResizeVertical <delta\-height> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'MoveTo <x> <y> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Move <delta\-x> <delta\-y> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'MoveRight <delta\-x> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'MoveLeft <delta\-x> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'MoveUp <delta\-y> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'MoveDown <delta\-y> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Raise -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Lower -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Close -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Shade -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'ShadeWindow -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Stick -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'StickWindow -.RE +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\. .sp -.RS 4 -\h'-04'\(bu\h'+03'ToggleDecor -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'TakeToWorkspace <number> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'TakeToNextWorkspace <offset> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'TakeToPrevWorkspace <offset> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'SendToWorkspace <number> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'SendToNextWorkspace <offset> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'SendToPrevWorkspace <offset> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'KillWindow -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'NextTab -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'PrevTab -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'MoveTabLeft -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'MoveTabRight -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'DetachClient -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'SetAlpha [[\-]<int> [[\-]<int>]] -.RE -.SS "Workspace Commands" -.sp -.RS 4 -\h'-04'\(bu\h'+03'NextWorkspace -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'PrevWorkspace -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'RightWorkspace <by\-number> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'LeftWorkspace <by\-number> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Workspace <number> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'NextWindow <bitmask> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'PrevWindow <bitmask> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'NextGroup <by\-number> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'PrevGroup <by\-number> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'FocusLeft -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'FocusRight -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'FocusUp -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'FocusDown -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'ArrangeWindows -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'ShowDesktop (Iconifies all windows) -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Deiconify all|allworkspace|last|lastworkspace current|origin|originquiet -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'RootMenu -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'WorkspaceMenu -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'WindowMenu -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'HideMenu -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'CustomMenu <path_to_file> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'SetWorkspaceName <name> -.RE -.SS "Special Commands" -.sp -.RS 4 -\h'-04'\(bu\h'+03'MacroCmd -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'ToggleCmd -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'ReloadStyle -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'SetResourceValue <resourcename> <resource> value -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'BindKey <key><value>: <action> -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'KeyMode <keymode name> <return key sequence> -.RE -.SS "Couple of things" -.sp -.RS 4 -\h'-04'\(bu\h'+03'Exec: fluxbox utilizes /bin/sh to start the commands\. This means, that you can use environment variables to do some tricks here\. E\.g: :Exec $XTERM This would fire up the term of your choice, if you set XTERM to something usefull -\fIbefore\fR -fluxbox starts, e\.g\. in the \.fluxbox/startup file\. -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'TakeToWorkspace: Will send you along with the window to the selected workspace\. SendToWorkspace just sends the window\. -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'TakeToNextWorkspace <offset>: Will send you and the window to workspace number <current offset>; that is, move you and the window <offset> spaces to the right (offset defaults to 1)\. SendToNextWorkspace does the same, except that it only sends the window (as for SendToWorkspace)\. TakeToPrevWorkspace and SendToPrevWorkspace work similarly, except moving to the previous workspaces, not the next ones\. -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'PrevWindow/NextWindow parameters take an integer: 0 or unspecified = Default/current behavior \- most recently used\. 1 = Groups instead of Windows \- only visit one tab in each group 2 = Skip stuck windows 4 = Skip shaded windows 8 = Switch between windows `linearly\'; that is, if you repeatedly press the NextWindow key, you will walk through all windows in the, order that they were opened, instead of switching back and forth between the most recently focused windows\. 16 = Skip iconified windows -.sp -.RS 4 -.nf -To combine any of these effects, add the corresponding numbers\. -For instance, 14 means switch linearly, skipping stuck and shaded -windows, since 14 = 8 + 4 + 2\. -.fi -.RE -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'Bindkey will append key string and action to your keys file and bind the key\. -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'KeyMode allows you to have different keybindings that aren\'t all active at the same time\. For instance, you can use `KeyMode Xnest\' to switch to the `Xnest\' key mode, which will disable all of your key bindings that don\'t have `Xnest: -\fI before them and will enable all the ones that do\. <return key sequence> will then return you to the `default\fR -key mode\. If not provided, this defaults to the escape key\. -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'The -\fIdelta\fR -value means the difference between the current setting and the requested setting\. So if you have a window that is 100 pixels wide, you could set -.RE -.sp -.RS 4 -.nf -Mod1 r :ResizeHorizontal 10 -.fi -.RE -and when you use that key it would increase the size of your window to 110 pixels\. If you had used -.sp -.sp -.RS 4 -.nf -Mod1 R :ResizeHorizontal \-10 -.fi -.RE -then it would have decreased the size by 10, setting it to 90 pixels\. -.sp -.sp -.RS 4 -\h'-04'\(bu\h'+03'Resize commands do not necessarily change the number of pixels\. For instance, many terminals will use the size of a character as the resize unit\. Most applications, however, use pixels\. -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'MacroCmd: -.RE -.sp -.RS 4 -.nf -Mod1 r :MacroCmd {command1} {command2} -.fi -.RE -.sp -.RS 4 -.nf -allows you to execute more than one command with one keybinding\. The commands -will be executed in serial\. -.fi -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'ToggleCmd: -.RE -.sp -.RS 4 -.nf -Mod1 t :ToggleCmd {command1} {command2} -.fi -.RE -.sp -.RS 4 -.nf -alternates between the given commands each time you press Mod1 + t\. -.fi -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'SetAlpha [[\-]<int> [[\-]<int>]]: Works on the currently focussed window\. Given -.sp -.RS 4 -\h'-04'\(bu\h'+03'no arguments: reset to default alpha settings -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'one argument: changes both focused and unfocused alpha settings -.RE -.sp -.RS 4 -\h'-04'\(bu\h'+03'two arguments: first value becomes the focused alpha, second becomes the unfocused alpha value\. E\.g: SetAlpha 127 +5 will set the focused alpha to 127 and increment the unfocused alpha by 5 (until it reaches 255) -.RE -.RE .SH "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: .sp@@ -2044,7 +1595,7 @@ \h'-04'\(bu\h'+03'Curt Micol <asenchi at asenchi com> (>fluxbox\-0\.9\.11)
.RE .sp .RS 4 -\h'-04'\(bu\h'+03'Tobias Klausmann <klausman at users sourceforge net> (<=fluxbox\-0\.9\.11) +\h'-04'\(bu\h'+03'Tobias Klausmann <klausman at users sourceforge net> (⇐fluxbox\-0\.9\.11) .RE .sp .RS 4@@ -2066,5 +1617,5 @@ .SH "BUGS"
If you find any bugs, please visit the #fluxbox irc channel on irc\.freenode\.net or submit them to the bug tracker at http://sf\.net/projects/fluxbox \. Or you may subscribe to one of the mailinglists\. More information can be found on the official website\. .sp .SH "SEE ALSO" -bsetroot(1) fbsetbg(1) fbrun(1) fluxstyle(1) +fluxbox\-keys(5) bsetroot(1) fbsetbg(1) fbrun(1) fluxstyle(1) .sp
M
doc/asciidoc/fluxbox.txt
→
doc/asciidoc/fluxbox.txt
@@ -1015,234 +1015,8 @@
KEYS ---- -You can customize fluxbox's key handling through the ~/.fluxbox/keys file. The -file takes the format of: - - [keymode:] <modifier> <key> :<command> <operation> - -In the example below, Mod1 is the 'ALT' key on the PC keyboard and Mod4 is one -of the three extra keys on a pc104 branded with a familiar company logo. Lines -beginning with a '#' or '!' are considered comments and unread by fluxbox. - -You can get a list of possible modifiers by calling 'xmodmap -pm'. This also -shows you to which keys the modifiers are mapped. Additionally there is the -'OnDesktop' modifier. To find valid keynames check the following files: - - /usr/X11R6/include/X11/keysymdef.h - /usr/X11R6/lib/X11/XKeysymDB - - -Furthermore you can use Mouse1, Mouse2, etc to define actions for your mouse -buttons. - -............................ -# fluxbox keys file. -Mod1 Tab :NextWindow -Mod1 Shift Tab :PrevWindow -Mod1 F1 :Workspace 1 -Mod1 F2 :Workspace 2 -Mod1 F3 :Workspace 3 -Mod1 F4 :Workspace 4 -Mod1 F5 :Workspace 5 -Mod1 F6 :Workspace 6 -Mod1 F7 :Workspace 7 -Mod1 F8 :Workspace 8 -Mod1 F9 :Workspace 9 -Mod4 b :PrevWorkspace -Mod4 c :Minimize -Mod4 r :ExecCommand rxvt -Mod4 v :NextWorkspace -Mod4 x :Close -Mod4 m :RootMenu -Control n Mod1 n :NextTab -............................ - -As you can see from the last line, keybindings can be chained in a fashion -similar to Emacs keybindings. - -Some things to know: -- Commands are case-insensitive. -- Workspace numbering starts at "1". -- Some commands have synonyms. -- The space between the last key and the :Command is mandatory. - -Here are fluxbox key commands to use: - -Window Manager Commands -~~~~~~~~~~~~~~~~~~~~~~~ -- Restart <argument> -- Quit -- Reconfigure -- SetStyle <argument> -- ExecCommand <argument> - -Currently Focused Window Commands -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- Minimize -- MinimizeWindow -- Iconify -- Maximize -- MaximizeWindow -- MaximizeHorizontal -- MaximizeVertical -- ResizeTo <width> <height> -- Resize <delta-width> <delta-height> -- ResizeHorizontal <delta-width> -- ResizeVertical <delta-height> -- MoveTo <x> <y> -- Move <delta-x> <delta-y> -- MoveRight <delta-x> -- MoveLeft <delta-x> -- MoveUp <delta-y> -- MoveDown <delta-y> -- Raise -- Lower -- Close -- Shade -- ShadeWindow -- Stick -- StickWindow -- ToggleDecor -- TakeToWorkspace <number> -- TakeToNextWorkspace <offset> -- TakeToPrevWorkspace <offset> -- SendToWorkspace <number> -- SendToNextWorkspace <offset> -- SendToPrevWorkspace <offset> -- KillWindow -- NextTab -- PrevTab -- MoveTabLeft -- MoveTabRight -- DetachClient -- SetAlpha [[+-]<int> [[+-]<int>]] - -Workspace Commands -~~~~~~~~~~~~~~~~~~ -- NextWorkspace -- PrevWorkspace -- RightWorkspace <by-number> -- LeftWorkspace <by-number> -- Workspace <number> -- NextWindow <bitmask> -- PrevWindow <bitmask> -- NextGroup <by-number> -- PrevGroup <by-number> -- FocusLeft -- FocusRight -- FocusUp -- FocusDown -- ArrangeWindows -- ShowDesktop (Iconifies all windows) -- Deiconify all|allworkspace|last|lastworkspace current|origin|originquiet -- RootMenu -- WorkspaceMenu -- WindowMenu -- HideMenu -- CustomMenu <path_to_file> -- SetWorkspaceName <name> - -Special Commands -~~~~~~~~~~~~~~~~ -- MacroCmd -- ToggleCmd -- ReloadStyle -- SetResourceValue <resourcename> <resource> value -- BindKey <key><value>: <action> -- KeyMode <keymode name> <return key sequence> - -Couple of things -~~~~~~~~~~~~~~~~ -- Exec: - fluxbox utilizes /bin/sh to start the commands. This means, that - you can use environment variables to do some tricks here. E.g: - :Exec $XTERM - This would fire up the term of your choice, if you set XTERM to - something usefull _before_ fluxbox starts, e.g. in the .fluxbox/startup - file. - -- TakeToWorkspace: - Will send you along with the window to the selected workspace. - SendToWorkspace just sends the window. - -- TakeToNextWorkspace <offset>: - Will send you and the window to workspace number <current + - offset>; that is, move you and the window <offset> spaces to the - right (offset defaults to 1). SendToNextWorkspace does the same, - except that it only sends the window (as for SendToWorkspace). - TakeToPrevWorkspace and SendToPrevWorkspace work similarly, except - moving to the previous workspaces, not the next ones. - -- PrevWindow/NextWindow parameters take an integer: - 0 or unspecified = Default/current behavior - most recently used. - 1 = Groups instead of Windows - only visit one tab in each group - 2 = Skip stuck windows - 4 = Skip shaded windows - 8 = Switch between windows `linearly'; that is, if you repeatedly - press the NextWindow key, you will walk through all windows in the, - order that they were opened, instead of switching back and forth - between the most recently focused windows. - 16 = Skip iconified windows - - To combine any of these effects, add the corresponding numbers. - For instance, 14 means switch linearly, skipping stuck and shaded - windows, since 14 = 8 + 4 + 2. - -- Bindkey will append key string and action to your keys file and bind the key. - -- KeyMode allows you to have different keybindings that aren't all active at the - same time. For instance, you can use `KeyMode Xnest' to switch to the `Xnest' - key mode, which will disable all of your key bindings that don't have - `Xnest: ' before them and will enable all the ones that do. - <return key sequence> will then return you to the `default' key mode. If not - provided, this defaults to the escape key. - -- The 'delta' value means the difference between the current setting and the -requested setting. So if you have a window that is 100 pixels wide, you could -set - -.......................... -Mod1 r :ResizeHorizontal 10 -............................ - -and when you use that key it would increase the size of your window -to 110 pixels. If you had used - -............................. -Mod1 R :ResizeHorizontal -10 -............................. - -then it would have decreased the size by 10, setting it to 90 pixels. - -- Resize commands do not necessarily change the number of pixels. For - instance, many terminals will use the size of a character as the resize - unit. Most applications, however, use pixels. - -- MacroCmd: - -...................................... -Mod1 r :MacroCmd {command1} {command2} -...................................... - - allows you to execute more than one command with one keybinding. The commands - will be executed in serial. - -- ToggleCmd: - -....................................... -Mod1 t :ToggleCmd {command1} {command2} -....................................... - - alternates between the given commands each time you press Mod1 + t. - -- SetAlpha [[+-]<int> [[+-]<int>]]: - Works on the currently focussed window. Given - * no arguments: reset to default alpha settings - * one argument: changes both focused and unfocused alpha settings - * two arguments: first value becomes the focused alpha, second becomes - the unfocused alpha value. - E.g: SetAlpha 127 +5 will set the focused alpha to 127 and increment the - unfocused alpha by 5 (until it reaches 255) +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 ------@@ -1736,5 +1510,5 @@ mailinglists. More information can be found on the official website.
SEE ALSO -------- -bsetroot(1) fbsetbg(1) fbrun(1) fluxstyle(1) +fluxbox-keys(5) bsetroot(1) fbsetbg(1) fbrun(1) fluxstyle(1)
A
doc/fluxbox-keys.5
@@ -0,0 +1,981 @@
+.\" Title: fluxbox-keys +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> +.\" Date: 08/04/2008 +.\" Manual: +.\" Source: +.\" +.TH "FLUXBOX\-KEYS" "5" "08/04/2008" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +fluxbox-keys - keyboard shortcuts configuration for fluxbox(1) +.SH "SYNOPSIS" +~/\.fluxbox/keys +.sp +.SH "SYNTAX" +Variable parameters are shown in emphasis: \fIargument\fR +.sp +Optional parameters are shown in square brackets: [\fIargument\fR] +.sp +All other characters shown are required verbatim\. Whitespace is required where shown, but it is fine to add more whitespace\. +.sp +.SH "DESCRIPTION" +The keys file defines the keyboard shortcuts for \fIfluxbox(1)\fR\. +.sp +You can customize fluxbox\'s key handling through the ~/\.fluxbox/keys file\. The file consists of lines of the basic format: +.sp +\fB[\fR\fB\fImodifiers\fR\fR\fB] \fR\fB\fIkey\fR\fR\fB :\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIarguments\fR\fR\fB \fR\fB\fI\&...\fR\fR\fB]\fR +.sp +The space between the \fIkey\fR and the \fB:\fR before the \fIcommand\fR is mandatory\. +.sp +All modifiers and commands are case\-insensitive\. Some command arguments (especially those that will be passed to the shell) are case\-sensitive\. Some key names are case\-sensitive\. +.sp +Lines beginning with a \fI#\fR or \fI!\fR are considered comments and are unread by fluxbox\. +.sp +.SH "MODIFIERS" +You can get a list of possible modifiers by calling `xmodmap \-pm\'\. This also shows you to which keys the modifiers are mapped, but the following modifiers are most commonly used: +.sp +\fBShift Control Mod1 Mod4\fR +.sp +where \fBMod1\fR is the Alt key on the PC keyboard and \fBMod4\fR is usually a key branded with a familiar company logo\. +.PP +There are also some special modifiers that refer to mouse button presses: +.RS 4 +.PP +\fBOnDesktop\fR +.RS 4 +The mouse cursor is over the desktop (root window), and not any window\. +.RE +.PP +\fBOnToolbar\fR +.RS 4 +The mouse cursor is over the toolbar (which is normally at the bottom of the screen)\. +.RE +.PP +\fBOnWindow\fR +.RS 4 +The mouse cursor is over a window\. +.RE +.PP +\fBOnTitlebar\fR +.RS 4 +The mouse cursor is over a window\'s titlebar\. +.RE +.PP +\fBDouble\fR +.RS 4 +Limits this action to double\-clicks only\. +.RE +.RE +.SS "Combining Modifiers" +To combine two or more modifiers, just list them (space\-delimited) in any order\. +.sp +.SH "KEYS" +You may specify a key by its key name (for example, \fBa\fR or \fBspace\fR) or by its numeric keycode (for example, \fB38\fR or \fB0xf3\fR)\. +.sp +If you don\'t know the name of a key, you can run \fIxev(1)\fR in a terminal, push the key, and see the name in the output\. If you have some "special" keys that do not produce a key name in the output of \fIxev(1)\fR, you can just use the keycode (NOT the keysym!) in your keys file\. +.sp +Commands can also be bound to mouse button presses, for which the proper "key" name is \fBMouse\fR\fIn\fR where \fIn\fR is the number of the mouse button\. For example, \fBMouse1\fR is the primary button, and \fBMouse4\fR / \fBMouse5\fR are the scroll wheel events, in normal configurations\. \fIxev(1)\fR can also be used to tell the button number\. +.sp +.SH "CHAINING" +Key bindings can be chained in a fashion similar to Emacs key bindings using the syntax: +.sp +\fB\fImodifiers\-1\fR\fR\fB \fR\fB\fIkey\-1\fR\fR\fB \fR\fB\fImodifiers\-2\fR\fR\fB \fR\fB\fIkey\-2\fR\fR\fB :\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIarguments \&...\fR\fR\fB]\fR +.PP +\fBExample\ 1.\ To Bind CTRL+C CTRL+X (Which means, press CTRL+C then CTRL+X) to quit fluxbox\fR +.sp +.RS 4 +.nf +Control c Control x :Quit +.fi +.RE +.SH "KEYMODES" +A specific set of key mappings can be activated and de\-activated on\-the\-fly using what are called keymodes\. The syntax to define a mapping in a keymode is: +.sp +\fB\fIkeymode\fR\fR\fB: \fR\fB\fImodifiers\fR\fR\fB \fR\fB\fIkey\fR\fR\fB :\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIarguments\fR\fR\fB \fR\fB\fI\&...\fR\fR\fB]\fR +.sp +Where \fIkeymode\fR is any alpha\-numeric string name\. +.sp +When this keymode is activated (see the \fBKeyMode\fR command below), all bindings prefaced by that keymode name become active (and all other keybindings will be deactivated) until the keymode changes again\. +.sp +.SH "COMMANDS" +.PP +Some commands have multiple names which are shown below as: +.RS 4 +CMD1 | CMD2 +.RE +.PP +Related commands have been grouped below as: +.RS 4 +CMD1 / CMD2 +.RE +.PP +The commands are broken up into sections as follows: +.RS 4 +.sp +.RS 4 +\h'-04'\(bu\h'+03'Mouse Commands +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Window Commands +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Workspace Commands +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Menu Commands +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Window Manager Commands +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Special Commands +.RE +.RE +.SS "Mouse Commands" +These commands may only be bound to mouse buttons (plus modifiers), not keystrokes\. In all cases, the action finishes when the mouse button is released\. +.PP +\fBStartMoving\fR +.RS 4 +Start dragging to move the window\. +.RE +.PP +\fBStartResizing\fR [\fIcorner\fR] +.RS 4 +Start dragging to resize the window as if you had grabbed the window at the specified +\fIcorner\fR\. +.PP +By default \fIcorner\fR is \fBBottomRight\fR, but may be overridden with one of: +.RS 4 + +\fBNearestCorner NearestEdge Center TopLeft Top TopRight Left Right BottomLeft BottomRight\fR +.RE +.RE +.PP +\fBStartTabbing\fR +.RS 4 +Start dragging to add this window to another\'s tabgroup\. +.RE +.SS "Window Commands" +These commands affect only the currently focused window\. +.PP +\fBActivate\fR | \fBFocus\fR +.RS 4 +Set the focus to the window matching the argument, and raise it\. +.RE +.PP +\fBMinimize\fR | \fBMinimizeWindow\fR | \fBIconify\fR +.RS 4 +Minimize the current window, equivalent to the window button\. +.RE +.PP +\fBMaximize\fR | \fBMaximizeWindow\fR +.RS 4 +Maximize the current window, equivalent to the window button\. +.RE +.PP +\fBMaximizeHorizontal\fR / \fBMaximizeVertical\fR +.RS 4 +Maximize the current window in one direction only, leaving the other dimension unchanged\. +.RE +.PP +\fBRaise\fR / \fBLower\fR +.RS 4 +Reorder this window to the top or bottom of the window stack, within its current layer\. See +\fIfluxbox(1)\fR +for a discussion of layers\. +.RE +.PP +\fBRaiseLayer\fR / \fBLowerLayer\fR +.RS 4 +Raise the window up to the layer above, or lower it to the layer below\. See +\fIfluxbox(1)\fR +for a discussion of layers\. +.RE +.PP +\fBClose\fR +.RS 4 +Close the current window, equivalent to the window button\. +.RE +.PP +\fBKill\fR | \fBKillWindow\fR +.RS 4 +Close a window that\'s not responding to +\fBClose\fR, like using +xkill\. +.RE +.PP +\fBShade\fR | \fBShadeWindow\fR +.RS 4 +Toggle the +\fBshaded\fR +state of the current window, equivalent to the window button\. A +\fBshaded\fR +window appears as only the title bar\. +.RE +.PP +\fBShadeOn\fR / \fBShadeOff\fR +.RS 4 +Set the +\fBshaded\fR +state of the window to On / Off\. +.RE +.PP +\fBStick\fR | \fBStickWindow\fR +.RS 4 +Toggle the +\fBsticky\fR +state of the current window, equivalent to the window button\. A +\fBsticky\fR +window is visible on all workspaces\. +.RE +.PP +\fBToggleDecor\fR +.RS 4 +Toggles the presence of the window decorations (title bar, window buttons, and resize bar)\. +.RE +.PP +\fBNextTab\fR / \fBPrevTab\fR +.RS 4 +Cycle to the next / previous tab in the current tab group\. +.RE +.PP +\fBTab\fR \fInumber\fR +.RS 4 +Cycle to the given tab in the current tab group, where +\fB1\fR +is the first tab\. A negative +\fInumber\fR +counts from the end of the tab group (\fB\-1\fR +is the last tab, +\fB\-2\fR +is the next\-to\-last, etc\.)\. +.RE +.PP +\fBMoveTabRight\fR / \fBMoveTabLeft\fR +.RS 4 +Reorder the tabs in the current tab group, swapping the current tab with the one to the right / left\. +.RE +.PP +\fBDetachClient\fR +.RS 4 +Remove the current tab from the tab group, placing it in its own window\. +.RE +.PP +\fBResizeTo\fR \fIwidth\fR \fIheight\fR +.RS 4 +Resizes the window to the given width and height\. +.RE +.PP +\fBResize\fR \fIdelta\-width\fR \fIdelta\-height\fR +.RS 4 +Resizes the window relative to the current width and height\. +.RE +.PP +\fBResizeHorizontal\fR \fIdelta\-width\fR / \fBResizeVertical\fR \fIdelta\-height\fR +.RS 4 +Resizes the window in one dimension only +.RE +.PP +\fBMoveTo\fR \fIx\fR \fIy\fR [\fIanchor\fR] +.RS 4 +Moves the window to the given coordinates, given in pixels\. +.sp +If either +\fIx\fR +or +\fIy\fR +is set to +\fB*\fR, that coordinate will be ignored, and the movement will only take place in one dimension\. +.PP +The default \fIanchor\fR is the upper left corner, but this may be overridden with one of: +.RS 4 + +\fBUpperLeft LowerLeft UpperRight LowerRight\fR +.RE +.RE +.PP +\fBMove\fR \fIdelta\-x\fR \fIdelta\-y\fR +.RS 4 +Moves the window relative to its current position\. Positive numbers refer to right and down, and negative to left and up, respectively\. +.RE +.PP +\fBMoveRight\fR \fId\fR / \fBMoveLeft\fR \fId\fR / \fBMoveUp\fR \fId\fR / \fBMoveDown\fR \fId\fR +.RS 4 +Moves the window relative to its current position by the number of pixels specified in +\fId\fR\. If the number is negative, it moves in the opposite direction\. +.RE +.PP +\fBTakeToWorkspace\fR \fIworkspace\fR / \fBSendToWorkspace\fR \fIworkspace\fR +.RS 4 +Sends you along with the current window to the selected workspace\. SendToWorkspace just sends the window\. The first workspace is number +\fB1\fR, not 0\. +.RE +.PP +\fBTakeToNextWorkspace\fR [\fIoffset\fR] / \fBTakeToPrevWorkspace\fR [\fIoffset\fR] +.RS 4 +Sends you along with the current window to the next or previous workspace\. If you set +\fIoffset\fR +to a value greater than the default of +\fB1\fR, it will move you that number of workspaces ahead or behind\. If you go beyond the end of the currently defined workspaces, it will wrap around to the other end automatically\. +.RE +.PP +\fBSendToNextWorkspace\fR [\fIoffset\fR] / \fBSendToPrevWorkspace\fR [\fIoffset\fR] +.RS 4 +Identical to the "TakeTo\&..." commands, but again this sends only the window, and does not move you away from your current workspace\. +.RE +.PP +\fBSetAlpha\fR [\fIalpha\fR [\fIunfocused\-alpha\fR]] +.RS 4 +Sets the alpha value of a window\. +.sp +Putting a +\fB+\fR +or +\fB\-\fR +in front of the value adds or subtracts from the current value\. A plain integer sets the value explicitly\. +.PP +no arguments +.RS 4 +Resets both focused and unfocused settings to default opacity\. +.RE +.PP +one argument +.RS 4 +Changes both focused and unfocused alpha settings\. +.RE +.PP +two arguments +.RS 4 +First value becomes the focused alpha, second becomes the unfocused alpha value\. +.RE +.RE +.PP +\fBSetHead\fR \fInumber\fR +.RS 4 +Moves the window to the given display head\. Only available when fluxbox has been compiled with Xinerama support\. +.RE +.SS "Workspace Commands" +These commands affect the entire workspace (or "desktop" as it is sometimes called)\. +.PP +\fBAddWorkspace\fR / \fBRemoveLastWorkspace\fR +.RS 4 +Adds or removes a workspace from the end of the list of workspaces\. +.RE +.PP +\fBNextWorkspace\fR [\fIn\fR] / \fBPrevWorkspace\fR [\fIn\fR] / \fBRightWorkspace\fR [\fIn\fR] / \fBLeftWorkspace\fR [\fIn\fR] +.RS 4 +Switch to the Next / Previous workspace\. All versions accept an offset value +\fIn\fR, which defaults to +\fB1\fR +and refers to the number of workspaces to move at one time\. {Next,Prev}Workspace wrap around when going past the last workspace, whereas {Right,Left}Workspace do not\. +.RE +.PP +\fBWorkspace\fR \fInumber\fR +.RS 4 +Jumps to the given workspace +\fInumber\fR\. The first workspace is +\fB1\fR\. +.RE +.PP +\fBNextWindow\fR [{\fIoptions\fR}] [\fIpattern\fR] / \fBPrevWindow\fR [{\fIoptions\fR}] [\fIpattern\fR] +.RS 4 +Focuses and activates the next / previous window in the focus list\. +.PP +\fIoptions\fR is one or more of the following, space delimited: +.RS 4 +.PP +\fBstatic\fR +.RS 4 +Instead of moving in order of most\-recent focus, move in order of when the window was opened (or, the order shown in the iconbar)\. +.RE +.PP +\fBgroups\fR +.RS 4 +Only include the current tab in windows with multiple tabs\. +.RE +.sp +If +\fIpattern\fR +arguments are supplied, only windows that match all the patterns are considered \- all others are skipped\. See the section +\fBCLIENT PATTERNS\fR +below for more information\. +.sp +This pair of commands has a special side\-effect when the keybinding used has a modifier \- It will temporarily raise the cycled window to the front so you can see it, but if you continue holding down the modifier and press the key again (For example, keep holding "Alt" while you tap the "Tab" key a few times), fluxbox will lower the window again when you move on to the next one\. This allows you to preview the windows in order, but does not change the order in doing so\. +.RE +.RE +.PP +\fBNextGroup\fR [{\fIoptions\fR}] [\fIpattern\fR] / \fBPrevGroup\fR [{\fIoptions\fR}] [\fIpattern\fR] +.RS 4 +Equivalent to NextWindow / PrevWindow above, but with the +\fBgroups\fR +option forced on\. +.RE +.PP +\fBGotoWindow\fR \fInumber\fR [{\fIoptions\fR}] [\fIpattern\fR] +.RS 4 +Focuses and activates the window at position +\fInumber\fR +in the focus list\. The +\fIoptions\fR +and +\fIpattern\fR +arguments have the same meaning as +\fBNextWindow\fR +above\. +.RE +.PP +\fBAttach\fR \fIpattern\fR +.RS 4 +Combines all windows that match the +\fIpattern\fR +into a single tab group\. See +\fBCLIENT PATTERNS\fR +for more about the +\fIpattern\fR +arguments\. +.RE +.PP +\fBFocusLeft\fR / \fBFocusRight\fR / \fBFocusUp\fR / \fBFocusDown\fR +.RS 4 +Focus to the next window which is located in the direction specified\. +.RE +.PP +\fBArrangeWindows\fR \fIpattern\fR +.RS 4 +Tries to arrange all windows on the current workspace so that they overlap the least amount possible\. See +\fBCLIENT PATTERNS\fR +for more about the +\fIpattern\fR +arguments\. +.RE +.PP +\fBShowDesktop\fR +.RS 4 +Iconifies all windows\. +.RE +.PP +\fBDeiconify\fR \fImode\fR \fIdestination\fR +.RS 4 +Deiconifies windows (or, restores from a minimized state)\. +.PP +Where \fImode\fR may be one of: +.RS 4 +.PP +\fBAll\fR +.RS 4 +All icons across all workspaces\. +.RE +.PP +\fBAllWorkspace\fR +.RS 4 +All icons on the current workspace\. +.RE +.PP +\fBLast\fR +.RS 4 +The last icon across all workspaces\. +.RE +.PP +\fBLastWorkspace\fR (default) +.RS 4 +The last icon on the current workspace\. +.RE +.RE +.PP +And \fIdestination\fR may be one of: +.RS 4 +.PP +\fBCurrent\fR (default) +.RS 4 +Deiconify to the current workspace\. +.RE +.PP +\fBOriginQuiet\fR +.RS 4 +Deiconify to the window\'s original workspace, but does so in the background, without moving you there\. +.RE +.RE +.RE +.PP +\fBSetWorkspaceName\fR \fIname\fR / \fBSetWorkspaceNameDialog\fR +.RS 4 +Sets the name of the current workspace\. +.RE +.PP +\fBCloseAllWindows\fR +.RS 4 +Closes all windows on all desktops\. +.RE +.SS "Menu Commands" +These commands open or close fluxbox popup menus\. For more information on what these menus contain or how to configure them, see \fIfluxbox(1)\fR\. +.PP +\fBRootMenu\fR / \fBWorkspaceMenu\fR / \fBWindowMenu\fR +.RS 4 +Opens the specified menu\. See fluxbox(1) for more details on what these menus contain\. +.RE +.PP +\fBClientMenu\fR [\fIpattern\fR] +.RS 4 +Opens a menu that contains all windows\. If you specify a +\fIpattern\fR, only matching windows will be in the menu\. See +\fBCLIENT PATTERNS\fR +below for more details on the +\fIpattern\fR +argument\. +.RE +.PP +\fBCustomMenu\fR \fIpath\fR +.RS 4 +Opens a custom menu file\. +.RE +.PP +\fBHideMenus\fR +.RS 4 +Hide all fluxbox popup menus\. +.RE +.SS "Window Manager Commands" +These commands affect the Window Manager, or more than one window\. +.PP +\fBRestart\fR [\fIpath\fR] +.RS 4 +Restarts fluxbox\. This does not close any running applications\. If the optional +\fIpath\fR +is a path to an executable window manager, that manager is started in place of fluxbox\. +.RE +.PP +\fBQuit\fR | \fBExit\fR +.RS 4 +Exits fluxbox\. This will normally cause X to stop as well and terminate all existing applications, returning you to the login manager or console\. +.RE +.PP +\fBReconfig\fR | \fBReconfigure\fR +.RS 4 +Reloads all fluxbox configuration files including the keys file, apps file, and init file, if they have changed\. +.RE +.PP +\fBSetStyle\fR \fIpath\fR +.RS 4 +Sets the current style to that given in +\fIpath\fR, which must be the full path to a fluxbox style\. +.RE +.PP +\fBReloadStyle\fR +.RS 4 +Reloads only the current style\. Useful after editing a style which is currently in use\. +.RE +.PP +\fBExecCommand\fR \fIargs \&...\fR | \fBExec\fR \fIargs \&...\fR | \fBExecute\fR \fIargs \&...\fR +.RS 4 +Probably the most\-used binding of all\. Passes all the arguments to your +\fB$SHELL\fR +(or /bin/sh if $SHELL is not set)\. You can use this to launch applications, run shell scripts, etc\. Since all arguments are passed verbatim to the shell, you can use environment variables, pipes, or anything else the shell can do\. Note that processes only see environment variables that were set before fluxbox started (such as in ~/\.fluxbox/startup), or any that are set via the Export or SetEnv commands, below\. +.RE +.PP +\fBCommandDialog\fR +.RS 4 +Pops up a dialog box that lets you type in any of these commands manually\. +.RE +.PP +\fBSetEnv\fR \fIname\fR \fIvalue\fR | \fBExport\fR \fIname\fR=\fIvalue\fR +.RS 4 +Sets an environment variable in Fluxbox\. It will be passed to any applications spawned by any future ExecCommand commands\. +.RE +.PP +\fBSetResourceValue\fR \fIresourcename\fR \fIresourcevalue\fR | \fBSetResourceValueDialog\fR +.RS 4 +Sets a fluxbox resource value, which are normally stored in the init file\. See +\fIfluxbox(1)\fR +for more details on available resources and allowed values\. +.RE +.SS "Special Commands" +These commands have special meanings or behaviors\. +.PP +\fBMacroCmd\fR {\fIcommand1\fR} {\fIcommand2\fR} {\fIcommand3\fR} \fI\&...\fR +.RS 4 +Allows you to execute more than one command with one keybinding\. The commands will be executed in series\. The +\fB{\fR +\fB}\fR +brackets are literally required, as in the following example: +.sp +.RS 4 +.nf +MacroCmd {MoveTo 0 0} {ResizeTo 1280 800} +.fi +.RE +.RE +.PP +\fBDelay\fR {\fIcommand\fR} [\fImicroseconds\fR] +.RS 4 +Delays running +\fIcommand\fR +for the given amount of time\. If the same key binding is activated again, the timer will be restarted\. +.RE +.PP +\fBToggleCmd\fR {\fIcommand1\fR} {\fIcommand2\fR} \fI\&...\fR +.RS 4 +Alternates between the commands\. On the first press of the bound key, runs +\fIcommand1\fR\. On the next press, runs +\fIcommand2\fR\. +.RE +.PP +\fBBindKey\fR \fIkeybinding\fR +.RS 4 +Adds the given +\fIkeybinding\fR +(which must be a valid key binding as defined in the DESCRIPTION section above) to your keys file\. +.RE +.PP +\fBKeyMode\fR \fIkeymode\fR [\fIreturn\-keybinding\fR] +.RS 4 +Activates the named +\fIkeymode\fR +(or, all key binding lines prefaced with the same +\fIkeymode\fR:) and deactivates all others until the +\fIreturn\-keybinding\fR +(by default +\fBEscape\fR) is pressed\. The default keymode is named +\fIdefault\fR\. +.RE +.PP +\fBForEach\fR {\fIcommand\fR} [{\fIcondition\fR}] | \fBMap\fR {\fIcommand\fR} [{\fIcondition\fR}] +.RS 4 +Runs the given +\fIcommand\fR +(normally one from the +\fBWindow Commands\fR +section above) on each window\. If you specify a +\fIcondition\fR +(See +\fBConditions\fR, below) the action will be limited to matching windows\. +.RE +.PP +\fBIf\fR {\fIcondition\fR} {\fIthen\-command\fR} [{\fIelse\-command\fR}] | \fBCond\fR {\fIcondition\fR} {\fIthen\-command\fR} [{\fIelse\-command\fR}] +.RS 4 +If the +\fIcondition\fR +command returns +\fBtrue\fR, then run the +\fIthen\-command\fR, otherwise run the optional +\fIelse\-command\fR\. See +\fBConditions\fR +below for more information on the +\fIcondition\fR +argument\. +.RE +.SS "Conditions" +These special commands are used to match windows conditionally\. They are commonly used by the \fBIf\fR and \fBForEach\fR command\. +.PP +\fBMatches\fR \fIpattern\fR +.RS 4 +Returns +\fBtrue\fR +if the current window matches the given +\fIpattern\fR\. See +\fBCLIENT PATTERNS\fR +below for details on the +\fIpattern\fR +syntax\. +.sp +If your key binding uses the +\fBOnWindow\fR +modifier, it matches against the window you clicked, not the currently focused window\. +.sp +To check other windows besides the currently focused one, see the +\fBEvery\fR +and +\fBSome\fR +conditions below\. +.RE +.PP +\fBSome\fR \fIcondition\fR +.RS 4 +Retuns +\fBtrue\fR +if any window on any workspace (not just the currently focused one) matches the +\fIcondition\fR\. +.RE +.PP +\fBEvery\fR \fIcondition\fR +.RS 4 +Retuns +\fBtrue\fR +if every window on every workspace (not just the current one) matches the +\fIcondition\fR\. +.RE +.PP +\fBNot\fR \fIcondition\fR +.RS 4 +Returns +\fBtrue\fR +if +\fIcondition\fR +returns +\fBfalse\fR, and vice\-versa\. +.RE +.PP +\fBAnd\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...] +.RS 4 +Returns +\fBtrue\fR +if and only if all given conditions return +\fBtrue\fR\. +.RE +.PP +\fBOr\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...] +.RS 4 +Returns +\fBtrue\fR +if any of the listed conditions return +\fBtrue\fR\. +.RE +.PP +\fBXor\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...] +.RS 4 +Returns the boolean +\fBxor\fR +of the truth values for all conditions listed\. +.RE +.SH "CLIENT PATTERNS" +Many of the more advanced commands take a \fIpattern\fR argument, which allows you to direct the action at a specific window or set of windows which match the properties specified in the \fIpattern\fR\. A \fIpattern\fR looks like this: +.sp +([\fIpropertyname\fR[!]=]\fIregexp\fR) \&... +.sp +That is, one or more match definitions, followed by an optional limit on the number of windows to match\. +.sp +Match definitions are enclosed in parentheses \fB(\fR\&...\fB)\fR, and if no \fIpropertyname\fR is given then \fBName\fR is assumed\. The \fIregexp\fR can contain any regular expression, or the special value \fB[current]\fR, which matches the corresponding value of the currently focused window\. See \fIregex(7)\fR for more information on acceptable regular expressions\. +.sp +You can use \fB=\fR to test for equality or \fB!=\fR to test for inequality\. +.PP +The following values are accepted for \fIpropertyname\fR: +.RS 4 +.PP +\fBName\fR +.RS 4 +A string, corresponding to the CLASSNAME property\. +.RE +.PP +\fBClass\fR +.RS 4 +A string, corresponding to the CLASSCLASS property\. +.RE +.PP +\fBTitle\fR +.RS 4 +A string, corresponding to the window title\. +.RE +.PP +\fBRole\fR +.RS 4 +A string, corresponding to the ROLE property\. +.RE +.PP +\fBTransient\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is transient (typically, a popup dialog) or not\. +.RE +.PP +\fBMaximized\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is maximized or not\. +.RE +.PP +\fBMinimized\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is minimized (iconified) or not\. +.RE +.PP +\fBShaded\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is shaded or not\. +.RE +.PP +\fBStuck\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window is sticky (on all workspaces) or not\. +.RE +.PP +\fBFocusHidden\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window has asked to be left off the focus list (or, the alt\-tab list), or not\. +.RE +.PP +\fBIconHidden\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window has asked to be left off the icon list (or, the taskbar), or not\. +.RE +.PP +\fBUrgent\fR +.RS 4 +Either +\fByes\fR +or +\fBno\fR, depending on whether the window has the urgent hint set\. +.RE +.PP +\fBWorkspace\fR +.RS 4 +A number corresponding to the workspace number to which the window is attached\. The first workspace here is +\fB0\fR\. +.RE +.PP +\fBWorkspaceName\fR +.RS 4 +A string corresponding to the name of the workspace to which the window is attached\. +.RE +.PP +\fBHead\fR +.RS 4 +The number of the display head to which the window is attached\. You may match this against the special value +\fB[mouse]\fR +which refers to the head where the mouse pointer currently resides\. +.RE +.PP +\fBLayer\fR +.RS 4 +The string name of the window\'s layer, which is one of +\fBAbove Dock\fR, +\fBDock\fR, +\fBTop\fR, +\fBNormal\fR, +\fBBottom\fR, +\fBDesktop\fR +.RE +.RE +.PP +\fBExample\ 2.\ Matches any windows with the CLASSNAME of "xterm"\fR +.sp +.RS 4 +.nf +(xterm) +.fi +.RE +.PP +\fBExample\ 3.\ Matches any windows with the same CLASSNAME as the currently focused window\fR +.sp +.RS 4 +.nf +(Name=[current]) +.fi +.RE +.PP +\fBExample\ 4.\ Matches any windows on the same head as the mouse but on a different layer than the currently focused window\fR +.sp +.RS 4 +.nf +(Head=[mouse]) (Layer!=[current]) +.fi +.RE +.SH "FILES" +.PP +~/\.fluxbox/keys +.RS 4 +This is the default location for the keybinding definitions\. +.RE +.PP +/usr/X11R6/include/X11/keysymdef\.h +.RS 4 +X key names are in this file\. +.RE +.PP +/usr/X11R6/lib/X11/XKeysymDB +.RS 4 +X key names are also in this file\. +.RE +.SH "RESOURCES" +.PP +session\.keyFile: <location> +.RS 4 +This may be set to override the location of the keybinding definitions\. +.RE +.SH "ENVIRONMENT" +Remember that \fBExecCommand\fR command can take advantage of other environment variables if they are set before fluxbox is started, or via the \fBExport\fR or \fBSetEnv\fR commands\. For example, if \fB$TERM\fR is set, it could be use like this: +.sp +.sp +.RS 4 +.nf +Mod1 x :ExecCommand $TERM +.fi +.RE +For more information about environment variables, see your shell\'s manual\. +.sp +.SH "EXAMPLES" +Here are some interesting and/or useful examples you can do with your keys file\. +.sp +.sp +.RS 4 +.nf +# Mod4+drag moves a window +OnWindow Mod4 Mouse1 :StartMoving + +# If any xterm windows are open, cycle through them\. If none are open, open +# one: +Mod4 t :If {Some Matches (xterm)} {NextWindow (xterm)} {Exec xterm} + +# Set a different wallpaper on every workspace: +ChangeWorkspace :Exec fbsetbg ~/\.fluxbox/bg$(xprop \-root _NET_CURRENT_DESKTOP | awk \'{print $3}\')\.png +.fi +.RE +.SH "AUTHOR AND CREDITS" +This manpage is the combined work of: +.sp +.sp +.RS 4 +\h'-04'\(bu\h'+03'Jim Ramsay <i\.am at jimramsay com> (>fluxbox\-1\.0\.0) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Curt Micol <asenchi at asenchi com> (>fluxbox\-0\.9\.11) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Tobias Klausmann <klausman at users sourceforge net> (⇐fluxbox\-0\.9\.11) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Grubert <grubert at users sourceforge net> (fluxbox) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Matthew Hawkins <matt at mh dropbear id au> (blackbox) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Wilbert Berendsen <wbsoft at xs4all nl> (blackbox) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Numerous other languages could be available if someone jumps in\. +.RE +.SH "SEE ALSO" +fluxbox(1), xev(1), xkill(1), regex(7) +.sp
M
doc/fluxbox.1.in
→
doc/fluxbox.1.in
@@ -1,335 +1,384 @@
.\" Title: fluxbox .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/> -.\" Date: 04/21/2007 +.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> +.\" Date: 08/04/2008 .\" Manual: .\" Source: .\" -.TH "FLUXBOX" "1" "04/21/2007" "" "" +.TH "FLUXBOX" "1" "08/04/2008" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .SH "NAME" -fluxbox \- A lightweight window manager for the X Windowing System +fluxbox - A lightweight window manager for the X Windowing System .SH "SYNOPSIS" -\fIfluxbox\fR [\-v | \-version] [\-h | \-help] [\-i | \-info] \fIfluxbox\fR [\-rc rcfile] [\-log logfile] [\-display display] [\-screen scr,scr|all] [\-verbose] +\fIfluxbox\fR [\-rc rcfile] [\-log logfile] [\-display display] [\-screen scr,scr|all] [\-verbose] +.sp +\fIfluxbox\fR [\-v | \-version] | [\-h | \-help] | [\-i | \-info] | [\-list\-commands] .sp .SH "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) 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\. .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(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\. .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. +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\. .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(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\. .sp .SH "OPTIONS" .PP \-display display .RS 4 -Start fluxbox on the specified display. Programs started by fluxbox will share the DISPLAY environment variable also. +Start fluxbox on the specified display\. Programs started by fluxbox will share the DISPLAY environment variable also\. .RE .PP \-h, \-help .RS 4 -Display command line options. +Display command line options\. .RE .PP \-i, \-info .RS 4 -Display useful information concerning the defaults and compiled\-in options. +Display useful information concerning the defaults and compiled\-in options\. .RE .PP \-log logfile .RS 4 -Starting fluxbox with this option will designate a file in which you want to log events to. +Starting fluxbox with this option will designate a file in which you want to log events to\. .RE .PP \-rc rcfile .RS 4 -Use a different config file other than the default ~/.fluxbox/init. +Use a different config file other than the default ~/\.fluxbox/init\. .RE .PP \-v, \-version .RS 4 -The version of fluxbox installed. +The version of fluxbox installed\. .RE .PP \-screen scr,scr|all .RS 4 -Run on specified screens only or all (by default). +Run on specified screens only or all (by default)\. .RE .PP \-verbose .RS 4 -Print more information in process. +Print more information in process\. .RE .SH "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 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. +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\. .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 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\. .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 ~/\.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\. .sp .SH "USING FLUXBOX" -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. +When using fluxbox for the first time, users who are more accustomed to full desktop environments such as KDE or Gnome may be a little surprised by the minimal screen content\. fluxbox is designed to be fast and powerful, so it may take a bit of getting used to \(em however, the rewards are worthwhile\. .sp -In this section, we'll give a quick summary of the common things. However, we recommend that you consult the referenced sections of this manual to further develop your understanding of what you can do with fluxbox. +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\. .sp .SS "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 RootMenu\. A middle click (mouse button 2) on the desktop shows you the WorkspaceMenu\. .sp .SS "RootMenu and WorkspaceMenu" -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 MENUS on how to customize these menus\. .sp .SS "Toolbar" The toolbar contains any combination of the following tools: .sp -.TP 4 -\(bu - +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBWorkspace Name\fR: Name of the current visible workspace -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBIconbar\fR: List of windows managed by fluxbox -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBSystem Tray\fR: Area for applets -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBClock\fR: Date and Time -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBWorkspace Arrows\fR: Previous/Next Workspace -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBWindow Arrows\fR: 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. +.RE +The contents of the toolbar can be configured in the `init\' file\. We discuss the `init\' file at great length in the RESOURCES section\. .sp .SS "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 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\. 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\. .sp .SS "Layers" fluxbox manages the following layers (from highest to lowest): .sp -.TP 4 -\(bu -Above Dock -.TP 4 -\(bu -Dock -.TP 4 -\(bu -Top -.TP 4 -\(bu -Normal -.TP 4 -\(bu -Bottom -.TP 4 -\(bu -Desktop -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 the APPLICATIONS section. We discuss the WindowMenu in the MENUS section. We discuss layers in more detail in the LAYERS section. +.sp +.RS 4 +\h'-04'\(bu\h'+03'Above Dock +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Dock +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Top +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Normal +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Bottom +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Desktop +.RE +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 the APPLICATIONS section\. We discuss the WindowMenu in the MENUS section\. We discuss layers in more detail in the LAYERS section\. .sp .SS "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. +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\. .sp .SS "Windows" -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 Window Menu section of MENUS\. .sp .SS "Tabs" -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. +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 .SH "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 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: .sp .sp .RS 4 .nf -session.menuFile: <menufile> +session\.menuFile: <menufile> .fi .RE -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. +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\. .sp .SS "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 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\. .sp -.TP 4 -\(bu - -\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. -.TP 4 -\(bu - -\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. -.TP 4 -\(bu - -\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 +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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 fluxstyle(1)). -.TP 4 -\(bu - -\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. -.TP 4 -\(bu - -\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. -.TP 4 -\(bu - -\fBWindow\fR: Allows you to switch your window manager. (Only listed if you have other window managers/desktop environments installed.) -.TP 4 -\(bu - -\fBLock Screen\fR: Locks the screen. -.TP 4 -\(bu - -\fBfluxbox Command\fR: A little Commandline will popup where you can enter a fluxbox command. -.TP 4 -\(bu - -\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. -.TP 4 -\(bu - -\fBRestart\fR: Restarts the windowmanager. This starts a completely new fluxbox process, rereads files and redraws all graphical elements. Running applications will remain open, however. -.TP 4 -\(bu -\fBExit\fR: Exits fluxbox and shuts down the X Window server. +described in fluxstyle(1))\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBWindow\fR: Allows you to switch your window manager\. (Only listed if you have other window managers/desktop environments installed\.) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBLock Screen\fR: Locks the screen\&... +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBfluxbox Command\fR: A little Commandline will popup where you can enter a fluxbox command\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'*Exit: Exits fluxbox and probably shuts down the X Window server\. +.RE .SS "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. +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\. .sp -.TP 4 -\(bu - -\fBFocus Model\fR: Please read the FOCUS MODEL section at the end of this manual. -.TP 4 -\(bu - -\fBTab Options\fR: Lets you configure the properties of tabs. Detailed in TAB OPTIONS section. -.TP 4 -\(bu - -\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. -.TP 4 -\(bu - -\fBToolbar\fR: Please take a look at the "Configuration via the Toolbar Menu" part of the TOOLBAR section. -.TP 4 -\(bu - -\fBImage Dithering\fR: Enable or disable dithering of images. -.TP 4 -\(bu - -\fBOpaque Window Moving\fR: If enabled, you will see the window content while dragging it. Otherwise the window will be shown as a "border". -.TP 4 -\(bu - -\fBFull Maximization\fR: Enabling this will override the separate settings for the slit/toolbar. Windows will always maximize over/under both of them. -.TP 4 -\(bu - -\fBFocus New Window\fR: If enabled, a newly opened window will gain focus. -.TP 4 -\(bu - -\fBFocus Last Window on Workspace\fR: This focuses the previous window when switching back to a workspace if the option is enabled. -.TP 4 -\(bu - -\fBWindows Warping\fR: If enabled, you can drag windows from one workspace to another. -.TP 4 -\(bu - -\fBDecorate Transient Windows\fR: With this option enabled all temporary windows will have a border and grips. -.TP 4 -\(bu - -\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. -.TP 4 -\(bu - -\fBTransparency\fR: This sets the transparency for a focused, unfocused window and the menu. +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBFocus Model\fR: Please read the FOCUS MODEL section at the end of this manual\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBTab Options\fR: Lets you configure the properties of tabs\. Detailed in TAB OPTIONS section\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBToolbar\fR: Please take a look at the "Configuration via the Toolbar Menu" part of the TOOLBAR section\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBImage Dithering\fR: Enable or disable dithering of images\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBOpaque Window Moving\fR: If enabled, you will see the window content while dragging it\. Otherwise the window will be shown as a "border"\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBFull Maximization\fR: Enabling this will override the separate settings for the slit/toolbar\. Windows will always maximize over/under both of them\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBFocus New Window\fR: If enabled, a newly opened window will gain focus\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBFocus Last Window on Workspace\fR: This focuses the previous window when switching back to a workspace if the option is enabled\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBWindows Warping\fR: If enabled, you can drag windows from one workspace to another\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBDecorate Transient Windows\fR: With this option enabled all temporary windows will have a border and grips\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBTransparency\fR: This sets the transparency for a focused, unfocused window and the menu\. +.RE .SS "Window Menu" -The Window menu is displayed when you right click on the titlebar of a window. The options available are: +The Window menu is displayed when you right click on the titlebar of a window\. The options available are: .sp -.TP 4 -\(bu - -\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. -.TP 4 -\(bu - -\fBShade\fR: Shade the window (display the titlebar only). -.TP 4 -\(bu - -\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). -.TP 4 -\(bu - -\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 -.TP 4 -\(bu -Button 1 (Un)Maximize as normal. -.TP 4 -\(bu -Button 2 (Un)Maximize window vertically. -.TP 4 -\(bu -Button 3 (Un)Maximize window horizontally. +\h'-04'\(bu\h'+03' +\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\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBShade\fR: Shade the window (display the titlebar only)\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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)\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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 +\h'-04'\(bu\h'+03'Button 1 (Un)Maximize as normal\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Button 2 (Un)Maximize window vertically\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Button 3 (Un)Maximize window horizontally\. +.RE +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBRaise\fR: Raise the window\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBLower\fR: Lower the window\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBStick\fR: (Un)Stick window\. A `stuck\' window will always be displayed on all workspaces\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBLayer\&...\fR: Change the layer of this window\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBRemember\&...\fR: Specify which window settings should be stored in the apps file, covered later on in the APPLICATIONS section\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBClose\fR: Close the application softly\. .RE -.TP 4 -\(bu - -\fBRaise\fR: Raise the window. -.TP 4 -\(bu - -\fBLower\fR: Lower the window. -.TP 4 -\(bu - -\fBStick\fR: (Un)Stick window. A `stuck' window will always be displayed on all workspaces. -.TP 4 -\(bu - -\fBLayer\&...\fR: Change the layer of this window. -.TP 4 -\(bu - -\fBRemember\&...\fR: Specify which window settings should be stored in the apps file, covered later on in the APPLICATIONS section. -.TP 4 -\(bu - -\fBClose\fR: Close the application softly. .SS "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'. +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\'\. .sp .SS "Menu Behavior" -The behavior of the submenus in a menu can be configured in the `init' file, with the following entries (default for both is 0): +The behavior of the submenus in a menu can be configured in the `init\' file, with the following entries (default for both is 0): .sp .sp .RS 4 .nf -session.screen0.menuDelay: <msec> -session.screen0.menuDelayClose: <msec> +session\.screen0\.menuDelay: <msec> +session\.screen0\.menuDelayClose: <msec> .fi .RE .SS "Menu Syntax" -There are up to four fields in a menu line. They are of the form: +There are up to four fields in a menu line\. They are of the form: .sp .sp .RS 4@@ -338,96 +387,95 @@ [tag] (label|filename) {command|filename} <icon file>
.fi .RE The supported tags are: -.sp .PP [begin] (label) .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 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\. .RE .PP [end] .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 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\. .RE .PP [exec] (label) {command} .RS 4 -Inserts a command item into the menu. When you select the menu item from the menu, fluxbox runs -\fIcommand\fR. +Inserts a command item into the menu\. When you select the menu item from the menu, fluxbox runs +\fIcommand\fR\. .RE .PP [exit] (label) .RS 4 -Inserts an item that shuts down and exits fluxbox. Any open windows are reparented to the root window before fluxbox exits. +Inserts an item that shuts down and exits fluxbox\. Any open windows are reparented to the root window before fluxbox exits\. .RE .PP [include] (file\-or\-directory\-name) .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. +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\. .RE .PP [nop] (label) .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. +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\. .RE .PP [separator] .RS 4 -This will create a nice separation line. Useful for splitting up sections in a +This will create a nice separation line\. Useful for splitting up sections in a \fIpretty\fR -way. +way\. .RE .PP [style] (label) {filename} .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. +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 [stylesmenu] (directory) .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. +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\. .RE .PP [stylesdir] (label) {directory} .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. +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\. .RE .PP [submenu] (label) {menutitle} .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. +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\. .RE .PP [reconfig] (label) .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. +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 [restart] (label) {command} .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. +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\. .RE .PP [config] (label) .RS 4 -Inserts a fluxbox native submenu item, containing numerous configuration options concerning window placement, focus style, window moving style, etc. +Inserts a fluxbox native submenu item, containing numerous configuration options concerning window placement, focus style, window moving style, etc\. .RE .PP [wallpapers] (label) .RS 4 -This allows you to list your backgrounds. This tag is built in to use fbsetbg(1) and allows you to simply click on an image to set your wallpaper. See? fluxbox makes it easy\&... +This allows you to list your backgrounds\. This tag is built in to use fbsetbg(1) and allows you to simply click on an image to set your wallpaper\. See? fluxbox makes it easy\&... .RE .PP [wallpapermenu] (directory) {command} .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. +This inserts a menu item to set the wallpaper for each file in the given directory\. The command is optional and defaults to fbsetbg\. .RE .PP [workspaces] (label) .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 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)\. .RE -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\\\\\fR inserts a literal back\-slash into the label/command/filename field. +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 Here is an example menu file: .sp@@ -436,7 +484,7 @@ .RS 4
.nf # fluxbox menu file [begin] (fluxbox) - [exec] (rxvt) {rxvt \-ls} </usr/X11R6/share/icons/terminal.xpm> + [exec] (rxvt) {rxvt \-ls} </usr/X11R6/share/icons/terminal\.xpm> [exec] (netscape) {netscape \-install} [exec] (The GIMP) {gimp} [exec] (XV) {xv}@@ -450,9 +498,9 @@ [exec] (edit) {mozilla \-edit}
[exec] (compose) {mozilla \-compose} [end] [submenu] (Window Manager) - [exec] (Edit Menus) {nedit ~/.fluxbox/menu} + [exec] (Edit Menus) {nedit ~/\.fluxbox/menu} [submenu] (Style) {Which Style?} - [stylesdir] (~/.fluxbox/styles) + [stylesdir] (~/\.fluxbox/styles) [stylesmenu] (fluxbox Styles) {@pkgdatadir@/styles} [end] [config] (Config Options)@@ -464,138 +512,153 @@ [end]
.fi .RE .SH "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). +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)\. .sp The tools in the toolbar can be enabled/disabled in the init file with the arguments given to the line: .sp .sp .RS 4 .nf -session.screen0.toolbar.tools +session\.screen0\.toolbar\.tools .fi .RE -The order and number of tools is freely selectable, but they must be separated by a ",". E.g.: +The order and number of tools is freely selectable, but they must be separated by a ","\. E\.g\.: .sp .sp .RS 4 .nf -session.screen0.toolbar.tools: workspacename, systemtray, iconbar, clock +session\.screen0\.toolbar\.tools: workspacename, systemtray, iconbar, clock .fi .RE The possible tools are: .sp -.TP 4 -\(bu - +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBClock\fR: This will show an area to display a clock and the date according to the format specification listed in "man strtftime" -.TP 4 -\(bu - -\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). -.TP 4 -\(bu - -\fBSystemtray\fR: The Systemtray can hold applications that are made to use it. -.TP 4 -\(bu - -\fBWorkspaceName\fR: This displays the name of the current workspace. -.TP 4 -\(bu - -\fBPrevWorkspace\fR: This displays an arrow that allows to switch to the workspace left of the current one. -.TP 4 -\(bu - -\fBNextWorkspace\fR: This displays an arrow that allows to switch to the workspace right of the current one. -.TP 4 -\(bu - -\fBPrevWindow\fR: This displays an arrow that switches focus to the previous visible window on the current workspace. -.TP 4 -\(bu - -\fBNextWindow\fR: 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). +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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)\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBSystemtray\fR: The Systemtray can hold applications that are made to use it\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBWorkspaceName\fR: This displays the name of the current workspace\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBPrevWorkspace\fR: This displays an arrow that allows to switch to the workspace left of the current one\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBNextWorkspace\fR: This displays an arrow that allows to switch to the workspace right of the current one\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBPrevWindow\fR: This displays an arrow that switches focus to the previous visible window on the current workspace\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBNextWindow\fR: This displays an arrow that switches focus to the next visible window on the current workspace\. +.RE +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)\. .sp .SS "Configuration via the Toolbar Menu" -All changes take effect immediately, which needs a restart to make the change visible. Here are the settings: +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: +.sp .sp -.TP 4 -\(bu - -\fBVisible\fR: Sets the toolbar either to visible or invisible. +.RS 4 +\h'-04'\(bu\h'+03' +\fBVisible\fR: Sets the toolbar either to visible or invisible\. .sp .RS 4 .nf -session.screen0.toolbar.visible: <boolean> +session\.screen0\.toolbar\.visible: <boolean> .fi .RE -.TP 4 -\(bu - -\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. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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 .RS 4 .nf -session.screen0.toolbar.autoHide: <boolean> -session.autoRaiseDelay: <int> +session\.screen0\.toolbar\.autoHide: <boolean> +session\.autoRaiseDelay: <int> .fi .RE -.TP 4 -\(bu - -\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. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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\. .sp .RS 4 .nf -session.screen0.toolbar.widthPercent: <int> +session\.screen0\.toolbar\.widthPercent: <int> .fi .RE -.TP 4 -\(bu - -\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. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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 .RS 4 .nf -session.screen0.toolbar.maxOver: <boolean> -session.screen0.fullMaximization: <boolean> +session\.screen0\.toolbar\.maxOver: <boolean> +session\.screen0\.fullMaximization: <boolean> .fi .RE -.TP 4 -\(bu - -\fBLayer\&...\fR: This sets the layer on which the toolbar is set. With this you can set the toolbar to "Always on top". +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBLayer\&...\fR: This sets the layer on which the toolbar is set\. With this you can set the toolbar to "Always on top"\. .sp .RS 4 .nf -session.screen0.toolbar.layer: <layer> +session\.screen0\.toolbar\.layer: <layer> .fi .RE -.TP 4 -\(bu - -\fBPlacement\fR: Sets the toolbar to any edge of the screen, either centered or aligned with a corner. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBPlacement\fR: Sets the toolbar to any edge of the screen, either centered or aligned with a corner\. .sp .RS 4 .nf -session.screen0.toolbar.placement: <direction> +session\.screen0\.toolbar\.placement: <direction> .fi .RE -.TP 4 -\(bu - -\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. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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\. .sp .RS 4 .nf -session.screen0.toolbar.alpha: <int> +session\.screen0\.toolbar\.alpha: <int> .fi .RE -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBIconbar Mode\fR: .sp .RS 4@@ -603,136 +666,146 @@ .nf
Specifies the mode of the iconbar: .fi .RE -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBNone\fR: will not show any windows -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBIcons\fR: shows windows from all workspaces that are minimized (iconified) -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBNoIcons\fR: shows windows from all workspaces that are not minimized (iconified) -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBWorkspaceIcons\fR: shows windows from the current workspace that are minimized (iconified) -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBWorkspaceNoIcons\fR: shows windows from the current workspace that are not minimized (iconified) -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBWorkspace\fR: shows all windows from the current workspace -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBAll Windows\fR: shows all windows from all workspaces .sp .RS 4 .nf -session.screen0.iconbar.mode: <mode> +session\.screen0\.iconbar\.mode: <mode> .fi .RE -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBAlignment\fR: -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBLeft\fR: all icons will be left\-aligned with the width set in the init file -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBRelative\fR: all icons will be sized evenly to fill the iconbar completely -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBRight\fR: all icons will be right\-aligned with the width set in the init file .sp .RS 4 .nf -session.screen0.iconbar.alignment: <alignment> -session.screen0.iconbar.iconWidth: <int> +session\.screen0\.iconbar\.alignment: <alignment> +session\.screen0\.iconbar\.iconWidth: <int> .fi .RE -.TP 4 -\(bu - -\fBShow Pictures\fR: If enabled the iconbar will show the application's icon (if provided by the application) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBShow Pictures\fR: If enabled the iconbar will show the application\'s icon (if provided by the application) .sp .RS 4 .nf -session.screen0.iconbar.usePixmap: <boolean> +session\.screen0\.iconbar\.usePixmap: <boolean> .fi .RE -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \fBClock\fR: Lets you switch between the 00:00am \- 11:59pm and 00:00 \- 23:59 notation -.TP 4 -\(bu - +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' \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). +\fIman date\fR)\. .sp .RS 4 .nf -session.screen0.strftimeFormat: <format> +session\.screen0\.strftimeFormat: <format> .fi +.RE .RE .SH "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 [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\. .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 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: .sp .sp .RS 4 .nf -session.screen0.window.focus.alpha: <integer> -session.screen0.window.unfocus.alpha: <integer> +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. + 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> +session\.screen0\.slit\.autoHide: <boolean> +session\.screen0\.toolbar\.autoHide: <boolean> The autoHide resources allow the user to set the behavior of the toolbar - and slit. This behavior can be that they disappear when they are not being - used actively by the user, or they remain visible at all times. Default: + and slit\. This behavior can be that they disappear when they are not being + used actively by the user, or they remain visible at all times\. Default: False -session.screen0.desktopwheeling: <boolean> - This sets the ability to utilize the user's scroll wheel to change the - current workspace. Default: True - -session.screen0.windowScrollAction: shade|nexttab +session\.screen0\.windowScrollAction: shade|nexttab This allows you to execute a command by scrolling on the titlebar of a - window. For `shade', scrolling down will shade the window, and scrolling - up will unshade it. For `nexttab', scrolling down will focus the next tab, - and scrolling up will focus the previous one. Default: <blank> + window\. For `shade\', scrolling down will shade the window, and scrolling + up will unshade it\. For `nexttab\', scrolling down will focus the next tab, + and scrolling up will focus the previous one\. Default: <blank> -session.screen0.reversewheeling: <boolean> -session.screen0.windowScrollReverse: <boolean> - These switch the roles of scrolling up and scrolling down for the previous - two sets of resources. Default: False +session\.screen0\.windowScrollReverse: <boolean> + This switches the role of scrolling up and scrolling down for the previous + resource\. Default: False -session.screen0.slit.layer: <layer> -session.screen0.toolbar.layer: <layer> +session\.screen0\.slit\.layer: <layer> +session\.screen0\.toolbar\.layer: <layer> With these two resources, you can set the layer you want the toolbar and - the slit to appear on. Please read the LAYER section for more information. + the slit to appear on\. Please read the LAYER section for more information\. Default: Dock -session.screen0.slit.placement: <placement> -session.screen0.toolbar.placement: <placement> - These allow users to place the slit and toolbar where they like. Possible +session\.screen0\.slit\.placement: <placement> +session\.screen0\.toolbar\.placement: <placement> + These allow users to place the slit and toolbar where they like\. Possible options are: \- BottomCenter \- BottomLeft@@ -747,30 +820,30 @@ \- TopCenter
\- TopLeft \- TopRight -session.screen0.slit.maxOver: <boolean> -session.screen0.toolbar.maxOver: <boolean> -session.screen0.tabs.maxOver: <boolean> +session\.screen0\.slit\.maxOver: <boolean> +session\.screen0\.toolbar\.maxOver: <boolean> +session\.screen0\.tabs\.maxOver: <boolean> Setting these to True will allow application windows to maximize over the - complete screen. Setting to False allows the slit, toolbar, and external + complete screen\. Setting to False allows the slit, toolbar, and external tabs to hold their territory and will always be visible when an - application is maximized. Default: False + application is maximized\. Default: False -session.screen0.toolbar.height: <integer> - Set the height of the toolbar. If the value is set to 0, the style file - will gain control over the toolbar height. It is possible to set a fixed - height by changing this value to something greater than 0. Default: 0 +session\.screen0\.toolbar\.height: <integer> + Set the height of the toolbar\. If the value is set to 0, the style file + will gain control over the toolbar height\. It is possible to set a fixed + height by changing this value to something greater than 0\. Default: 0 -session.screen0.toolbar.visible: <boolean> - The user can set whether they want to have a toolbar on screen at all. - Setting to False removes the toolbar from the screen. Default: True +session\.screen0\.toolbar\.visible: <boolean> + The user can set whether they want to have a toolbar on screen at all\. + Setting to False removes the toolbar from the screen\. Default: True -session.screen0.toolbar.widthPercent: <integer> - This resource sets the width percentage of the toolbar on the screen. +session\.screen0\.toolbar\.widthPercent: <integer> + This resource sets the width percentage of the toolbar on the screen\. Default: 65 -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. +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\. Possible tools:: \- clock \- iconbar@@ -781,38 +854,27 @@ \- prevworkspace
\- systemtray \- workspacename -session.screen0.slit.onhead: <integer> -session.screen0.toolbar.onhead: <integer> +session\.screen0\.slit\.onhead: <integer> +session\.screen0\.toolbar\.onhead: <integer> For those that use xinerama, users can set this value to the number of the - head where they would like to see the slit and toolbar, starting from 1. - Setting this to 0 will ignore xinerama information. Default: 0 + head where they would like to see the slit and toolbar, starting from 1\. + Setting this to 0 will ignore xinerama information\. Default: 0 -session.screen0.iconbar.mode: <mode> - This value is set in the Iconbar Mode menu. The available options are:: - \- All Windows - \- Icons - \- NoIcons - \- None - \- Workspace - \- WorkspaceIcons - \- WorkspaceNoIcons +session\.screen0\.iconbar\.mode: <pattern> + This determines which windows will be displayed in the iconbar\. Any window + pattern available to the Next/PrevWindow keybindings is acceptable\. + Default: {static groups} (workspace) -session.screen0.iconbar.usePixmap: <boolean> - This is also set in the Iconbar Mode menu. When set to True, this will - show the native icon of applications. Default: True +session\.screen0\.iconbar\.usePixmap: <boolean> + This is also set in the Iconbar Mode menu\. When set to True, this will + show the native icon of applications\. Default: True -session.screen0.iconbar.iconTextPadding: <integer> +session\.screen0\.iconbar\.iconTextPadding: <integer> This specifies the space between the window title and the edge of the - button. Default: 10 - -session.screen0.iconbar.wheelMode: Screen|On|Off - This defines the behavior for scrolling on the iconbar. `Screen' uses the - value set in session.screen0.desktopWheeling . `On' means scrolling on the - iconbar will change the current workspace. `Off' means scrolling on the - iconbar will do nothing. Default: Screen + button\. Default: 10 -session.screen0.iconbar.alignment: <position> - This value should be changed in the Iconbar Mode menu. Default: +session\.screen0\.iconbar\.alignment: <position> + This value should be changed in the Iconbar Mode menu\. Default: Relative Available options:@@ -820,122 +882,118 @@ \- Left: Fixed width, aligned left
\- Relative: Width varies to fill the iconbar \- Right: Fixed width, aligned right -session.screen0.iconbar.iconWidth: <integer> - Used to specify the iconbar button width for Left/Right alignment. +session\.screen0\.iconbar\.iconWidth: <integer> + Used to specify the iconbar button width for Left/Right alignment\. Default: 70 -session.screen0.overlay.lineWidth: 1 -session.screen0.overlay.lineStyle: LineSolid -session.screen0.overlay.joinStyle: JoinMiter -session.screen0.overlay.capStyle: CapNotLast - These are options for how fluxbox draws lines. See - `man XSetLineAttributes' for more details. Defaults: listed above +session\.screen0\.overlay\.lineWidth: 1 +session\.screen0\.overlay\.lineStyle: LineSolid +session\.screen0\.overlay\.joinStyle: JoinMiter +session\.screen0\.overlay\.capStyle: CapNotLast + These are options for how fluxbox draws lines\. See + `man XSetLineAttributes\' for more details\. Defaults: listed above -session.screen0.slit.direction: Vertical|Horizontal +session\.screen0\.slit\.direction: Vertical|Horizontal This specifies whether clients in the slit are arranged horizontally or - vertically. Default: Vertical + vertically\. Default: Vertical -session.screen0.strftimeFormat: <date> - This adjusts the way the current time is displayed in the toolbar. The - strftime(3) format is used. Default: %I:%M %p +session\.screen0\.strftimeFormat: <date> + This adjusts the way the current time is displayed in the toolbar\. The + strftime(3) format is used\. Default: %I:%M %p -session.screen0.tabs.intitlebar: <boolean> +session\.screen0\.tabs\.intitlebar: <boolean> This specifies whether tabs should be embedded in the titlebar or placed - outside the window. Default: False + outside the window\. Default: True -session.screen0.tab.placement: <placement> - This specifies where external tabs will appear on the window. Default: +session\.screen0\.tab\.placement: <placement> + This specifies where external tabs will appear on the window\. Default: TopLeft -session.screen0.tab.width: <integer> - This specifies the width of external tabs in pixels. Default: 64 +session\.screen0\.tab\.width: <integer> + This specifies the width of external tabs in pixels\. Default: 64 -session.screen0.followModel: <model> -session.screen0.userFollowModel: <model> +session\.screen0\.userFollowModel: <model> This specifies the behavior when a window on another workspace becomes the - active window. The former is used when an application asks to focus the - window, and the latter is used when the window is activated due to user - actions, such as clicking in the iconbar, menu, or a pager. `Ignore' does - nothing. `Follow' moves to the window's workspace. `Current' moves the - window to the current workspace. `SemiFollow' acts like `Current' for - iconified windows and like `Follow' otherwise. Defaults: Ignore and - Follow, respectively. + active window\. `Ignore\' does nothing\. `Follow\' moves to the window\'s + workspace\. `Current\' moves the window to the current workspace\. + `SemiFollow\' acts like `Current\' for minimized windows and like `Follow\' + otherwise\. Default: Follow -session.screen0.resizeMode: Bottom|Quadrant|Center - Setting this resource to `Quadrant' makes resizing by using the modkey - grab the corner closest to the mouse pointer instead of the bottom right - corner. `Center' resizes all corners at the same time. Default: Bottom +session\.screen0\.followModel: <model> + This specifies the behavior when a window on another workspace requests to + be focused\. `Ignore\' does nothing, and `Follow\' uses the setting in + session\.screen0\.userFollowModel\. Default: Ignore -session.screen0.focusModel: ClickToFocus|MouseFocus - This controls how windows gain focus via the mouse. With `ClickToFocus', - the user must click on the window. With `MouseFocus', windows gain focus - whenever the mouse moves over them. Default: ClickToFocus +session\.screen0\.focusModel: ClickToFocus|MouseFocus + This controls how windows gain focus via the mouse\. With `ClickToFocus\', + the user must click on the window\. With `MouseFocus\', windows gain focus + whenever the mouse moves over them\. Default: ClickToFocus -session.screen0.autoRaise: <boolean> - When True, this setting automatically raises any window that gains focus. +session\.screen0\.autoRaise: <boolean> + When True, this setting automatically raises any window that gains focus\. Default: True -session.autoRaiseDelay: <integer> +session\.autoRaiseDelay: <integer> Adjusts the delay (in milli\-sec) before focused windows will raise - when using the Autoraise option. Default: 250 + when using the Autoraise option\. Default: 250 -session.screen0.clickRaises: <boolean> +session\.screen0\.clickRaises: <boolean> This setting allows a user to click anywhere on a window to bring it on - top of other windows. Otherwise, only the titlebar will work. Default: + top of other windows\. Otherwise, only the titlebar will work\. Default: True -session.screen0.workspacewarping: <boolean> +session\.screen0\.workspacewarping: <boolean> This setting enables a user to change workspaces by dragging a window - across the edge of the screen. Default: True + across the edge of the screen\. Default: True -session.screen0.showwindowposition: <boolean> +session\.screen0\.showwindowposition: <boolean> Setting this resource to True shows the user, in a little window, the exact position of the application window while the user is - dragging it. Allows a precise placement of windows on a screen. + dragging it\. Allows a precise placement of windows on a screen\. Default: True -session.screen0.decorateTransient: <boolean> +session\.screen0\.decorateTransient: <boolean> This controls whether or not transient windows get certain window - decorations, currently the maximize button and handle. + decorations, currently the maximize button and handle\. Default: True -session.screen0.defaultDeco: <bitmask> +session\.screen0\.defaultDeco: <string> This specifies the default window decorations, according to the same - bitmask as used by the `[Deco]' option in the `apps' file, described in - the APPLICATIONS section. Default: all bits set. + options available to the `[Deco]\' option in the `apps\' file, described in + the APPLICATIONS section\. Default: NORMAL\. -session.screen0.menuMode: Delay|Click - This setting controls the circumstances under which submenus open. With - `Click', the user must click on the menu item in order for the submenu to - open. With `Delay', submenus open when the mouse hovers over the menu - item. Default: Delay +session\.screen0\.menuMode: Delay|Click + This setting controls the circumstances under which submenus open\. With + `Click\', the user must click on the menu item in order for the submenu to + open\. With `Delay\', submenus open when the mouse hovers over the menu + item\. Default: Delay -session.screen0.menuDelay: <integer> +session\.screen0\.menuDelay: <integer> This sets the delay in milliseconds for submenus to open with the previous - option set to `Delay'. Default: 0 + option set to `Delay\'\. Default: 0 -session.screen0.menuDelayClose: 0 +session\.screen0\.menuDelayClose: 0 This value sets the delay in milliseconds that you would like the menu to - remain visible after you've clicked out of it. Default: 0 + remain visible after you\'ve clicked out of it\. Default: 0 -session.screen0.focusNewWindows: <boolean> - This sets whether or not new windows will become focused automatically. +session\.screen0\.focusNewWindows: <boolean> + This sets whether or not new windows will become focused automatically\. Default: True -session.screen0.workspaceNames: <names> - Here is where the user can name their workspaces. However it is +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 - these. Default: one, two, three, four + these\. Default: one, two, three, four -session.screen0.edgeSnapThreshold: <integer> - When moving a window across your screen, fluxbox is able to have it `snap' - to the edges of the screen and other windows for easy placement. This +session\.screen0\.edgeSnapThreshold: <integer> + When moving a window across your screen, fluxbox is able to have it `snap\' + to the edges of the screen and other windows for easy placement\. This variable tells fluxbox the distance (in pixels) at which the window will - jump to the edge. Default: 0 + jump to the edge\. Default: 0 -session.screen0.windowPlacement: <placement strategy> +session\.screen0\.windowPlacement: <placement strategy> This resource specifies where to place new windows when not otherwise - specified (by the program or the `apps' file, for example). Here are the + specified (by the program or the `apps\' file, for example)\. Here are the options: \- RowSmartPlacement: tries to place windows in rows without overlapping \- ColSmartPlacement: tries to place windows in columns without overlapping@@ -943,601 +1001,247 @@ \- CascadePlacement: places windows below the titlebar of the previous one
\- UnderMousePlacement: places new windows underneath the mouse Default: RowSmartPlacement -session.screen0.rowPlacementDirection: LeftToRight|RightToLeft -session.screen0.colPlacementDirection: TopToBottom|BottomToTop +session\.screen0\.rowPlacementDirection: LeftToRight|RightToLeft +session\.screen0\.colPlacementDirection: TopToBottom|BottomToTop These settings control the direction in which windows are tiled using the - RowSmartPlacement and ColSmartPlacement strategies described above. + RowSmartPlacement and ColSmartPlacement strategies described above\. Default: LeftToRight/TopToBottom -session.screen0.fullMaximization: <boolean> +session\.screen0\.fullMaximization: <boolean> If this setting is enabled, windows will maximize over the toolbar, slit, and any other window that creates a strut, no matter what their individual - settings are. Default: False + settings are\. Default: False -session.screen0.rootCommand: <command> +session\.screen0\.rootCommand: <command> This runs a command when fluxbox starts, intended for setting a default - background. If you want to override backgrounds set by styles, you should - add `background: none' to your style overlay (see section STYLE OVERLAY). - NOTE: Setting this command can be dangerous. Please make sure you know + background\. If you want to override backgrounds set by styles, you should + add `background: none\' to your style overlay (see section STYLE OVERLAY)\. + NOTE: Setting this command can be dangerous\. Please make sure you know what you are doing when setting this resource to a value other than a - desktop wallpaper command. + desktop wallpaper command\. -session.screen0.imageDither: <boolean> - This controls whether or not fluxbox created dithered images. Default: +session\.screen0\.imageDither: <boolean> + This controls whether or not fluxbox created dithered images\. Default: False -session.screen0.opaqueMove: <boolean> +session\.screen0\.opaqueMove: <boolean> When moving a window, setting this to True will draw the window - contents as it moves (this is nasty on slow systems). If False, it - will only draw an outline of the window border. Default: False + contents as it moves (this is nasty on slow systems)\. If False, it + will only draw an outline of the window border\. Default: False -session.screen0.workspaces: <integer> - Set this to the number of workspaces the users wants. Default: 4 +session\.screen0\.workspaces: <integer> + Set this to the number of workspaces the users wants\. Default: 4 -session.screen0.windowMenu: <blank>|<location> - This specifies the location of a user\-defined window menu. Default: blank +session\.screen0\.windowMenu: <blank>|<location> + This specifies the location of a user\-defined window menu\. Default: blank -session.appsFile: <location> -session.groupFile: <location> -session.keyFile: <location> -session.menuFile: <location> -session.slitlistFile: <location> -session.styleFile: <location> -session.styleOverlay: <location> - All of these resources require a pathname to their specific files. This is - where you can specify different files. Most of the defaults will be - located in the user's ~/.fluxbox directory. +session\.appsFile: <location> +session\.groupFile: <location> +session\.keyFile: <location> +session\.menuFile: <location> +session\.slitlistFile: <location> +session\.styleFile: <location> +session\.styleOverlay: <location> + All of these resources require a pathname to their specific files\. This is + where you can specify different files\. Most of the defaults will be + located in the user\'s ~/\.fluxbox directory\. -session.cacheLife: <integer> +session\.cacheLife: <integer> This tells fluxbox how long (in minutes) unused pixmaps may stay in the X - server's memory. Default: 5 + server\'s memory\. Default: 5 -session.cacheMax: <integer> +session\.cacheMax: <integer> This tells fluxbox how much memory (in Kb) it may use to store cached - pixmaps on the X server. If your machine runs short of memory, you may - lower this value. Default: 200 + pixmaps on the X server\. If your machine runs short of memory, you may + lower this value\. Default: 200 -session.colorsPerChannel: <integer> +session\.colorsPerChannel: <integer> This tells fluxbox how many colors to take from the X server on - pseudo\-color displays. A channel would be red, green, or blue. fluxbox - will allocate this variable ^ 3 and make them always available. Value must - be between 2\-6. When you run fluxbox on an 8bpp display, you must set this - resource to 4. Default: 4 + pseudo\-color displays\. A channel would be red, green, or blue\. fluxbox + will allocate this variable ^ 3 and make them always available\. Value must + be between 2\-6\. When you run fluxbox on an 8bpp display, you must set this + resource to 4\. Default: 4 -session.doubleClickInterval: <integer> +session\.doubleClickInterval: <integer> Adjust the delay in milliseconds between mouse clicks for fluxbox to - consider a double click. Default: 250 + consider a double click\. Default: 250 -session.forcePseudoTransparency: <boolean> - If you have Xorg's composite extension enabled, this setting will force +session\.forcePseudoTransparency: <boolean> + If you have Xorg\'s composite extension enabled, this setting will force the menu, windows, toolbar, and slit to use pseudo\-transparency instead of - true transparency. Default: False + true transparency\. Default: False -session.ignoreBorder: <boolean> - This configures the ability to move windows by dragging the border. +session\.ignoreBorder: <boolean> + This configures the ability to move windows by dragging the border\. Default: False -session.tabPadding: <integer> - This specifies the spacing between tabs. Default: 0 +session\.tabPadding: <integer> + This specifies the spacing between tabs\. Default: 0 -session.tabsAttachArea: Window|Titlebar - With this set to `Window', windows may be grouped by dragging one tab with - the middle mouse button and dropping it anywhere on another window. With - `Titlebar', the user must drop the tab on the target window's titlebar. +session\.tabsAttachArea: Window|Titlebar + With this set to `Window\', windows may be grouped by dragging one tab with + the middle mouse button and dropping it anywhere on another window\. With + `Titlebar\', the user must drop the tab on the target window\'s titlebar\. Default: Window -session.titlebar.left: Stick -session.titlebar.right: Minimize Maximize Close - The icons to place in the titlebar of decorated windows. The available - options are Close, Maximize, MenuIcon, Minimize, Shade, and Stick. - -session.modKey: <modifier> - This specifies a modifier to use to drag and resize windows without - clicking on the border or titlebar. For example, Alt + Left click will - move windows, and Alt + Right click will resize. Default: Mod1 +session\.titlebar\.left: Stick +session\.titlebar\.right: Minimize Maximize Close + The icons to place in the titlebar of decorated windows\. The available + options are Close, Maximize, MenuIcon, Minimize, Shade, and Stick\. .fi .RE .SH "KEYS" -You can customize fluxbox's key handling through the ~/.fluxbox/keys file. The file takes the format of: +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\. +.sp +.SH "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: .sp .sp .RS 4 .nf -[keymode:] <modifier> <key> :<command> <operation> +session\.numLayers: <integer> .fi .RE -In the example below, Mod1 is the \fIALT\fR key on the PC keyboard and Mod4 is one of the three extra keys on a pc104 branded with a familiar company logo. Lines beginning with a \fI#\fR or \fI!\fR are considered comments and unread by fluxbox. +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 -You can get a list of possible modifiers by calling \fIxmodmap \-pm\fR. This also shows you to which keys the modifiers are mapped. Additionally there is the \fIOnDesktop\fR modifier. To find valid keynames check the following files: .sp +.RS 4 +\h'-04'\(bu\h'+03'2 \- Above Dock +.RE .sp .RS 4 -.nf -/usr/X11R6/include/X11/keysymdef.h -/usr/X11R6/lib/X11/XKeysymDB -.fi +\h'-04'\(bu\h'+03'4 \- Dock .RE -Furthermore you can use Mouse1, Mouse2, etc to define actions for your mouse buttons. .sp +.RS 4 +\h'-04'\(bu\h'+03'6 \- Top +.RE .sp .RS 4 -.nf -# fluxbox keys file. -Mod1 Tab :NextWindow -Mod1 Shift Tab :PrevWindow -Mod1 F1 :Workspace 1 -Mod1 F2 :Workspace 2 -Mod1 F3 :Workspace 3 -Mod1 F4 :Workspace 4 -Mod1 F5 :Workspace 5 -Mod1 F6 :Workspace 6 -Mod1 F7 :Workspace 7 -Mod1 F8 :Workspace 8 -Mod1 F9 :Workspace 9 -Mod4 b :PrevWorkspace -Mod4 c :Minimize -Mod4 r :ExecCommand rxvt -Mod4 v :NextWorkspace -Mod4 x :Close -Mod4 m :RootMenu -Control n Mod1 n :NextTab -.fi +\h'-04'\(bu\h'+03'8 \- Normal .RE -As you can see from the last line, keybindings can be chained in a fashion similar to Emacs keybindings. .sp -Some things to know: \- Commands are case\-insensitive. \- Workspace numbering starts at "1". \- Some commands have synonyms. \- The space between the last key and the :Command is mandatory. +.RS 4 +\h'-04'\(bu\h'+03'10 \- Bottom +.RE .sp -Here are fluxbox key commands to use: +.RS 4 +\h'-04'\(bu\h'+03'12 \- Desktop +.RE +The other way to set the layer for a window is through the `apps\' file\. This method is described in the APPLICATIONS section\. .sp -.SS "Window Manager Commands" -.TP 4 -\(bu -Restart <argument> -.TP 4 -\(bu -Quit -.TP 4 -\(bu -Reconfigure -.TP 4 -\(bu -SetStyle <argument> -.TP 4 -\(bu -ExecCommand <argument> -.SS "Currently Focused Window Commands" -.TP 4 -\(bu -Minimize -.TP 4 -\(bu -MinimizeWindow -.TP 4 -\(bu -Iconify -.TP 4 -\(bu -Maximize -.TP 4 -\(bu -MaximizeWindow -.TP 4 -\(bu -MaximizeHorizontal -.TP 4 -\(bu -MaximizeVertical -.TP 4 -\(bu -ResizeTo <width> <height> -.TP 4 -\(bu -Resize <delta\-width> <delta\-height> -.TP 4 -\(bu -ResizeHorizontal <delta\-width> -.TP 4 -\(bu -ResizeVertical <delta\-height> -.TP 4 -\(bu -MoveTo <x> <y> -.TP 4 -\(bu -Move <delta\-x> <delta\-y> -.TP 4 -\(bu -MoveRight <delta\-x> -.TP 4 -\(bu -MoveLeft <delta\-x> -.TP 4 -\(bu -MoveUp <delta\-y> -.TP 4 -\(bu -MoveDown <delta\-y> -.TP 4 -\(bu -Raise -.TP 4 -\(bu -Lower -.TP 4 -\(bu -Close -.TP 4 -\(bu -Shade -.TP 4 -\(bu -ShadeWindow -.TP 4 -\(bu -Stick -.TP 4 -\(bu -StickWindow -.TP 4 -\(bu -ToggleDecor -.TP 4 -\(bu -TakeToWorkspace <number> -.TP 4 -\(bu -TakeToNextWorkspace <offset> -.TP 4 -\(bu -TakeToPrevWorkspace <offset> -.TP 4 -\(bu -SendToWorkspace <number> -.TP 4 -\(bu -SendToNextWorkspace <offset> -.TP 4 -\(bu -SendToPrevWorkspace <offset> -.TP 4 -\(bu -KillWindow -.TP 4 -\(bu -NextTab -.TP 4 -\(bu -PrevTab -.TP 4 -\(bu -MoveTabLeft -.TP 4 -\(bu -MoveTabRight -.TP 4 -\(bu -DetachClient -.TP 4 -\(bu -SetAlpha [[\-]<int> [[\-]<int>]] -.SS "Workspace Commands" -.TP 4 -\(bu -NextWorkspace -.TP 4 -\(bu -PrevWorkspace -.TP 4 -\(bu -RightWorkspace <by\-number> -.TP 4 -\(bu -LeftWorkspace <by\-number> -.TP 4 -\(bu -Workspace <number> -.TP 4 -\(bu -NextWindow <bitmask> -.TP 4 -\(bu -PrevWindow <bitmask> -.TP 4 -\(bu -NextGroup <by\-number> -.TP 4 -\(bu -PrevGroup <by\-number> -.TP 4 -\(bu -FocusLeft -.TP 4 -\(bu -FocusRight -.TP 4 -\(bu -FocusUp -.TP 4 -\(bu -FocusDown -.TP 4 -\(bu -ArrangeWindows -.TP 4 -\(bu -ShowDesktop (Iconifies all windows) -.TP 4 -\(bu -Deiconify all|allworkspace|last|lastworkspace current|origin|originquiet -.TP 4 -\(bu -RootMenu -.TP 4 -\(bu -WorkspaceMenu -.TP 4 -\(bu -WindowMenu -.TP 4 -\(bu -HideMenu -.TP 4 -\(bu -CustomMenu <path_to_file> -.TP 4 -\(bu -SetWorkspaceName <name> -.SS "Special Commands" -.TP 4 -\(bu -MacroCmd -.TP 4 -\(bu -ToggleCmd -.TP 4 -\(bu -ReloadStyle -.TP 4 -\(bu -SetResourceValue <resourcename> <resource> value -.TP 4 -\(bu -BindKey <key><value>: <action> -.TP 4 -\(bu -KeyMode <keymode name> <return key sequence> -.TP 4 -\(bu -SetModKey <modifier> -.SS "Couple of things" -.TP 4 -\(bu -Exec: fluxbox utilizes /bin/sh to start the commands. This means, that you can use environment variables to do some tricks here. E.g: :Exec $XTERM This would fire up the term of your choice, if you set XTERM to something usefull -\fIbefore\fR -fluxbox starts, e.g. in the .fluxbox/startup file. -.TP 4 -\(bu -TakeToWorkspace: Will send you along with the window to the selected workspace. SendToWorkspace just sends the window. -.TP 4 -\(bu -TakeToNextWorkspace <offset>: Will send you and the window to workspace number <current offset>; that is, move you and the window <offset> spaces to the right (offset defaults to 1). SendToNextWorkspace does the same, except that it only sends the window (as for SendToWorkspace). TakeToPrevWorkspace and SendToPrevWorkspace work similarly, except moving to the previous workspaces, not the next ones. -.TP 4 -\(bu -PrevWindow/NextWindow parameters take an integer: 0 or unspecified = Default/current behavior \- most recently used. 1 = Groups instead of Windows \- only visit one tab in each group 2 = Skip stuck windows 4 = Skip shaded windows 8 = Switch between windows `linearly'; that is, if you repeatedly press the NextWindow key, you will walk through all windows in the, order that they were opened, instead of switching back and forth between the most recently focused windows. 16 = Skip iconified windows +.SH "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 \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 .sp .RS 4 -.nf -To combine any of these effects, add the corresponding numbers. -For instance, 14 means switch linearly, skipping stuck and shaded -windows, since 14 = 8 + 4 + 2. -.fi +\h'-04'\(bu\h'+03' +\fBClick To Focus\fR: click to focus windows .RE -.TP 4 -\(bu -Bindkey will append key string and action to your keys file and bind the key. -.TP 4 -\(bu -KeyMode allows you to have different keybindings that aren't all active at the same time. For instance, you can use `KeyMode Xnest' to switch to the `Xnest' key mode, which will disable all of your key bindings that don't have `Xnest: -\fI before them and will enable all the ones that do. <return key sequence> will then return you to the `default\fR -key mode. If not provided, this defaults to the escape key. -.TP 4 -\(bu -The -\fIdelta\fR -value means the difference between the current setting and the requested setting. So if you have a window that is 100 pixels wide, you could set .sp .RS 4 -.nf -Mod1 r :ResizeHorizontal 10 -.fi +\h'-04'\(bu\h'+03' +\fBMouse Focus\fR: window focus follows mouse .RE -and when you use that key it would increase the size of your window to 110 pixels. If you had used .sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBClickTabFocus\fR: click to focus tabs +.RE .sp .RS 4 -.nf -Mod1 R :ResizeHorizontal \-10 -.fi +\h'-04'\(bu\h'+03' +\fBMouseTabFocus\fR: tab focus follows mouse .RE -then it would have decreased the size by 10, setting it to 90 pixels. +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\. .sp -.TP 4 -\(bu -Resize commands do not necessarily change the number of pixels. For instance, many terminals will use the size of a character as the resize unit. Most applications, however, use pixels. -.TP 4 -\(bu -MacroCmd: +.SH "TAB OPTIONS" +This section of fluxbox configuration menu lets you configure many features of tabs\. Inside of it there are three main options: +.sp .sp .RS 4 -.nf -Mod1 r :MacroCmd {command1} {command2} -.fi -.RE +\h'-04'\(bu\h'+03' +\fBPlacement\fR: You can choose where the external tabs must be positioned\. The options are: .sp .RS 4 -.nf -allows you to execute more than one command with one keybinding. The commands -will be executed in serial. -.fi +\h'-04'\(bu\h'+03'Top Left: tabs are located on the left side of the top border of the window\. .RE -.TP 4 -\(bu -ToggleCmd: .sp .RS 4 -.nf -Mod1 t :ToggleCmd {command1} {command2} -.fi +\h'-04'\(bu\h'+03'Top Right: tabs are located on the right side of the top border of the window\. .RE .sp .RS 4 -.nf -alternates between the given commands each time you press Mod1 + t. -.fi +\h'-04'\(bu\h'+03'Left Top: tabs are located on the top part of the left border of the window\. .RE -.TP 4 -\(bu -SetAlpha [[\-]<int> [[\-]<int>]]: Works on the currently focussed window. Given +.sp .RS 4 -.TP 4 -\(bu -no arguments: reset to default alpha settings -.TP 4 -\(bu -one argument: changes both focused and unfocused alpha settings -.TP 4 -\(bu -two arguments: first value becomes the focused alpha, second becomes the unfocused alpha value. E.g: SetAlpha 127 +5 will set the focused alpha to 127 and increment the unfocused alpha by 5 (until it reaches 255) +\h'-04'\(bu\h'+03'Right Top: tabs are located on the top part of the right border of the window\. .RE -.SH "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: .sp +.RS 4 +\h'-04'\(bu\h'+03'Left Bottom: tabs are located on the bottom part of the left border of the window\. +.RE .sp .RS 4 -.nf -session.numLayers: <integer> -.fi +\h'-04'\(bu\h'+03'Right Bottom: tabs are located on the bottom part of the right border of the window\. .RE -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 -.TP 4 -\(bu -2 \- Above Dock -.TP 4 -\(bu -4 \- Dock -.TP 4 -\(bu -6 \- Top -.TP 4 -\(bu -8 \- Normal -.TP 4 -\(bu -10 \- Bottom -.TP 4 -\(bu -12 \- Desktop -The other way to set the layer for a window is through the `apps' file. This method is described in the APPLICATIONS section. +.RS 4 +\h'-04'\(bu\h'+03'Bottom Left: tabs are located on the left side of the bottom border of the window\. +.RE .sp -.SH "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 \fIfluxbox menu\fR in the Root Menu. +.RS 4 +\h'-04'\(bu\h'+03'Bottom Right: tabs are located on the right side of the bottom border of the window\. .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. +.RS 4 +.nf +For these options to work \'Tabs in Titlebar\' must be off\. +.fi +.RE +.RE +.RE .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: +.RS 4 +\h'-04'\(bu\h'+03' +\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 -.TP 4 -\(bu - -\fBClick To Focus\fR: click to focus windows -.TP 4 -\(bu - -\fBMouse Focus\fR: window focus follows mouse -.TP 4 -\(bu - -\fBClickTabFocus\fR: click to focus tabs -.TP 4 -\(bu - -\fBMouseTabFocus\fR: 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. -.sp -.SH "TAB OPTIONS" -This section of fluxbox configuration menu lets you configure many features of tabs. Inside of it there are three main options: -.sp -.TP 4 -\(bu - -\fBPlacement\fR: You can choose where the external tabs must be positioned. The options are: .RS 4 -.TP 4 -\(bu -Top Left: tabs are located on the left side of the top border of the window. -.TP 4 -\(bu -Top Right: tabs are located on the right side of the top border of the window. -.TP 4 -\(bu -Left Top: tabs are located on the top part of the left border of the window. -.TP 4 -\(bu -Right Top: tabs are located on the top part of the right border of the window. -.TP 4 -\(bu -Left Bottom: tabs are located on the bottom part of the left border of the window. -.TP 4 -\(bu -Right Bottom: tabs are located on the bottom part of the right border of the window. -.TP 4 -\(bu -Bottom Left: tabs are located on the left side of the bottom border of the window. -.TP 4 -\(bu -Bottom Right: tabs are located on the right side of the bottom border of the window. +\h'-04'\(bu\h'+03' +\fBMaximize Over\fR: When this option is on, maximizing a window will disregard the size and location of external tabs\. +.RE .sp .RS 4 -.nf -For these options to work 'Tabs in Titlebar' must be off. -.fi -.RE +\h'-04'\(bu\h'+03' +\fBExternal Tab Width\fR: This specifies in pixels the width of external tabs\. .RE -.TP 4 -\(bu - -\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. -.TP 4 -\(bu - -\fBMaximize Over\fR: When this option is on, maximizing a window will disregard the size and location of external tabs. -.TP 4 -\(bu - -\fBExternal Tab Width\fR: 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: +As with most Fluxbox configurations, these options can be changed by editing the init file\. The resources that you should look at are: .sp .sp .RS 4 .nf -session.screen0.tabs.intitlebar: <boolean> -session.screen0.tab.width: <integer> -session.screen0.tab.placement: <direction> +session\.screen0\.tabs\.intitlebar: <boolean> +session\.screen0\.tab\.width: <integer> +session\.screen0\.tab\.placement: <direction> .fi .RE .SH "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. +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 fluxstyle(1) to accommodate the growing number of style components. +The default installation of fluxbox provides some of these style files\. See fluxstyle(1) to accommodate the growing number of style components\. .sp .SH "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 fluxstyle(1). +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 fluxstyle(1)\. .sp .SH "APPLICATIONS" -It is possible to force an application to always have the same dimensions, position, and other settings when it is first launched. This is done using either the window\-menu `Remember\&...\fI submenu, or by directly using the ~/.fluxbox/apps file. Be careful about editing the apps file while fluxbox is running. Your changes may be overwritten. Following is a listing of the valid entries for the `apps\fR file. The `Remember\&...\fI submenu has entries for most options that store the current state in the `apps\fR file for future use. +It is possible to force an application to always have the same dimensions, position, and other settings when it is first launched\. This is done using either the window\-menu `Remember\&...\fI submenu, or by directly using the ~/\.fluxbox/apps file\. Be careful about editing the apps file while fluxbox is running\. Your changes may be overwritten\. Following is a listing of the valid entries for the `apps\fR file\. The `Remember\&...\fI submenu has entries for most options that store the current state in the `apps\fR file for future use\. .sp -The format of a line in the `apps' file is: +The format of a line in the `apps\' file is: .sp .sp .RS 4@@ -1545,11 +1249,11 @@ .nf
[app] (app\-name) {count \- optional} [Property1] {value1} [Property2] {value2} - ... + \.\.\. [end] .fi .RE -Each app\-name can be a string, or a regular expression. By default the name is matched against a window's WM_CLASS property (the first string in it, called the "instance"). You can match against the title, instance name (default), class name, or role (the WM_WINDOW_ROLE property) by explicitly specifying it. You can also specify multiple matches, which must ALL match for the properties to be applied. If a count is supplied in curly brackets at the end of the app line, then the entry will only match at most that many at any time (default is to match all matching windows). +Each app\-name can be a string, or a regular expression\. By default the name is matched against a window\'s WM_CLASS property (the first string in it, called the "instance")\. You can match against the title, instance name (default), class name, or role (the WM_WINDOW_ROLE property) by explicitly specifying it\. You can also specify multiple matches, which must ALL match for the properties to be applied\. If a count is supplied in curly brackets at the end of the app line, then the entry will only match at most that many at any time (default is to match all matching windows)\. .sp .sp .RS 4@@ -1563,75 +1267,88 @@ [app] (class=Firefox\-bin) {1}
# match the gaim buddy list window [app] (role=buddy_list) # match an rdesktop window to a particular host -[app] (title=rdesktop \- hostname.*) +[app] (title=rdesktop \- hostname\.*) # match gaim IRC windows -[app] (gaim) (title=#.*) +[app] (gaim) (title=#\.*) .fi .RE -The following are the properties that can be defined in each [app] entry. Each name must be enclosed in square brackets, and the value is generally in curly brackets: +The following are the properties that can be defined in each [app] entry\. Each name must be enclosed in square brackets, and the value is generally in curly brackets: .sp -.TP 4 -\(bu -[Workspace] {0\-N}: Forces the application to open on the workspace specified. Workspaces are set by number, beginning with 0. -.TP 4 -\(bu -[Dimensions] {Width Height}: Open the application with the specified width and height, in pixels. -.TP 4 -\(bu -[Position] (\fBrefspot\fR)) {X Y}: Position the application at a particular spot: +.sp +.RS 4 +\h'-04'\(bu\h'+03'[Workspace] {0\-N}: Forces the application to open on the workspace specified\. Workspaces are set by number, beginning with 0\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'[Dimensions] {Width Height}: Open the application with the specified width and height, in pixels\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'[Position] (\fBrefspot\fR)) {X Y}: Position the application at a particular spot: +.sp +.RS 4 +\h'-04'\(bu\h'+03'WINCENTER +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'CENTER +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'UPPERLEFT +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'UPPERRIGHT +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'LOWERLEFT +.RE +.sp .RS 4 -.TP 4 -\(bu -WINCENTER -.TP 4 -\(bu -CENTER -.TP 4 -\(bu -UPPERLEFT -.TP 4 -\(bu -UPPERRIGHT -.TP 4 -\(bu -LOWERLEFT -.TP 4 -\(bu -LOWERRIGHT +\h'-04'\(bu\h'+03'LOWERRIGHT .sp .RS 4 .nf -You can optionally specify what X and Y are relative to. By default the -upper left corner is placed at screen coordinates (X, Y). If you specify +You can optionally specify what X and Y are relative to\. By default the +upper left corner is placed at screen coordinates (X, Y)\. If you specify LOWERRIGHT, then the lower right corner of the window is positioned (X,Y) -pixels from the lower right of the screen. Note that CENTER puts the top +pixels from the lower right of the screen\. Note that CENTER puts the top left corner of the window relative to the center of the screen (WINCENTER acts like the rest \- positions the center of the window relative to the -center of the screen). +center of the screen)\. .fi .RE .RE -.TP 4 -\(bu -Specify the layer to open the window on (by number). Each layer has a number. The named ones are: 2\-AboveDock, 4\-Dock, 6\-Top, 8\-Normal, 10\-Bottom, 12\-Desktop. -.TP 4 -\(bu -[Shaded] {yes|no}: The window is started shaded, or not. -.TP 4 -\(bu -[Tab] {yes|no}: Whether this window can be tabbed with others. -.TP 4 -\(bu -[IconHidden] {yes|no}: Hides the app from the icon bar -.TP 4 -\(bu -[FocusHidden] {yes|no}: Hides the app from the window cycling list used Next/PrevWindow key bindings. -.TP 4 -\(bu -[Hidden] {yes|no}: is both [IconHidden] plus [FocusHidden] -.TP 4 -\(bu -[Deco] {NONE|NORMAL|TOOL|TINY|BORDER}: Specify the decoration state. There are several predefined dec\- oration sets: +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Specify the layer to open the window on (by number)\. Each layer has a number\. The named ones are: 2\-AboveDock, 4\-Dock, 6\-Top, 8\-Normal, 10\-Bottom, 12\-Desktop\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'[Shaded] {yes|no}: The window is started shaded, or not\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'[Tab] {yes|no}: Whether this window can be tabbed with others\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'[IconHidden] {yes|no}: Hides the app from the icon bar +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'[FocusHidden] {yes|no}: Hides the app from the window cycling list used Next/PrevWindow key bindings\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'[Hidden] {yes|no}: is both [IconHidden] plus [FocusHidden] +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'[Deco] {NONE|NORMAL|TOOL|TINY|BORDER}: Specify the decoration state\. There are several predefined dec\- oration sets: .sp .RS 4 .nf@@ -1645,50 +1362,55 @@ .RE
.sp .RS 4 .nf -A bitmask can also be used for fine\-grained control. The bits are (from +A bitmask can also be used for fine\-grained control\. The bits are (from "1" to 1<<10): titlebar, handle/grips, border, iconify button, maximize button, close button, menu enabled, sticky button, shade button, tabbing -enabled, focus enabled. +enabled, focus enabled\. .fi .RE -.TP 4 -\(bu -[Sticky] {yes|no}: Whether the window is initially stuck or not. -.TP 4 -\(bu -[Jump] {yes|no}: Jump to workspace. This one is only useful if `Workspace' is set too. The workspace is changed to the workspace containing the application being launched. -.TP 4 -\(bu -[Close] {yes|no}: Save settings on close. By default, application settings are not saved when a window is closed. Set this option if you want previous settings to be saved when the window is closed. -.TP 4 -\(bu -[Alpha] {int [int]} Where numbers represent focused and unfocused transparency, respectively. One number only will be used for both. -The apps file also allows you to specify applications that should be started only valid option is (screen=NN), where NN is the screen number on which the command should be run. +.RE .sp -Finally, you can set windows to group together by using the `apps' file. This can be achieved with regular expressions using: +.RS 4 +\h'-04'\(bu\h'+03'[Sticky] {yes|no}: Whether the window is initially stuck or not\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'[Jump] {yes|no}: Jump to workspace\. This one is only useful if `Workspace\' is set too\. The workspace is changed to the workspace containing the application being launched\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'[Close] {yes|no}: Save settings on close\. By default, application settings are not saved when a window is closed\. Set this option if you want previous settings to be saved when the window is closed\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'[Alpha] {int [int]} Where numbers represent focused and unfocused transparency, respectively\. One number only will be used for both\. +.RE +The apps file also allows you to specify applications that should be started only valid option is (screen=NN), where NN is the screen number on which the command should be run\. +.sp +Finally, you can set windows to group together by using the `apps\' file\. This can be achieved with regular expressions using: .sp .sp .RS 4 .nf -[app] (property=expr) ... {number} +[app] (property=expr) \.\.\. {number} .fi .RE Property can be one of the following tags: .sp o name \- the name of the window (the first field of WM_CLASS) o class \- class of the window (the second field of WM_CLASS) o title \- title of the window ( WM_NAME property) o role \- role of the window (the WM_WINDOW_ROLE property) .sp -If no `property' is specified, the name property is assumed. You can find out the value for these fields for a particular window by running xprop(1). +If no `property\' is specified, the name property is assumed\. You can find out the value for these fields for a particular window by running xprop(1)\. .sp -You can also place [group] tag around several [app] tags, with an [end] tag to indicate the end of the group. If you place (workspace) after the [group] tag, a new window will only get grouped with other windows on the current workspace. You can also specify dimensions, positions, etc. for the group as for normal app entries. Here is a short example of an `apps' file: +You can also place [group] tag around several [app] tags, with an [end] tag to indicate the end of the group\. If you place (workspace) after the [group] tag, a new window will only get grouped with other windows on the current workspace\. You can also specify dimensions, positions, etc\. for the group as for normal app entries\. Here is a short example of an `apps\' file: .sp .sp .RS 4 .nf [startup] {xterm} # match anything ending with term, up to 2 instances - [app] (.*[tT]erm) {2} - # match anything with `gaim' in the title - [app] (title=.*gaim.*) + [app] (\.*[tT]erm) {2} + # match anything with `gaim\' in the title + [app] (title=\.*gaim\.*) [app] (kate) [Dimensions] {1022 747} [Position] (WINCENTER) {0 0}@@ -1713,14 +1435,44 @@ [Layer] {4}
[end] .fi .RE -Parameters in the `apps' file are case\-sensitive. Application names are taken from the first X window WM_CLASS attribute by default (WM_NAME = title, WM_WINDOW_ROLE = role). You can see this attribute by using the xprop command. Transient windows are not affected by application settings. Take care when using regular expressions. If you are not familiar with regular expressions you can disable this feature by specifying \-\-disable\-regexp during configure. Plain strings will then be matched. +Parameters in the `apps\' file are case\-sensitive\. Application names are taken from the first X window WM_CLASS attribute by default (WM_NAME = title, WM_WINDOW_ROLE = role)\. You can see this attribute by using the xprop command\. Transient windows are not affected by application settings\. Take care when using regular expressions\. If you are not familiar with regular expressions you can disable this feature by specifying \-\-disable\-regexp during configure\. Plain strings will then be matched\. +.sp +.SH "GROUPS" +Since version 0\.1\.11, fluxbox has a feature called autogrouping, that is apps are automatically grouped together if they are in the same group\. NOTE: this feature is deprecated since version 0\.9\.1 in favor of grouping using the `apps\' file, since it is much more powerful\. +.sp +You can create groups simply by editing the ~/\.fluxbox/groups file\. This file takes the format of: +.sp +.sp +.RS 4 +.nf +<app1> <app2> <app3> <\.\.\.> <appN> +.fi +.RE +where elements can be found with this command: +.sp +.sp +.RS 4 +.nf +$> xprop WM_CLASS +.fi +.RE +Just type this command into a terminal and use the mouse to click on the desired app and it will tell you what to write as an element (use the first of the two names returned)\. Each line forms a different group, e\.g\.: +.sp +.sp +.RS 4 +.nf +Navigator nedit +xterm +.fi +.RE +This will create two groups, one with netscape and nedit, and one with xterm\. The new window will only group itself to other windows on the same workspace and to the last window that was focused\. .sp .SH "THE SLIT" -The slit is a special fluxbox window frame that can contain dockable applications, e.g. \fIbbtools\fR or \fIwmapps\fR. +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. +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: +Most dockable applications use the \-w option to run in the slit\. For example, you could put in your ~/\.xinitrc: .sp .sp .RS 4@@ -1731,70 +1483,77 @@ wmdrawer &
exec fluxbox .fi .RE -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. +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. +To use the slit you must have it compiled into fluxbox\. This is the default setting\. .sp .SH "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: +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 -.TP 4 -\(bu - -\fBPlacement\fR: This lets you set the position of the slit. -.TP 4 -\(bu - -\fBLayer\fR: Look above for the layer priorities. -.TP 4 -\(bu - -\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. -.TP 4 -\(bu - -\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. -.TP 4 -\(bu - -\fBAlpha\fR: By changing the value the slit (only the decoration not the apps in the slit) will become transparent. 0 (transparent) \- 255 (opaque) -.TP 4 -\(bu - -\fBSlit direction\fR: Changing the value will set the slit's direction for ordering apps sitting in the slit. There is no effect with only on application. -.TP 4 -\(bu - -\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). +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBPlacement\fR: This lets you set the position of the slit\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\fBLayer\fR: Look above for the layer priorities\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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 +\h'-04'\(bu\h'+03' +\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 +\h'-04'\(bu\h'+03' +\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 +\h'-04'\(bu\h'+03' +\fBSlit direction\fR: Changing the value will set the slit\'s direction for ordering apps sitting in the slit\. There is no effect with only on application\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03' +\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" -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 +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. +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. +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. +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: +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 .sp .RS 4 .nf -session.session0.slitlistFile: <filename> +session\.session0\.slitlistFile: <filename> .fi .RE .SH "ENVIRONMENT" .PP HOME .RS 4 -fluxbox uses HOME to find the .fluxbox/init file and to resolve style file and \-directory names. +fluxbox uses HOME to find the \.fluxbox/init file and to resolve style file and \-directory names\. .RE .PP DISPLAY .RS 4 -When no other display was given on the command line, fluxbox will start on the display specified by this variable. +When no other display was given on the command line, fluxbox will start on the display specified by this variable\. .RE -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 certain commands in the keys and menu files\. So one can do: .sp .sp .RS 4@@ -1802,50 +1561,61 @@ .nf
Mod1 x ExecCommand :$TERM .fi .RE -For more information about environment variables, see your shell's manual. +For more information about environment variables, see your shell\'s manual\. .sp .SH "SIGNALS" fluxbox responds to the following signals: .sp -.TP 4 -\(bu -SIGHUP fluxbox loads the configuration. -.TP 4 -\(bu -SIGUSR1 Forces reloading of configuration. -.TP 4 -\(bu -SIGUSR2 Forces reloading of menu file. +.sp +.RS 4 +\h'-04'\(bu\h'+03'SIGHUP fluxbox loads the configuration\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'SIGUSR1 Forces reloading of configuration\. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'SIGUSR2 Forces reloading of menu file\. +.RE .SH "AUTHOR AND CREDITS" -fluxbox is written and maintained by Henrik Kinnunen <fluxgen at fluxbox org>, Simon Bowden <rathnor at fluxbox org>, Mathias Gumz <akira at fluxbox org>, and Mark Tiefenbruck <mark at fluxbox org>, with contributions and patches merged from many individuals around the world. +fluxbox is written and maintained by Henrik Kinnunen <fluxgen at fluxbox org>, Simon Bowden <rathnor at fluxbox org>, Mathias Gumz <akira at fluxbox org>, and Mark Tiefenbruck <mark at fluxbox org>, with contributions and patches merged from many individuals around the world\. .sp -Blackbox was written and maintained by Brad Hughes <blackbox at alug org> and Jeff Raven <jraven at psu edu>. +Blackbox was written and maintained by Brad Hughes <blackbox at alug org> and Jeff Raven <jraven at psu edu>\. +.sp +The Official fluxbox website: http://www\.fluxbox\.org .sp -The Official fluxbox website: http://www.fluxbox.org +Many compatible themes: \- http://boxwhore\.org \- http://themes\.freshmeat\.net/ .sp This manpage is the combined work of: .sp -.TP 4 -\(bu -Curt Micol <asenchi at asenchi com> (>fluxbox\-0.9.11) -.TP 4 -\(bu -Tobias Klausmann <klausman at users sourceforge net> (<=fluxbox\-0.9.11) -.TP 4 -\(bu -Grubert <grubert at users sourceforge net> (fluxbox) -.TP 4 -\(bu -Matthew Hawkins <matt at mh dropbear id au> (blackbox) -.TP 4 -\(bu -Wilbert Berendsen <wbsoft at xs4all nl> (blackbox) -.TP 4 -\(bu -Numerous other languages could be available if someone jumps in. +.sp +.RS 4 +\h'-04'\(bu\h'+03'Curt Micol <asenchi at asenchi com> (>fluxbox\-0\.9\.11) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Tobias Klausmann <klausman at users sourceforge net> (⇐fluxbox\-0\.9\.11) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Grubert <grubert at users sourceforge net> (fluxbox) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Matthew Hawkins <matt at mh dropbear id au> (blackbox) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Wilbert Berendsen <wbsoft at xs4all nl> (blackbox) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Numerous other languages could be available if someone jumps in\. +.RE .SH "BUGS" -If you find any bugs, please visit the #fluxbox irc channel on irc.freenode.net or submit them to the bug tracker at http://sf.net/projects/fluxbox . Or you may subscribe to one of the mailinglists. More information can be found on the official website. +If you find any bugs, please visit the #fluxbox irc channel on irc\.freenode\.net or submit them to the bug tracker at http://sf\.net/projects/fluxbox \. Or you may subscribe to one of the mailinglists\. More information can be found on the official website\. .sp .SH "SEE ALSO" -bsetroot(1) fbsetbg(1) fbrun(1) fluxstyle(1) +fluxbox\-keys(5) bsetroot(1) fbsetbg(1) fbrun(1) fluxstyle(1) .sp