summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/fluxbox.1.in104
1 files changed, 89 insertions, 15 deletions
diff --git a/doc/fluxbox.1.in b/doc/fluxbox.1.in
index 531f6ed..11d99d6 100644
--- a/doc/fluxbox.1.in
+++ b/doc/fluxbox.1.in
@@ -24,6 +24,8 @@
24.\" 24.\"
25.\" Updated for version 0.1.7.1 by Stanislav Karchebny <berk@madfire.net> 25.\" Updated for version 0.1.7.1 by Stanislav Karchebny <berk@madfire.net>
26.\" 26.\"
27.\" Updated for version 0.1.15 by Tobias Klausmann <klausman@users.sourceforge.net>
28.\"
27.\" ..define sort of <blockquote><pre> macro 29.\" ..define sort of <blockquote><pre> macro
28.de EX 30.de EX
29.ne 5 31.ne 5
@@ -38,7 +40,7 @@
38.if n .sp 1 40.if n .sp 1
39.if t .sp .5 41.if t .sp .5
40.. 42..
41.TH fluxbox 1 "December 10th, 2001" "0.5.1" 43.TH fluxbox 1 "December 15th, 2002" "0.1.15"
42.SH NAME 44.SH NAME
43fluxbox \- a window manager for X11 45fluxbox \- a window manager for X11
44.SH SYNOPSIS 46.SH SYNOPSIS
@@ -53,7 +55,7 @@ fluxbox \- a window manager for X11
53Fluxbox is yet another addition to the list of window managers for the Open 55Fluxbox is yet another addition to the list of window managers for the Open
54Group's X Window System, Version 11 Release 6 and above. 56Group's X Window System, Version 11 Release 6 and above.
55Fluxbox is built with C++, based on the sources of Blackbox 0.61.0. 57Fluxbox is built with C++, based on the sources of Blackbox 0.61.0.
56.BR fast . 58.BR Fast .
57.PP 59.PP
58Fluxbox provides configurable window decorations, a root menu to launch 60Fluxbox provides configurable window decorations, a root menu to launch
59applications and a toolbar that shows the current workspace name, the focused 61applications and a toolbar that shows the current workspace name, the focused
@@ -110,11 +112,10 @@ On exit or restart, Fluxbox will save user defaults in the file
110in the user's home directory. 112in the user's home directory.
111Some resources in this file can be edited by hand. 113Some resources in this file can be edited by hand.
112.SH USING FLUXBOX 114.SH USING FLUXBOX
113Fluxbox includes keyboard handling. 0.1.4 integrated 115Fluxbox includes keyboard handling. In order to customize your keybindings,
114.IR bbkeys (1) 116edit the file
115however from version 0.1.5 the whole keyboard handling code was rewritten 117.I ~/.fluxbox/keys
116from scratch. You can get a script to convert your bbkeys file into fluxbox 118as described below in the section KEYS FILE.
117format at the fluxbox webpage, http://fluxbox.sourceforge.net/.
118.SS Root window (background): 119.SS Root window (background):
119Right click (button 3) will pop up the root menu. 120Right click (button 3) will pop up the root menu.
120With this you can launch your applications. 121With this you can launch your applications.
@@ -276,7 +277,7 @@ which will be expanded into your home directory (e.g.
276[include] (~/fluxbox/stylesmenu) 277[include] (~/fluxbox/stylesmenu)
277.EE 278.EE
278will include 279will include
279.I /home/fluxgen/fluxbox/stylesmenu 280.I /home/yourusername/fluxbox/stylesmenu
280in my menu). 281in my menu).
281.TP 282.TP
282.B [nop] (label - optional) 283.B [nop] (label - optional)
@@ -323,6 +324,9 @@ the new menu's title is the same as the item label.
323An 324An
324.B [end] 325.B [end]
325tag is required to end the submenu. 326tag is required to end the submenu.
327.IP
328If you create a submenu labelled 'Startup', applications located in this
329submenu will be launched on fluxbox startup.
326.TP 330.TP
327.B [reconfig] (label) 331.B [reconfig] (label)
328When selected, this item rereads the current style and menu files and 332When selected, this item rereads the current style and menu files and
@@ -361,7 +365,7 @@ Here is a short example of a menu file:
361.PP 365.PP
362.nf 366.nf
363# Fluxbox menu file 367# Fluxbox menu file
364[begin] (Fluxbox 0.5.1) 368[begin] (Fluxbox)
365 [exec] (rxvt) {rxvt -ls} 369 [exec] (rxvt) {rxvt -ls}
366 [exec] (netscape) {netscape -install} 370 [exec] (netscape) {netscape -install}
367 [exec] (The GIMP) {gimp} 371 [exec] (The GIMP) {gimp}
@@ -375,6 +379,12 @@ Here is a short example of a menu file:
375 [exec] (edit) {mozilla -edit} 379 [exec] (edit) {mozilla -edit}
376 [exec] (compose) {mozilla -compose} 380 [exec] (compose) {mozilla -compose}
377 [end] 381 [end]
382 [submenu] (Startup)
383 [exec] (gkrellm) {gkrellm -w}
384 [exec] (xmms) {xmms -p}
385 [exec] (galeon) {galeon -s}
386 [exec] (kdeinit) {kdeinit}
387 [end]
378 [submenu] (Window Manager) 388 [submenu] (Window Manager)
379 [exec] (Edit Menus) {nedit ~/.fluxbox/menu} 389 [exec] (Edit Menus) {nedit ~/.fluxbox/menu}
380 [submenu] (Style) {Which Style?} 390 [submenu] (Style) {Which Style?}
@@ -702,7 +712,7 @@ can easily set lots of keys with a single command, e.g.
702.EE 712.EE
703This sets already nice defaults for many components. 713This sets already nice defaults for many components.
704.SH KEYS FILE 714.SH KEYS FILE
705Since version 0.1.5, Fluxbox has new keybinding code, and you can customise it through the 715You can customise Fluxbox' key handling through the
706.IR ~/.fluxbox/keys 716.IR ~/.fluxbox/keys
707file. The file takes the format of : 717file. The file takes the format of :
708.EX 718.EX
@@ -844,8 +854,8 @@ A simple procedure for getting the slit sequences the way you like it is:
8443) Re-add dockapps to your auto-run script, e.g. .xinitrc or .xsession. Order doesn't matter here! 8543) Re-add dockapps to your auto-run script, e.g. .xinitrc or .xsession. Order doesn't matter here!
845.EE 855.EE
846This sequence will be saved by default to 856This sequence will be saved by default to
847.IR~/.fluxbox/slitlist 857.IR ~/.fluxbox/slitlist
848should be maintained in future fluxbox sessions. 858and will be maintained in future fluxbox sessions.
849.PP 859.PP
850Users are free to manually edit the slitlist file. It is a simple list of window names, 860Users are free to manually edit the slitlist file. It is a simple list of window names,
851one per dockapp. Similar to the init file it should be edited while not running fluxbox. 861one per dockapp. Similar to the init file it should be edited while not running fluxbox.
@@ -1069,6 +1079,66 @@ session.screen1.strftimeFormat: %a %d %R [%s]
1069This way the main workspace (screen0) has the maximum amount of space available 1079This way the main workspace (screen0) has the maximum amount of space available
1070and the secondary workspace could show the time and run some withrawn apps like 1080and the secondary workspace could show the time and run some withrawn apps like
1071gkrellm in the slit, always visible yet out of the way of real work. 1081gkrellm in the slit, always visible yet out of the way of real work.
1082.SH APPLICATIONS SETTINGS
1083Sometimes, you want to force an application to have always the same dimensions,
1084position, and other settings. It is now possible with the new window-submenu
1085called 'Remember...'. Settings are saved in the
1086.I ~/.fluxbox/apps
1087file. You don't have to edit the file yourself as all manipulations can be
1088done using the 'Remember...' submenu.
1089.TP
1090.B Workspace [0-N]
1091Force the workspace of the application to be the current one, even if you launch
1092the application from another workspace.
1093.TP
1094.B Dimensions [Width Height]
1095Remember the current dimensions.
1096.TP
1097.B Position [X Y]
1098Remember the current position.
1099.TP
1100.B Shaded state [yes|no]
1101Remember the current shaded state.
1102.TP
1103.B Tab state [yes|no]
1104Remember the current tab state.
1105.TP
1106.B Decoration state [NONE|NORMAL|TOOL|TINY]
1107Remember the current decoration state.
1108.TP
1109.B Sticky state [yes|no]
1110Remember the current sticky state.
1111.TP
1112.B Jump to workspace [yes|no]
1113This one is only useful if 'Workspace' is set too. The workspace is changed
1114to the workspace containing the application being launched.
1115.TP
1116.B Save settings on close [yes|no]
1117By default, application settings are not saved when a window is closed. Set
1118this option if you want previous settings to be saved when the window is closed.
1119.SS Applications example
1120Here is a short example of an apps file:
1121.PP
1122.nf
1123[app] (kate)
1124 [Dimensions] {1022 747}
1125 [Position] {0 0}
1126 [Close] {yes}
1127[end]
1128[app] (konqueror)
1129 [Workspace] {1}
1130 [Dimensions] {1006 749}
1131 [Position] {16 0}
1132 [Jump] {yes}
1133[end]
1134[app] (xterm)
1135 [Deco] {NONE}
1136[end]
1137.fi
1138
1139Parameters in the 'apps' file are case-sensitive. Application names are taken
1140from the first X-Window WM_CLASS attribute. You can see this attribute by using
1141the xprop command. Transient windows are not affected by application settings.
1072.SH ENVIRONMENT 1142.SH ENVIRONMENT
1073.TP 1143.TP
1074.B HOME 1144.B HOME
@@ -1104,7 +1174,7 @@ The Official Fluxbox website:
1104.br 1174.br
1105Many compatible themes: 1175Many compatible themes:
1106.nh 1176.nh
1107.B http://www.themes.org/themes/blackbox/ 1177.B http://themes.freshmeat.net/
1108.hy 1178.hy
1109.PP 1179.PP
1110This manpage was put together by Matthew Hawkins 1180This manpage was put together by Matthew Hawkins
@@ -1113,9 +1183,13 @@ This manpage was put together by Matthew Hawkins
1113.hy 1183.hy
1114from the original Blackbox man page by Wilbert Berendsen 1184from the original Blackbox man page by Wilbert Berendsen
1115.nh 1185.nh
1116(wbsoft@xs4all.nl). 1186(wbsoft@xs4all.nl)
1187.hy
1188and subsequently hacked upon by Tobias Klausmann
1189.nh
1190(klausman@users.sourceforge.net)
1117.hy 1191.hy
1118Numerous other languages will be available. 1192Numerous other languages will be available.
1119.SH SEE ALSO 1193.SH SEE ALSO
1120.IR bsetroot (1), \ bbkeys (1) \" not there, yet ;-( 1194.IR bsetroot (1) \" not there, yet ;-(
1121 1195