aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/fluxbox.1.in240
1 files changed, 96 insertions, 144 deletions
diff --git a/doc/fluxbox.1.in b/doc/fluxbox.1.in
index 7d3932e..d782154 100644
--- a/doc/fluxbox.1.in
+++ b/doc/fluxbox.1.in
@@ -54,7 +54,7 @@
54.if n .sp 1 54.if n .sp 1
55.if t .sp .5 55.if t .sp .5
56.. 56..
57.TH fluxbox 1 "December 9th, 2004" "0.9.11" 57.TH fluxbox 1 "August 16th, 2004" "0.9.9"
58.SH NAME 58.SH NAME
59fluxbox \- a window manager for X11 59fluxbox \- a window manager for X11
60.SH SYNOPSIS 60.SH SYNOPSIS
@@ -72,8 +72,8 @@ Fluxbox is built with C++, based on the sources of Blackbox 0.61.0.
72.BR Fast . 72.BR Fast .
73.PP 73.PP
74Fluxbox provides configurable window decorations, a root menu to launch 74Fluxbox provides configurable window decorations, a root menu to launch
75applications and a toolbar that shows the current workspace name, a set of 75applications and a toolbar that shows the current workspace name, the focused
76application names and the current time. 76application name and the current time.
77There is also a workspace menu to add or remove workspaces. The `slit' can be 77There is also a workspace menu to add or remove workspaces. The `slit' can be
78used to dock small applications, e.g. most of the bbtools can use the slit. 78used to dock small applications, e.g. most of the bbtools can use the slit.
79.PP 79.PP
@@ -83,13 +83,15 @@ A double-click on the titlebar of a window will shade it i.e. the window will
83disappear, only the titlebar stays visible. 83disappear, only the titlebar stays visible.
84.PP 84.PP
85Fluxbox uses its own graphics class to render its images on the fly. 85Fluxbox uses its own graphics class to render its images on the fly.
86By using style files, you can determine at a great level how your desktop looks.Fluxbox styles are compatible with those of Blackbox, so users migrating 86By using style files, you can determine at a great level how your desktop looks
87like. Fluxbox styles are compatible with those of Blackbox, so users migrating
87can still use their current favourite themes. 88can still use their current favourite themes.
88.PP 89.PP
89.\" TODO wmhints support 90.\" TODO wmhints support
90.\" TODO KDE2 GNome support 91.\" TODO KDE2 GNome support
91Fluxbox supports the majority of the Extended Window Manager Hints (EWMH) 92Currently KDE WM hints are not supported, but Fluxbox is already prepared to
92specification, as well as numerous other Window Hint standards. 93support the new window manager specification that is now being developed for
94both Gnome and KDE2.0.
93.SH OPTIONS 95.SH OPTIONS
94Fluxbox supports the following commandline options: 96Fluxbox supports the following commandline options:
95.TP 97.TP
@@ -124,9 +126,6 @@ exec fluxbox
124.EE 126.EE
125as the last executed command of the script. 127as the last executed command of the script.
126When Fluxbox terminates, the X session will terminate too. 128When Fluxbox terminates, the X session will terminate too.
127Another alternative is to use the
128.IR startfluxbox (1)
129script, which adds some more convenience features.
130.PP 129.PP
131When started, Fluxbox will try to find a default menufile in 130When started, Fluxbox will try to find a default menufile in
132.IR @pkgdatadir@/menu . 131.IR @pkgdatadir@/menu .
@@ -174,7 +173,7 @@ Using the wheel on workspace name or the clock switches the workspace, this
174could also be enabled for the whole desktop in the fluxbox menu. 173could also be enabled for the whole desktop in the fluxbox menu.
175.PP 174.PP
176When 175When
177.B workspace warping 176.B desktop warping
178is enabled, dragging a window outside the desktop will change to the next desktop. 177is enabled, dragging a window outside the desktop will change to the next desktop.
179.PP 178.PP
180Using the toolbar menu you can enter a name for the current workspace (when finished, 179Using the toolbar menu you can enter a name for the current workspace (when finished,
@@ -186,11 +185,11 @@ workspaces, Workspace Icons, Workspace -- all windows from Workspace, All Window
186from all workspaces. 185from all workspaces.
187.SS Layer 186.SS Layer
188Fluxbox manages following layers: Above Dock, Dock, Top, Normal, Bottom, Desktop. 187Fluxbox manages following layers: Above Dock, Dock, Top, Normal, Bottom, Desktop.
189The list is from top to bottom. Slit and toolbar can be assigned to 188Presumably the list is from top to bottom. Slit and toolbar can be assigned to
190a layer with the menu, applications might be assigned to a layer in the apps file, or by hand in the window menu. 189a layer with the menu, applications might be assigned to a layer in the apps file.
191.\" TODO the apps file has numbers for layers 190.\" TODO the apps file has numbers for layers
192.SS Focus Model 191.SS Focus Model
193The window that has the focus is the one that receives key and mouse events. 192The window that has the focus is the one that recieves keys and mouse events.
194The focus model is selectable via the Configuration menu. 193The focus model is selectable via the Configuration menu.
195.P 194.P
196For 195For
@@ -211,7 +210,7 @@ Middle clicking on border or titlebar will immediately lower the window.
211Right clicking on border or titlebar pops up the window menu, 210Right clicking on border or titlebar pops up the window menu,
212containing these commands: 211containing these commands:
213.TP 212.TP
214.B Send To... 213.B Send To... (in 0.9.7)
215Send window to another workspace. 214Send window to another workspace.
216When you select the workspace with the middle button, Fluxbox will 215When you select the workspace with the middle button, Fluxbox will
217send you along with the application to the selected workspace 216send you along with the application to the selected workspace
@@ -222,11 +221,11 @@ Shade the window (display titlebar only)
222.B Iconify 221.B Iconify
223Iconify window. 222Iconify window.
224The `icon' can be found in the `Icons' submenu of the workspace menu 223The `icon' can be found in the `Icons' submenu of the workspace menu
225as well as in the toolbar if a Toolbar mode showing Icons is selected. 224as well as in the toolbar.
226.TP 225.TP
227.B Maximize 226.B Maximize
228(Un)Maximize window. Depending on toolbar and slit configuration maximize 227(Un)Maximize window. Depending on toolbar and slit configuration maximize does
229covers the slit and toolbar or not. 228cover slit and toolbar or not.
230.TP 229.TP
231.B Button1 230.B Button1
232(usually left button) Maximize Normal, i.e. Vertical and Horizontal 231(usually left button) Maximize Normal, i.e. Vertical and Horizontal
@@ -235,7 +234,7 @@ covers the slit and toolbar or not.
235(Un)Maximize window only vertically. 234(Un)Maximize window only vertically.
236.TP 235.TP
237.B Button3 236.B Button3
238(Un)Maximize window only horizontally. 237(Un)Maximize window only horizontal.
239.TP 238.TP
240.B Raise 239.B Raise
241Raise window 240Raise window
@@ -245,13 +244,13 @@ Lower window
245.TP 244.TP
246.B Stick 245.B Stick
247(Un)Stick window. 246(Un)Stick window.
248A stuck window will be displayed on all workspaces. 247A stuck window will always be displayed in the current workspace
249.TP 248.TP
250.B Next Client 249.B Next Client
251Activate next client in this window's group. 250Activate next client in this window's group.
252.TP 251.TP
253.B Prev Client 252.B Prev Client
254Activate previous client in this window's group. 253Activate prev client in this window's group.
255.TP 254.TP
256.B Layer ... 255.B Layer ...
257Change the layer of this window. 256Change the layer of this window.
@@ -322,7 +321,7 @@ is needed.
322.PP 321.PP
323A menu reload can also be forced by sending SIGUSR2. 322A menu reload can also be forced by sending SIGUSR2.
324.SS Menu behaviour 323.SS Menu behaviour
325The behaviour of submenus in the menu can be configured in the 324The behaviour of the menu can be configured in the
326.I ~/.fluxbox/init 325.I ~/.fluxbox/init
327file, with the following entries: 326file, with the following entries:
328.TP 327.TP
@@ -353,14 +352,14 @@ required [begin] tag.
353.TP 352.TP
354.B [exec] (label for command) {shell command} 353.B [exec] (label for command) {shell command}
355Inserts a command item into the menu. 354Inserts a command item into the menu.
356When you select the menu item from the menu, Fluxbox runs `shell command'. 355When you select the menu item from the menu, Fluxbox runs `shell command.'
357.TP 356.TP
358.B [exit] (label for exit) 357.B [exit] (label for exit)
359Inserts an item that shuts down and exits Fluxbox. 358Inserts an item that shuts down and exits Fluxbox.
360Any open windows are reparented to the root window before Fluxbox exits. 359Any open windows are reparented to the root window before Fluxbox exits.
361.TP 360.TP
362.B [include] (filename) 361.B [include] (filename)
363Reads the file or directory 362Reads the file
364.I filename 363.I filename
365into the current menu. The file has to start with 364into the current menu. The file has to start with
366.IR [begin] 365.IR [begin]
@@ -516,7 +515,6 @@ one of the three extra keys on a pc104 branded with a sickening corporate logo.
516# Fluxbox keys file. 515# Fluxbox keys file.
517# Any line starting with a # is a comment. 516# Any line starting with a # is a comment.
518Mod1 Tab :NextWindow 517Mod1 Tab :NextWindow
519Mod1 Shift Tab :PrevWindow
520Mod1 F1 :Workspace 1 518Mod1 F1 :Workspace 1
521Mod1 F2 :Workspace 2 519Mod1 F2 :Workspace 2
522Mod1 F3 :Workspace 3 520Mod1 F3 :Workspace 3
@@ -537,7 +535,7 @@ Control n Mod1 n :NextTab
537As you can see from the last line, keybinds can be chained in a fashion similar 535As you can see from the last line, keybinds can be chained in a fashion similar
538to emacs keybindings. 536to emacs keybindings.
539 537
540Commands are case-insensitive, workspace numbering starts at "1", some commands 538Commands are caseinsensitive, workspace numbering starts at "1", some commands
541have synonyms, the space between the last key and the :Command is mandatory. 539have synonyms, the space between the last key and the :Command is mandatory.
542Possible Operations: 540Possible Operations:
543 541
@@ -618,6 +616,31 @@ SetResourceValue \fIresourcename\fR \fIresource value\fR
618BindKey \fIkey string : action\fR - this will append key string and 616BindKey \fIkey string : action\fR - this will append key string and
619 action to your keys file and bind the key 617 action to your keys file and bind the key
620.EE 618.EE
619.\" --- groups ---
620.SH GROUPS FILE
621Since version 0.1.11, Fluxbox has a feature called autogrouping, that is apps are
622automatically grouped together if they are in the same group.
623You can create groups simply by editing the
624.IR ~/.fluxbox/groups
625file.
626The file takes the format of:
627.EX
628<app1> <app2> <app3> ... <appN>
629.EE
630where elements can be found with this command:
631.EX
632xprop WM_CLASS
633.EE
634Just launch this command in a terminal and click on the desired app after. It will
635tell you what to write as element.
636Each line forms a different group, e.g:
637.EX
638Navigator nedit
639xterm
640.EE
641This will create two groups, one with netscape and nedit, and one with xterm.
642The new window will only group itself to other windows on the same workspace
643and to the last window that was focused.
621.SH THE SLIT 644.SH THE SLIT
622The slit is a special Fluxbox window frame that can contain dockable 645The slit is a special Fluxbox window frame that can contain dockable
623applications, e.g. the `bbtools.' 646applications, e.g. the `bbtools.'
@@ -797,21 +820,47 @@ When you run Fluxbox on an 8-bit display, you must set this resource to 4.
797Default value is 820Default value is
798.IR 4. 821.IR 4.
799.TP 822.TP
823.\" session.iconbar
800.B session.iconbar: 824.B session.iconbar:
801.IR True 825.IR True
802or 826or
803.IR False 827.IR False
804to enable or disable Fluxbox using the toolbar to display iconified windows. 828to enable or disable Fluxbox using the toolbar to display iconified windows.
805.TP 829.TP
806.B session.screen0.iconbar.alignment: 830.B session.*.iconbar.alignment:
807.IR LEFT, RELATIVE or RIGHT 831.IR LEFT ,
832.IR RELATIVE or
833.IR RIGHT
808can be changed in the iconbar mode menu. If LEFT or RIGHT is specified the 834can be changed in the iconbar mode menu. If LEFT or RIGHT is specified the
809iconbar buttons have a fixed with and are left/right aligned. 835iconbar buttons have a fixed with and are left/right aligned.
810.TP 836.TP
811.B session.screen0.iconbar.clientWidth: 837.B session.*.iconbar.clientWidth:
812.IR Integer 838.IR Integer
813is used to specify the iconbar button width for LEFT/RIGHT alignment. 839is used to specify the iconbar button width for LEFT/RIGHT alignment.
814.TP 840.TP
841.B session.*.iconbar.wheelMode:
842.IR On ,
843.IR Off or
844.IR Screen
845.EX
846On - enable mousewheeling on the iconbuttons
847Off - disables mousewheeling on the iconbuttons
848Screen - uses the settings of desktopWheeling
849.EE
850.TP
851.B session.*.iconbar.deiconifyMode:
852.IR Current ,
853.IR Follow or
854.IR SemiFollow
855.EX
856 Current - deiconifies the window on current workspace
857 Follow - deiconifies the window on the workspace it
858 was iconified from and jumps to that workspace
859 SemiFollow - acts as 'Current' for windows that were actually
860 iconified, and as 'follow' for the others
861.EE
862.TP
863.\" session.tabs
815.B session.tabs: 864.B session.tabs:
816.IR True 865.IR True
817or 866or
@@ -861,96 +910,46 @@ Sometimes, you want to force an application to have always the same dimensions,
861position, and other settings. It is now possible with the new window-submenu 910position, and other settings. It is now possible with the new window-submenu
862called 'Remember...'. Settings are saved in the 911called 'Remember...'. Settings are saved in the
863.I ~/.fluxbox/apps 912.I ~/.fluxbox/apps
864file. You don't have to edit the file yourself as most manipulations can be 913file. You don't have to edit the file yourself as all manipulations can be
865done using the 'Remember...' submenu. 914done using the 'Remember...' submenu.
866.PP
867The format of a line in the apps file is:
868.PP
869.nf
870[app] (app-name) {count - optional}
871 [Property1] {value1}
872 [Property2] {value2}
873 ...
874[end]
875.fi
876.PP
877Each
878.B app-name
879can be a string, or a regular expression. By default the name is matched
880against a windows
881.B WM_CLASS
882property (the first string in it, called the "instance"). You can
883match against the title, instance name (default), class name, or role
884(WM_WINDOW_ROLE property) by explicitly specifying it. You can also
885specify multiple matches, which must ALL match for the properties to be applied.
886If a count is supplied in curly brackets at the end of the app line, then
887the entry will only match at most count at any time (default is to match all matching windows).
888Some example
889.B [app]
890lines are:
891.PP
892.nf
893# match a standard xterm
894[app] (xterm)
895# match an xterm started like: xterm -name myshell
896[app] (myshell)
897# match any one Firefox window (the instance name is "Gecko")
898[app] (class=Firefox-bin) {1}
899# match the gaim buddy list window
900[app] (role=buddy_list)
901# match an rdesktop window to a particular host
902[app] (title=rdesktop - hostname.*)
903.fi
904
905.PP
906The following are the properties that can be defined in each
907.B [app]
908entry. Each name must be enclosed in square brackets, and the value
909is generally in curly brackets.
910
911.TP 915.TP
912.B Workspace {0-N} 916.B Workspace [0-N]
913Force the workspace of the application to be the current one, even if you launch 917Force the workspace of the application to be the current one, even if you launch
914the application from another workspace. 918the application from another workspace.
915.TP 919.TP
916.B Dimensions {Width Height} 920.B Dimensions [Width Height]
917Remember the current dimensions. 921Remember the current dimensions.
918.TP 922.TP
919.B Position ([WINCENTER|CENTER|UPPERLEFT|UPPERRIGHT|LOWERLEFT|LOWERRIGHT]) {X Y} 923.B Position ([WINCENTER|CENTER|UPPERLEFT|UPPERRIGHT|LOWERLEFT|LOWERRIGHT]) [X Y]
920Remember the current position. X and Y are relative to e.g. WINCENTER . Defaults to be relative to UPPERLEFT. 924Remember the current position. X and Y are relative to e.g. WINCENTER .
921.TP 925.TP
922.B Layer {Layernum} 926.B Shaded state [yes|no]
923Specify the layer to open the window on (by number). Each layer has a number. The named ones are:
9242-AboveDock, 4-Dock, 6-Top, 8-Normal, 10-Bottom, 12-Desktop.
925.TP
926.B Shaded {yes|no}
927Remember the current shaded state. 927Remember the current shaded state.
928.TP 928.TP
929.B Tab {yes|no} 929.B Tab state [yes|no]
930Remember the current tab state. 930Remember the current tab state.
931.TP 931.TP
932.B IconHidden {yes|no} 932.B IconHidden
933hides the app from the icon bar 933hides the app from the icon bar
934.TP 934.TP
935.B FocusHidden {yes|no} 935.B FocusHidden
936hides the app from the window cycling list to be reachable via Next/PrevWindow 936hides the app from the list to be reachable via Next/PrevWindow
937.TP 937.TP
938.B Hidden 938.B Hidden
939is [IconHidden] + [FocusHidden] 939is [IconHidden] + [FocusHidden]
940.TP 940.TP
941.B Deco {NONE|NORMAL|TOOL|TINY|bitmask} 941.B Decoration state [NONE|NORMAL|TOOL|TINY]
942Remember the current decoration state. There are several predefined decoration 942Remember the current decoration state.
943sets, but a bitmask can 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.
944.TP 943.TP
945.B Sticky {yes|no} 944.B Sticky state [yes|no]
946Remember the current sticky state. 945Remember the current sticky state.
947.TP 946.TP
948.B Jump {yes|no} 947.B Jump to workspace [yes|no]
949Jump to workspace - This one is only useful if 'Workspace' is set too. The workspace is changed 948This one is only useful if 'Workspace' is set too. The workspace is changed
950to the workspace containing the application being launched. 949to the workspace containing the application being launched.
951.TP 950.TP
952.B Close {yes|no} 951.B Save settings on close [yes|no]
953Save settings on close - By default, application settings are not saved when a window is closed. Set 952By default, application settings are not saved when a window is closed. Set
954this option if you want previous settings to be saved when the window is closed. 953this option if you want previous settings to be saved when the window is closed.
955.PP 954.PP
956The 955The
@@ -963,18 +962,6 @@ lines .
963could be used to specify the screen, not the workspace, on which 962could be used to specify the screen, not the workspace, on which
964the application should started. startup is not yet setable by menu. 963the application should started. startup is not yet setable by menu.
965 964
966.PP
967Finally, you can set windows to group together by using the
968.B apps-file
969. This is achieved by using a
970.B [group]
971tag around several
972.B [app]
973tags, with an
974.B [end]
975tag to indicate the end of the group. You can also specify dimensions, position
976etc for the group as for normal app entries.
977
978.SS Applications example 965.SS Applications example
979Here is a short example of an apps file: 966Here is a short example of an apps file:
980.PP 967.PP
@@ -991,49 +978,14 @@ Here is a short example of an apps file:
991 [Position] {16 0} 978 [Position] {16 0}
992 [Jump] {yes} 979 [Jump] {yes}
993[end] 980[end]
994# start all aterms with no decorations 981[app] (xterm)
995[app] (aterm)
996 [Deco] {NONE} 982 [Deco] {NONE}
997[end] 983[end]
998# a group with all windows called "special-term", appears on layer 4 (bottom)
999[group]
1000 [app] (special-term)
1001 [Layer] {4}
1002[end]
1003.fi 984.fi
1004 985
1005Parameters in the 'apps' file are case-sensitive. Application names are taken 986Parameters in the 'apps' file are case-sensitive. Application names are taken
1006from the first X-Window WM_CLASS attribute by default (WM_NAME = title, WM_WINDOW_ROLE = role). You can see these attributes by using 987from the first X-Window WM_CLASS attribute. You can see this attribute by using
1007the xprop command. Transient windows are not affected by application settings. 988the xprop command. Transient windows are not affected by application settings.
1008.\" --- groups ---
1009.SH GROUPS FILE
1010Since version 0.1.11, Fluxbox has a feature called autogrouping, that is apps are
1011automatically grouped together if they are in the same group.
1012Note that this feature is deprecated since version 0.9.1 in favour
1013of grouping using the apps file, since it is much more powerful.
1014.PP
1015You can create groups by editing the
1016.IR ~/.fluxbox/groups
1017file.
1018The file takes the format of:
1019.EX
1020<app1> <app2> <app3> ... <appN>
1021.EE
1022where elements can be found with this command:
1023.EX
1024xprop WM_CLASS
1025.EE
1026Just launch this command in a terminal and click on the desired app after. It will
1027tell you what to write as element.
1028Each line forms a different group, e.g:
1029.EX
1030Navigator nedit
1031xterm
1032.EE
1033This will create two groups, one with netscape and nedit, and one with xterm.
1034The new window will only group itself to other windows on the same workspace
1035and to the last window that was focused.
1036
1037.SH ENVIRONMENT 989.SH ENVIRONMENT
1038.TP 990.TP
1039.B HOME 991.B HOME