summaryrefslogtreecommitdiff
path: root/doc/fluxbox.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/fluxbox.1.in')
-rw-r--r--doc/fluxbox.1.in206
1 files changed, 140 insertions, 66 deletions
diff --git a/doc/fluxbox.1.in b/doc/fluxbox.1.in
index 8227599..eb9f83f 100644
--- a/doc/fluxbox.1.in
+++ b/doc/fluxbox.1.in
@@ -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, the focused 75applications and a toolbar that shows the current workspace name, a set of
76application name and the current time. 76application names 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,15 +83,13 @@ 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 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
87like. Fluxbox styles are compatible with those of Blackbox, so users migrating
88can still use their current favourite themes. 87can still use their current favourite themes.
89.PP 88.PP
90.\" TODO wmhints support 89.\" TODO wmhints support
91.\" TODO KDE2 GNome support 90.\" TODO KDE2 GNome support
92Currently KDE WM hints are not supported, but Fluxbox is already prepared to 91Fluxbox supports the majority of the Extended Window Manager Hints (EWMH)
93support the new window manager specification that is now being developed for 92specification, as well as numerous other Window Hint standards.
94both Gnome and KDE2.0.
95.SH OPTIONS 93.SH OPTIONS
96Fluxbox supports the following commandline options: 94Fluxbox supports the following commandline options:
97.TP 95.TP
@@ -126,6 +124,9 @@ exec fluxbox
126.EE 124.EE
127as the last executed command of the script. 125as the last executed command of the script.
128When Fluxbox terminates, the X session will terminate too. 126When 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.
129.PP 130.PP
130When started, Fluxbox will try to find a default menufile in 131When started, Fluxbox will try to find a default menufile in
131.IR @pkgdatadir@/menu . 132.IR @pkgdatadir@/menu .
@@ -173,7 +174,7 @@ Using the wheel on workspace name or the clock switches the workspace, this
173could also be enabled for the whole desktop in the fluxbox menu. 174could also be enabled for the whole desktop in the fluxbox menu.
174.PP 175.PP
175When 176When
176.B desktop warping 177.B workspace warping
177is enabled, dragging a window outside the desktop will change to the next desktop. 178is enabled, dragging a window outside the desktop will change to the next desktop.
178.PP 179.PP
179Using the toolbar menu you can enter a name for the current workspace (when finished, 180Using the toolbar menu you can enter a name for the current workspace (when finished,
@@ -185,11 +186,11 @@ workspaces, Workspace Icons, Workspace -- all windows from Workspace, All Window
185from all workspaces. 186from all workspaces.
186.SS Layer 187.SS Layer
187Fluxbox manages following layers: Above Dock, Dock, Top, Normal, Bottom, Desktop. 188Fluxbox manages following layers: Above Dock, Dock, Top, Normal, Bottom, Desktop.
188Presumably the list is from top to bottom. Slit and toolbar can be assigned to 189The list is from top to bottom. Slit and toolbar can be assigned to
189a layer with the menu, applications might be assigned to a layer in the apps file. 190a layer with the menu, applications might be assigned to a layer in the apps file, or by hand in the window menu.
190.\" TODO the apps file has numbers for layers 191.\" TODO the apps file has numbers for layers
191.SS Focus Model 192.SS Focus Model
192The window that has the focus is the one that recieves keys and mouse events. 193The window that has the focus is the one that receives key and mouse events.
193The focus model is selectable via the Configuration menu. 194The focus model is selectable via the Configuration menu.
194.P 195.P
195For 196For
@@ -210,7 +211,7 @@ Middle clicking on border or titlebar will immediately lower the window.
210Right clicking on border or titlebar pops up the window menu, 211Right clicking on border or titlebar pops up the window menu,
211containing these commands: 212containing these commands:
212.TP 213.TP
213.B Send To... (in 0.9.7) 214.B Send To...
214Send window to another workspace. 215Send window to another workspace.
215When you select the workspace with the middle button, Fluxbox will 216When you select the workspace with the middle button, Fluxbox will
216send you along with the application to the selected workspace 217send you along with the application to the selected workspace
@@ -221,11 +222,11 @@ Shade the window (display titlebar only)
221.B Iconify 222.B Iconify
222Iconify window. 223Iconify window.
223The `icon' can be found in the `Icons' submenu of the workspace menu 224The `icon' can be found in the `Icons' submenu of the workspace menu
224as well as in the toolbar. 225as well as in the toolbar if a Toolbar mode showing Icons is selected.
225.TP 226.TP
226.B Maximize 227.B Maximize
227(Un)Maximize window. Depending on toolbar and slit configuration maximize does 228(Un)Maximize window. Depending on toolbar and slit configuration maximize
228cover slit and toolbar or not. 229covers the slit and toolbar or not.
229.TP 230.TP
230.B Button1 231.B Button1
231(usually left button) Maximize Normal, i.e. Vertical and Horizontal 232(usually left button) Maximize Normal, i.e. Vertical and Horizontal
@@ -234,7 +235,7 @@ cover slit and toolbar or not.
234(Un)Maximize window only vertically. 235(Un)Maximize window only vertically.
235.TP 236.TP
236.B Button3 237.B Button3
237(Un)Maximize window only horizontal. 238(Un)Maximize window only horizontally.
238.TP 239.TP
239.B Raise 240.B Raise
240Raise window 241Raise window
@@ -244,13 +245,13 @@ Lower window
244.TP 245.TP
245.B Stick 246.B Stick
246(Un)Stick window. 247(Un)Stick window.
247A stuck window will always be displayed in the current workspace 248A stuck window will be displayed on all workspaces.
248.TP 249.TP
249.B Next Client 250.B Next Client
250Activate next client in this window's group. 251Activate next client in this window's group.
251.TP 252.TP
252.B Prev Client 253.B Prev Client
253Activate prev client in this window's group. 254Activate previous client in this window's group.
254.TP 255.TP
255.B Layer ... 256.B Layer ...
256Change the layer of this window. 257Change the layer of this window.
@@ -321,7 +322,7 @@ is needed.
321.PP 322.PP
322A menu reload can also be forced by sending SIGUSR2. 323A menu reload can also be forced by sending SIGUSR2.
323.SS Menu behaviour 324.SS Menu behaviour
324The behaviour of the menu can be configured in the 325The behaviour of submenus in the menu can be configured in the
325.I ~/.fluxbox/init 326.I ~/.fluxbox/init
326file, with the following entries: 327file, with the following entries:
327.TP 328.TP
@@ -352,14 +353,14 @@ required [begin] tag.
352.TP 353.TP
353.B [exec] (label for command) {shell command} 354.B [exec] (label for command) {shell command}
354Inserts a command item into the menu. 355Inserts a command item into the menu.
355When you select the menu item from the menu, Fluxbox runs `shell command.' 356When you select the menu item from the menu, Fluxbox runs `shell command'.
356.TP 357.TP
357.B [exit] (label for exit) 358.B [exit] (label for exit)
358Inserts an item that shuts down and exits Fluxbox. 359Inserts an item that shuts down and exits Fluxbox.
359Any open windows are reparented to the root window before Fluxbox exits. 360Any open windows are reparented to the root window before Fluxbox exits.
360.TP 361.TP
361.B [include] (filename) 362.B [include] (filename)
362Reads the file 363Reads the file or directory
363.I filename 364.I filename
364into the current menu. The file has to start with 365into the current menu. The file has to start with
365.IR [begin] 366.IR [begin]
@@ -515,6 +516,7 @@ one of the three extra keys on a pc104 branded with a sickening corporate logo.
515# Fluxbox keys file. 516# Fluxbox keys file.
516# Any line starting with a # is a comment. 517# Any line starting with a # is a comment.
517Mod1 Tab :NextWindow 518Mod1 Tab :NextWindow
519Mod1 Shift Tab :PrevWindow
518Mod1 F1 :Workspace 1 520Mod1 F1 :Workspace 1
519Mod1 F2 :Workspace 2 521Mod1 F2 :Workspace 2
520Mod1 F3 :Workspace 3 522Mod1 F3 :Workspace 3
@@ -535,7 +537,7 @@ Control n Mod1 n :NextTab
535As you can see from the last line, keybinds can be chained in a fashion similar 537As you can see from the last line, keybinds can be chained in a fashion similar
536to emacs keybindings. 538to emacs keybindings.
537 539
538Commands are caseinsensitive, workspace numbering starts at "1", some commands 540Commands are case-insensitive, workspace numbering starts at "1", some commands
539have synonyms, the space between the last key and the :Command is mandatory. 541have synonyms, the space between the last key and the :Command is mandatory.
540Possible Operations: 542Possible Operations:
541 543
@@ -616,31 +618,6 @@ SetResourceValue \fIresourcename\fR \fIresource value\fR
616BindKey \fIkey string : action\fR - this will append key string and 618BindKey \fIkey string : action\fR - this will append key string and
617 action to your keys file and bind the key 619 action to your keys file and bind the key
618.EE 620.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.
644.SH THE SLIT 621.SH THE SLIT
645The slit is a special Fluxbox window frame that can contain dockable 622The slit is a special Fluxbox window frame that can contain dockable
646applications, e.g. the `bbtools.' 623applications, e.g. the `bbtools.'
@@ -884,46 +861,96 @@ Sometimes, you want to force an application to have always the same dimensions,
884position, and other settings. It is now possible with the new window-submenu 861position, and other settings. It is now possible with the new window-submenu
885called 'Remember...'. Settings are saved in the 862called 'Remember...'. Settings are saved in the
886.I ~/.fluxbox/apps 863.I ~/.fluxbox/apps
887file. You don't have to edit the file yourself as all manipulations can be 864file. You don't have to edit the file yourself as most manipulations can be
888done using the 'Remember...' submenu. 865done 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
889.TP 911.TP
890.B Workspace [0-N] 912.B Workspace {0-N}
891Force the workspace of the application to be the current one, even if you launch 913Force the workspace of the application to be the current one, even if you launch
892the application from another workspace. 914the application from another workspace.
893.TP 915.TP
894.B Dimensions [Width Height] 916.B Dimensions {Width Height}
895Remember the current dimensions. 917Remember the current dimensions.
896.TP 918.TP
897.B Position ([WINCENTER|CENTER|UPPERLEFT|UPPERRIGHT|LOWERLEFT|LOWERRIGHT]) [X Y] 919.B Position ([WINCENTER|CENTER|UPPERLEFT|UPPERRIGHT|LOWERLEFT|LOWERRIGHT]) {X Y}
898Remember the current position. X and Y are relative to e.g. WINCENTER . 920Remember the current position. X and Y are relative to e.g. WINCENTER . Defaults to be relative to UPPERLEFT.
921.TP
922.B Layer {Layernum}
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.
899.TP 925.TP
900.B Shaded state [yes|no] 926.B Shaded {yes|no}
901Remember the current shaded state. 927Remember the current shaded state.
902.TP 928.TP
903.B Tab state [yes|no] 929.B Tab {yes|no}
904Remember the current tab state. 930Remember the current tab state.
905.TP 931.TP
906.B IconHidden 932.B IconHidden {yes|no}
907hides the app from the icon bar 933hides the app from the icon bar
908.TP 934.TP
909.B FocusHidden 935.B FocusHidden {yes|no}
910hides the app from the list to be reachable via Next/PrevWindow 936hides the app from the window cycling list to be reachable via Next/PrevWindow
911.TP 937.TP
912.B Hidden 938.B Hidden
913is [IconHidden] + [FocusHidden] 939is [IconHidden] + [FocusHidden]
914.TP 940.TP
915.B Decoration state [NONE|NORMAL|TOOL|TINY] 941.B Deco {NONE|NORMAL|TOOL|TINY|bitmask}
916Remember the current decoration state. 942Remember the current decoration state. There are several predefined decoration
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.
917.TP 944.TP
918.B Sticky state [yes|no] 945.B Sticky {yes|no}
919Remember the current sticky state. 946Remember the current sticky state.
920.TP 947.TP
921.B Jump to workspace [yes|no] 948.B Jump {yes|no}
922This one is only useful if 'Workspace' is set too. The workspace is changed 949Jump to workspace - This one is only useful if 'Workspace' is set too. The workspace is changed
923to the workspace containing the application being launched. 950to the workspace containing the application being launched.
924.TP 951.TP
925.B Save settings on close [yes|no] 952.B Close {yes|no}
926By default, application settings are not saved when a window is closed. Set 953Save settings on close - By default, application settings are not saved when a window is closed. Set
927this option if you want previous settings to be saved when the window is closed. 954this option if you want previous settings to be saved when the window is closed.
928.PP 955.PP
929The 956The
@@ -936,6 +963,18 @@ lines .
936could be used to specify the screen, not the workspace, on which 963could be used to specify the screen, not the workspace, on which
937the application should started. startup is not yet setable by menu. 964the application should started. startup is not yet setable by menu.
938 965
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
939.SS Applications example 978.SS Applications example
940Here is a short example of an apps file: 979Here is a short example of an apps file:
941.PP 980.PP
@@ -952,14 +991,49 @@ Here is a short example of an apps file:
952 [Position] {16 0} 991 [Position] {16 0}
953 [Jump] {yes} 992 [Jump] {yes}
954[end] 993[end]
955[app] (xterm) 994# start all aterms with no decorations
995[app] (aterm)
956 [Deco] {NONE} 996 [Deco] {NONE}
957[end] 997[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]
958.fi 1003.fi
959 1004
960Parameters in the 'apps' file are case-sensitive. Application names are taken 1005Parameters in the 'apps' file are case-sensitive. Application names are taken
961from the first X-Window WM_CLASS attribute. You can see this attribute by using 1006from the first X-Window WM_CLASS attribute by default (WM_NAME = title, WM_WINDOW_ROLE = role). You can see these attributes by using
962the xprop command. Transient windows are not affected by application settings. 1007the 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
963.SH ENVIRONMENT 1037.SH ENVIRONMENT
964.TP 1038.TP
965.B HOME 1039.B HOME