aboutsummaryrefslogtreecommitdiff
path: root/doc/asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/asciidoc')
-rw-r--r--doc/asciidoc/fluxbox.txt117
1 files changed, 72 insertions, 45 deletions
diff --git a/doc/asciidoc/fluxbox.txt b/doc/asciidoc/fluxbox.txt
index a45c432..b05cc14 100644
--- a/doc/asciidoc/fluxbox.txt
+++ b/doc/asciidoc/fluxbox.txt
@@ -60,7 +60,7 @@ STARTING FLUXBOX
60fluxbox(1) comes with a program called startfluxbox(8) usually located wherever 60fluxbox(1) comes with a program called startfluxbox(8) usually located wherever
61you installed fluxbox. This script provides you with many options and 61you installed fluxbox. This script provides you with many options and
62variables that can be set when starting fluxbox. To actually call fluxbox and 62variables that can be set when starting fluxbox. To actually call fluxbox and
63begin using it, you should place "exec startfluxbox" in your ~/.xinitrc or 63begin using it, you should place "exec startfluxbox" in your ~/.xinitrc or
64~/.xsession (depending on your distributions and/or display manager) as the 64~/.xsession (depending on your distributions and/or display manager) as the
65last executed command. This is assuming that the location of fluxbox(1) and 65last executed command. This is assuming that the location of fluxbox(1) and
66startfluxbox(8) are in your shell's $PATH. Also note that you may need to 66startfluxbox(8) are in your shell's $PATH. Also note that you may need to
@@ -83,7 +83,7 @@ USING FLUXBOX
83When using fluxbox for the first time, users who are more accustomed to 83When using fluxbox for the first time, users who are more accustomed to
84full desktop environments such as KDE or Gnome may be a little surprised by 84full desktop environments such as KDE or Gnome may be a little surprised by
85the minimal screen content. fluxbox is designed to be fast and powerful, so it 85the minimal screen content. fluxbox is designed to be fast and powerful, so it
86may take a bit of getting used to -- however, the rewards are worthwhile. 86may take a bit of getting used to -- however, the rewards are worthwhile.
87user. 87user.
88We'll give a quick summary of the common things in this section. However, we 88We'll give a quick summary of the common things in this section. However, we
89recommend that you consult the referenced sections of this manual to further 89recommend that you consult the referenced sections of this manual to further
@@ -93,7 +93,7 @@ Root Window (Main)
93~~~~~~~~~~~~~~~~~~ 93~~~~~~~~~~~~~~~~~~
94Looking at the fluxbox desktop immediately after startup you'll generally 94Looking at the fluxbox desktop immediately after startup you'll generally
95see only one thing: The toolbar. If you were to right click (mouse button 95see only one thing: The toolbar. If you were to right click (mouse button
963) somewhere else blank, you would be able to access the RootMenu, a 963) somewhere else blank, you would be able to access the RootMenu, a
97middle click (mouse button 2) on the desktop shows you the WorkspaceMenu. 97middle click (mouse button 2) on the desktop shows you the WorkspaceMenu.
98 98
99RootMenu and WorkspaceMenu 99RootMenu and WorkspaceMenu
@@ -183,8 +183,8 @@ its titlebar you can press (and hold!)
183 ALT + Left Mousebutton (mouse button 1) 183 ALT + Left Mousebutton (mouse button 1)
184 184
185and move it anywhere in the current workspace. This key combination can 185and move it anywhere in the current workspace. This key combination can
186also be used to raise a partially visible window. 186also be used to raise a partially visible window.
187 187
188The key combination 188The key combination
189 189
190 ALT + Right Mousebutton (mouse button 3) 190 ALT + Right Mousebutton (mouse button 3)
@@ -194,6 +194,16 @@ resource file with:
194 194
195 session.session0.useMod1: <boolean> 195 session.session0.useMod1: <boolean>
196 196
197You can also alter how resizing is done. By default, you drag the
198bottom right corner. You can drag the corner closest to the mouse
199pointer instead if you set
200
201 session.screen0.resizeMode: Quadrant
202
203or all corners at the same time if you set it to:
204
205 session.screen0.resizeMode: Center
206
197MENUS 207MENUS
198----- 208-----
199fluxbox installs a default menu file in @pkgdatadir@/menu. You 209fluxbox installs a default menu file in @pkgdatadir@/menu. You
@@ -204,7 +214,7 @@ menu file in ~/.fluxbox . Once you've created your own menu file, you'll want
204to make sure that you properly declare this location in your `init' file so 214to make sure that you properly declare this location in your `init' file so
205that fluxbox knows where to look. The value you'll want to add or change is: 215that fluxbox knows where to look. The value you'll want to add or change is:
206 216
207 session.session0.menuFile: <menufile> 217 session.menuFile: <menufile>
208 218
209For this change to take effect, fluxbox must be restarted. Be sure that your 219For this change to take effect, fluxbox must be restarted. Be sure that your
210menu is usable, then choose `Restart' from the default fluxbox root menu. 220menu is usable, then choose `Restart' from the default fluxbox root menu.
@@ -272,37 +282,37 @@ if not all, of those here.
272Configuration Menu 282Configuration Menu
273~~~~~~~~~~~~~~~~~~ 283~~~~~~~~~~~~~~~~~~
274This menu offers the opportunity to set up fluxbox. It ca also achieved by 284This menu offers the opportunity to set up fluxbox. It ca also achieved by
275editing the init file, but this is a easier and faster way to most users. 285editing the init file, but this is a easier and faster way to most users.
276 286
277- *Focus Model*: 287- *Focus Model*:
278 Please read the FOCUS MODEL section at the end of this manual. 288 Please read the FOCUS MODEL section at the end of this manual.
279 289
280- *Slit*: 290- *Slit*:
281 This Menu can be opend by right clicking the slit (if visible). 291 This Menu can be opend by right clicking the slit (if visible).
282 292
283- *Placement*: 293- *Placement*:
284 This lets you set the position of the slit. 294 This lets you set the position of the slit.
285 295
286- *Layer*: 296- *Layer*:
287 Look above for the layer priorities. 297 Look above for the layer priorities.
288 298
289- *Auto hide*: 299- *Auto hide*:
290 If enabled, the slit will disappear after a given amount of time and hide 300 If enabled, the slit will disappear after a given amount of time and hide
291 from the view of the user. You can make it appear if you move the mouse to 301 from the view of the user. You can make it appear if you move the mouse to
292 the edge of the desktop where the slit is psitioned. 302 the edge of the desktop where the slit is psitioned.
293 303
294- *Maximize over*: 304- *Maximize over*:
295 If this is enabled, all windows, if you maximize them, will stretch 305 If this is enabled, all windows, if you maximize them, will stretch
296 over/under the slit. Otherwise the will be limited to the slit's edge. 306 over/under the slit. Otherwise the will be limited to the slit's edge.
297 307
298- *Alpha*: 308- *Alpha*:
299 By changing the value the slit (only the decoration not the apps in the 309 By changing the value the slit (only the decoration not the apps in the
300 slit) will become transparent. 0 (transparent) - 255 (opaque) 310 slit) will become transparent. 0 (transparent) - 255 (opaque)
301 311
302- *Slit direction*: 312- *Slit direction*:
303 Changing the value will set the slit's direction for ordering apps sitting 313 Changing the value will set the slit's direction for ordering apps sitting
304 in the slit. There is no effect with only on application. 314 in the slit. There is no effect with only on application.
305 315
306- *Clients*: 316- *Clients*:
307 This submenu lets you reorder the the applications running in the 317 This submenu lets you reorder the the applications running in the
308 slit. You are able to hide apps from the slit by unselecting them in 318 slit. You are able to hide apps from the slit by unselecting them in
@@ -310,47 +320,47 @@ editing the init file, but this is a easier and faster way to most users.
310 by selecting them in the list. The "Save SlitList" option saves the 320 by selecting them in the list. The "Save SlitList" option saves the
311 new order to you slitlist located in ~/.fluxbox (useful if you 321 new order to you slitlist located in ~/.fluxbox (useful if you
312 reordered the apps with the cycle option). 322 reordered the apps with the cycle option).
313 323
314- *Toolbar*: 324- *Toolbar*:
315 Please take a look at the "Configuration via the Toolbar Menu" part of the 325 Please take a look at the "Configuration via the Toolbar Menu" part of the
316 TOOLBAR section. 326 TOOLBAR section.
317 327
318- *Image Dithering*: 328- *Image Dithering*:
319 Enable or disable dithering of images. 329 Enable or disable dithering of images.
320 330
321- *Opaque Window Moving*: 331- *Opaque Window Moving*:
322 If enabled, you will see the window content while dragging it. Otherwise 332 If enabled, you will see the window content while dragging it. Otherwise
323 the window will be shown as a "border". 333 the window will be shown as a "border".
324 334
325- *Full Maximization*: 335- *Full Maximization*:
326 Enabling this will override the seperate settings for the slit/toolbar. 336 Enabling this will override the seperate settings for the slit/toolbar.
327 Windows will always maximize over/under both of them. 337 Windows will always maximize over/under both of them.
328 338
329- *Focus New Window*: 339- *Focus New Window*:
330 If enabled, a newly opend window will gain focus. 340 If enabled, a newly opend window will gain focus.
331 341
332- *Focus Last Window on Workspace*: 342- *Focus Last Window on Workspace*:
333 This focuses the last window if switching back to a worspace if the option 343 This focuses the last window if switching back to a worspace if the option
334 is enabled. 344 is enabled.
335 345
336- *Windows Warping*: 346- *Windows Warping*:
337 If enabled, you can drag windows from one to another workspace. 347 If enabled, you can drag windows from one to another workspace.
338 348
339- *Desktop MouseWheel Switching*: 349- *Desktop MouseWheel Switching*:
340 You will be able to change the workspace with your mousewheel if used on 350 You will be able to change the workspace with your mousewheel if used on
341 the desktop or over the toolbar if the option is enabled. 351 the desktop or over the toolbar if the option is enabled.
342 352
343- *Decorate Transient Windows*: 353- *Decorate Transient Windows*:
344 With this option enabled all temporary windows will have a border and 354 With this option enabled all temporary windows will have a border and
345 grips. 355 grips.
346 356
347- *Click Raises*: 357- *Click Raises*:
348 If enabled a click anywhere on a window area (including the decorations) 358 If enabled a click anywhere on a window area (including the decorations)
349 will raise it. Otherwise you can only raise it by clicking the titlebar. 359 will raise it. Otherwise you can only raise it by clicking the titlebar.
350 360
351- *Transparency*: 361- *Transparency*:
352 This sets the transparency for an focused, unfocused window and the menu. 362 This sets the transparency for an focused, unfocused window and the menu.
353 363
354Window Menu 364Window Menu
355~~~~~~~~~~~ 365~~~~~~~~~~~
356The Window menu is displayed when you right click on the titlebar or 366The Window menu is displayed when you right click on the titlebar or
@@ -672,7 +682,7 @@ visible:
672- *Iconbar Mode*: 682- *Iconbar Mode*:
673 683
674 Specifies the mode of the iconbar: 684 Specifies the mode of the iconbar:
675 685
676 - *None*: 686 - *None*:
677 will show not a single window 687 will show not a single window
678 - *Icons*: 688 - *Icons*:
@@ -685,7 +695,7 @@ visible:
685 will only show the windows of the current workspace that are 695 will only show the windows of the current workspace that are
686 minimzed (iconified) 696 minimzed (iconified)
687 - *WorkspaceNoIcons*: 697 - *WorkspaceNoIcons*:
688 will only show the windows of the current workspace that are not 698 will only show the windows of the current workspace that are not
689 minimzed (iconified) 699 minimzed (iconified)
690 - *Workspace*: 700 - *Workspace*:
691 will show all windows of the current workspace 701 will show all windows of the current workspace
@@ -702,7 +712,7 @@ visible:
702 - *Relative*: 712 - *Relative*:
703 all Icons/Windows will be averaged so that the iconbar will always be 713 all Icons/Windows will be averaged so that the iconbar will always be
704 completely filled 714 completely filled
705 - *Right*: 715 - *Right*:
706 all Icons/Windows will be left aligned according to the width set in 716 all Icons/Windows will be left aligned according to the width set in
707 init 717 init
708 718
@@ -896,7 +906,12 @@ session.screen0.tab.width: 64
896session.screen0.followModel: Ignore 906session.screen0.followModel: Ignore
897session.screen0.rowPlacementDirection: LeftToRight 907session.screen0.rowPlacementDirection: LeftToRight
898session.screen0.colPlacementDirection: TopToBottom 908session.screen0.colPlacementDirection: TopToBottom
899session.screen0.resizeMode: Bottom 909session.screen0.resizeMode: Bottom|Quadrant|Center
910 Setting this resource to 'Quadrant' makes resizing by ALT +
911 Right Mousebutton (mouse button 3) grab the corner closest
912 to the mouse pointer instead of the bottom right corner.
913 'Center' resizes all corners at the same time.
914
900session.screen0.focusModel: ClickToFocus 915session.screen0.focusModel: ClickToFocus
901session.screen0.autoRaise: <boolean> 916session.screen0.autoRaise: <boolean>
902session.screen0.clickRaises: <boolean> 917session.screen0.clickRaises: <boolean>
@@ -1090,8 +1105,12 @@ Currently Focused Window Commands
1090- Stick 1105- Stick
1091- StickWindow 1106- StickWindow
1092- ToggleDecor 1107- ToggleDecor
1108- TakeToWorkspace <number>
1109- TakeToNextWorkspace <offset>
1110- TakeToPrevWorkspace <offset>
1093- SendToWorkspace <number> 1111- SendToWorkspace <number>
1094- SentToWorkspace <number> 1112- SendToNextWorkspace <offset>
1113- SendToPrevWorkspace <offset>
1095- KillWindow 1114- KillWindow
1096- NextTab 1115- NextTab
1097- PrevTab 1116- PrevTab
@@ -1126,10 +1145,18 @@ Special Commands
1126 1145
1127Couple of things 1146Couple of things
1128~~~~~~~~~~~~~~~~ 1147~~~~~~~~~~~~~~~~
1129- SentToWorkspace: 1148- TakeToWorkspace:
1130 Will send you along with the window to the selected workspace. 1149 Will send you along with the window to the selected workspace.
1131 SendToWorkspace just sends the window. 1150 SendToWorkspace just sends the window.
1132 1151
1152- TakeToNextWorkspace <offset>:
1153 Will send you and the window to workspace number <current +
1154 offset>; that is, move you and the window <offset> spaces to the
1155 right (offset defaults to 1). SendToNextWorkspace does the same,
1156 except that it only sends the window (as for SendToWorkspace).
1157 TakeToPrevWorkspace and SendToPrevWorkspace work similarly, except
1158 moving to the previous windows, not the next one.
1159
1133- PrevWindow/NextWindow parameters take an integer: 1160- PrevWindow/NextWindow parameters take an integer:
1134 0 or unspecified = Default/current behavior - no skipping 1161 0 or unspecified = Default/current behavior - no skipping
1135 1 = Skip lower tabs 1162 1 = Skip lower tabs
@@ -1213,9 +1240,9 @@ mouse clicks on them.
1213Thus, there are four main options when choosing a focus model. You should choose 1240Thus, there are four main options when choosing a focus model. You should choose
1214one of the first two and one of the last two. They are: 1241one of the first two and one of the last two. They are:
1215 1242
1216- *Click To Focus*: 1243- *Click To Focus*:
1217 click to focus windows 1244 click to focus windows
1218- *Mouse Focus*: 1245- *Mouse Focus*:
1219 window focus follows mouse 1246 window focus follows mouse
1220- *ClickTabFocus*: 1247- *ClickTabFocus*:
1221 click to focus tabs 1248 click to focus tabs
@@ -1278,7 +1305,7 @@ time (default is to match all matching windows).
1278# match an rdesktop window to a particular host 1305# match an rdesktop window to a particular host
1279[app] (title=rdesktop - hostname.*) 1306[app] (title=rdesktop - hostname.*)
1280................................................................... 1307...................................................................
1281 1308
1282The following are the properties that can be defined in each [app] entry. 1309The following are the properties that can be defined in each [app] entry.
1283Each name must be enclosed in square brackets, and the value is generally in 1310Each name must be enclosed in square brackets, and the value is generally in
1284curly brackets: 1311curly brackets:
@@ -1292,7 +1319,7 @@ curly brackets:
1292 1319
1293- [Position] (*refspot*)) {X Y}: 1320- [Position] (*refspot*)) {X Y}:
1294 Position the application at a particular spot: 1321 Position the application at a particular spot:
1295 + 1322 +
1296 * WINCENTER 1323 * WINCENTER
1297 * CENTER 1324 * CENTER
1298 * UPPERLEFT 1325 * UPPERLEFT
@@ -1300,13 +1327,13 @@ curly brackets:
1300 * LOWERLEFT 1327 * LOWERLEFT
1301 * LOWERRIGHT 1328 * LOWERRIGHT
1302 + 1329 +
1303 1330
1304 You can optionally specify what X and Y are relative to. By default the 1331 You can optionally specify what X and Y are relative to. By default the
1305 upper left corner is placed at screen coordinates (X, Y). If you specify 1332 upper left corner is placed at screen coordinates (X, Y). If you specify
1306 LOWERRIGHT, then the lower right corner of the window is positioned (X,Y) 1333 LOWERRIGHT, then the lower right corner of the window is positioned (X,Y)
1307 pixels from the lower right of the screen. Note that CENTER puts the top 1334 pixels from the lower right of the screen. Note that CENTER puts the top
1308 left corner of the window relative to the center of the screen (WINCENTER 1335 left corner of the window relative to the center of the screen (WINCENTER
1309 acts like the rest - positions the center of the window relative to the 1336 acts like the rest - positions the center of the window relative to the
1310 center of the screen). 1337 center of the screen).
1311 1338
1312- [Layer] {Layernum}: 1339- [Layer] {Layernum}:
@@ -1339,7 +1366,7 @@ curly brackets:
1339 o BORDER - like NONE except keep the X window border 1366 o BORDER - like NONE except keep the X window border
1340 o TINY - titlebar with an iconify button 1367 o TINY - titlebar with an iconify button
1341 o TOOL - titlebar only 1368 o TOOL - titlebar only
1342 1369
1343 A bitmask can also be used for fine-grained control. The bits are (from 1370 A bitmask can also be used for fine-grained control. The bits are (from
1344 "1" to 1<<10): titlebar, handle/grips, border, iconify button, maximize 1371 "1" to 1<<10): titlebar, handle/grips, border, iconify button, maximize
1345 button, close button, menu enabled, sticky button, shade button, tabbing 1372 button, close button, menu enabled, sticky button, shade button, tabbing
@@ -1374,7 +1401,7 @@ o name - the name of the window (the first field of WM_CLASS)
1374o class - class of the window (the second field of WM_CLASS) 1401o class - class of the window (the second field of WM_CLASS)
1375o title - title of the window ( WM_NAME property) 1402o title - title of the window ( WM_NAME property)
1376o role - role of the window (the WM_WINDOW_ROLE property) 1403o role - role of the window (the WM_WINDOW_ROLE property)
1377 1404
1378If no `property' is specified, the name property is assumed. You can find out 1405If no `property' is specified, the name property is assumed. You can find out
1379the value for these fields for a particular window by running xprop(1). 1406the value for these fields for a particular window by running xprop(1).
1380 1407
@@ -1475,7 +1502,7 @@ wmdrawer &
1475exec fluxbox 1502exec fluxbox
1476.............. 1503..............
1477 1504
1478NOTE: 1505NOTE:
1479You can also put all of these in the startfluxbox(8) script. This way you 1506You can also put all of these in the startfluxbox(8) script. This way you
1480would only need to specify: exec startfluxbox in your ~/.xinitrc. 1507would only need to specify: exec startfluxbox in your ~/.xinitrc.
1481 1508