aboutsummaryrefslogtreecommitdiff
path: root/doc/asciidoc/fluxbox.txt
diff options
context:
space:
mode:
authorMathias Gumz <akira@fluxbox.org>2015-01-05 15:52:06 (GMT)
committerMathias Gumz <akira@fluxbox.org>2015-01-05 15:52:06 (GMT)
commita46a4aef08abaf548437b688c38d9e5eb99f7eb8 (patch)
tree6dad4e7ab0bad005a5a93f7f82c877fdff080040 /doc/asciidoc/fluxbox.txt
parent3d6d7f8183c2424f83de0f4dd8d3e172f245d623 (diff)
downloadfluxbox-a46a4aef08abaf548437b688c38d9e5eb99f7eb8.zip
fluxbox-a46a4aef08abaf548437b688c38d9e5eb99f7eb8.tar.bz2
Documentation: white-spaces and minor formatting
Diffstat (limited to 'doc/asciidoc/fluxbox.txt')
-rw-r--r--doc/asciidoc/fluxbox.txt232
1 files changed, 116 insertions, 116 deletions
diff --git a/doc/asciidoc/fluxbox.txt b/doc/asciidoc/fluxbox.txt
index 23a73d9..48041c6 100644
--- a/doc/asciidoc/fluxbox.txt
+++ b/doc/asciidoc/fluxbox.txt
@@ -300,19 +300,19 @@ item with the items detailed below:
300*Configure*:: 300*Configure*::
301 The next level under this menu is where you can set certain resources and 301 The next level under this menu is where you can set certain resources and
302 really begin to customize the look and feel of your desktop. See the 302 really begin to customize the look and feel of your desktop. See the
303 *Configure Menu* section below for more details. 303 *Configure Menu* section below for more details.
304 304
305*System Styles*:: 305*System Styles*::
306 This is where the standard styles are listed. You can select one of these by 306 This is where the standard styles are listed. You can select one of these by
307 clicking on it, and it will be applied immediately. System styles are 307 clicking on it, and it will be applied immediately. System styles are
308 located in *@pkgdatadir@/styles/* upon a default install. Remember that you 308 located in *@pkgdatadir@/styles/* upon a default install. Remember that you
309 can confirm this with fluxbox -i. 309 can confirm this with fluxbox -i.
310 310
311*User Styles*::: 311*User Styles*:::
312 This is where your custom styles are listed. It will list any styles from 312 This is where your custom styles are listed. It will list any styles from
313 *~/.fluxbox/styles/*, which may be styles you grab from the Internet, or 313 *~/.fluxbox/styles/*, which may be styles you grab from the Internet, or
314 your own custom styles, provided you follow the standards described in 314 your own custom styles, provided you follow the standards described in
315 *fluxbox-style(5)*. 315 *fluxbox-style(5)*.
316 316
317*Workspace List*::: 317*Workspace List*:::
318 This is the same as the *Workspace Menu* detailed below. 318 This is the same as the *Workspace Menu* detailed below.
@@ -330,21 +330,21 @@ item with the items detailed below:
330 330
331*Fluxbox Command*::: 331*Fluxbox Command*:::
332 A little Commandline will popup where you can enter a fluxbox command. These 332 A little Commandline will popup where you can enter a fluxbox command. These
333 commands are the same as those detailed in *fluxbox-keys(5)*. 333 commands are the same as those detailed in *fluxbox-keys(5)*.
334 334
335*Reload config*::: 335*Reload config*:::
336 Use this to reload the fluxbox configuration files. You must do this after 336 Use this to reload the fluxbox configuration files. You must do this after
337 editing the `keys' file, `init' file, or the current style. 337 editing the `keys' file, `init' file, or the current style.
338 338
339*Restart*::: 339*Restart*:::
340 Restart the whole darn thing. This starts a completely new fluxbox process, 340 Restart the whole darn thing. This starts a completely new fluxbox process,
341 rereads files and redraws all graphical elements. Running applications will 341 rereads files and redraws all graphical elements. Running applications will
342 remain open, however, and restored to the same workspaces they were 342 remain open, however, and restored to the same workspaces they were
343 previously in once fluxbox returns. 343 previously in once fluxbox returns.
344 344
345*Exit*::: 345*Exit*:::
346 Exits fluxbox, which in turn either shuts down the X Window server or 346 Exits fluxbox, which in turn either shuts down the X Window server or
347 returns you to the graphical login screen. 347 returns you to the graphical login screen.
348 348
349Configuration Menu 349Configuration Menu
350~~~~~~~~~~~~~~~~~~ 350~~~~~~~~~~~~~~~~~~
@@ -355,25 +355,25 @@ faster way to change the most common settings.
355All changes take effect immediately. 355All changes take effect immediately.
356 356
357*Focus Model*::: 357*Focus Model*:::
358 Lets you configure the window focus model. For details, see *FOCUS MODEL*, 358 Lets you configure the window focus model. For details, see *FOCUS MODEL*,
359 below. 359 below.
360 360
361*Maximize Options*::: 361*Maximize Options*:::
362Lets you configure what happens when you maximize a window. The four 362Lets you configure what happens when you maximize a window. The four
363options are: 363options are:
364+ 364+
365-- 365--
366 *Full Maximization*:;; 366 *Full Maximization*:;;
367 Normally, a maximized window will not overlap the toolbar, slit, or any 367 Normally, a maximized window will not overlap the toolbar, slit, or any
368 docked windows (like panels). Enabling this option allows maximized 368 docked windows (like panels). Enabling this option allows maximized
369 windows to be as large as the actual screen resolution. 369 windows to be as large as the actual screen resolution.
370 *Ignore Resize Increment*:;; 370 *Ignore Resize Increment*:;;
371 Normally, terminal windows specify a ``resize increment'' which mean 371 Normally, terminal windows specify a ``resize increment'' which mean
372 fluxbox will only resize the window to an even multiple of the character 372 fluxbox will only resize the window to an even multiple of the character
373 size. Enabling this option will ignore this specification when maximizing. 373 size. Enabling this option will ignore this specification when maximizing.
374 *Disable Moving* / *Disable Resizing*:;; 374 *Disable Moving* / *Disable Resizing*:;;
375 Normally, maximized windows can still be moved and resized. Enabling these 375 Normally, maximized windows can still be moved and resized. Enabling these
376 options prevents these behaviour. 376 options prevents these behaviour.
377-- 377--
378 378
379*Tab Options*::: 379*Tab Options*:::
@@ -386,8 +386,8 @@ options are:
386 386
387*Toolbar*::: 387*Toolbar*:::
388 This menu can also be found by right-clicking any non-icon part of the 388 This menu can also be found by right-clicking any non-icon part of the
389 toolbar. Find more information about this menu's options in the *Toolbar 389 toolbar. Find more information about this menu's options in the *Toolbar
390 Menu* section, below. 390 Menu* section, below.
391 391
392*Transparency*::: 392*Transparency*:::
393This sets the default transparency for a focused windows, unfocused window and 393This sets the default transparency for a focused windows, unfocused window and
@@ -408,7 +408,7 @@ titlebars, not window contents.
408 408
409*Workspace Warping*::: 409*Workspace Warping*:::
410 If enabled, you can drag windows from one workspace to another. The previous 410 If enabled, you can drag windows from one workspace to another. The previous
411 workspace is to the left, the next workspace is to the right. 411 workspace is to the left, the next workspace is to the right.
412 412
413Window Menu 413Window Menu
414~~~~~~~~~~~ 414~~~~~~~~~~~
@@ -440,9 +440,9 @@ By default, this menu contains:
440 * Button 3 (Un)Maximize window horizontally. 440 * Button 3 (Un)Maximize window horizontally.
441 441
442*Iconify*::: 442*Iconify*:::
443 Iconify (or minimize) a window. The `icon' can be found in the Icons submenu 443 Iconify (or minimize) a window. The `icon' can be found in the Icons submenu
444 of the workspace menu as well as in the toolbar (if a Toolbar mode showing 444 of the workspace menu as well as in the toolbar (if a Toolbar mode showing
445 Icons is selected). 445 Icons is selected).
446 446
447*Raise*::: 447*Raise*:::
448 Raise the window above all others in the same layer. 448 Raise the window above all others in the same layer.
@@ -455,7 +455,7 @@ By default, this menu contains:
455 455
456*Transparency*::: 456*Transparency*:::
457 Change this window's transparency, overriding the defaults from the 457 Change this window's transparency, overriding the defaults from the
458 *Configuration Menu*. 458 *Configuration Menu*.
459 459
460*Remember...*::: 460*Remember...*:::
461Specify which window settings should be stored in the `apps' file and 461Specify which window settings should be stored in the `apps' file and
@@ -465,36 +465,36 @@ Specifically the setting you may store are:
465+ 465+
466-- 466--
467*Workpace:*;; 467*Workpace:*;;
468 Open this in the same workspace as where the window currently resides. 468 Open this in the same workspace as where the window currently resides.
469*Jump to workspace:*;; 469*Jump to workspace:*;;
470 When *Workspace* is selected, fluxbox will jump to the appropriate workspace 470 When *Workspace* is selected, fluxbox will jump to the appropriate workspace
471 when this window is opened there. If not selected, the window will open in 471 when this window is opened there. If not selected, the window will open in
472 the background. 472 the background.
473*Head*:;; 473*Head*:;;
474 For xinerama users only, start this window on the current head (or screen). 474 For xinerama users only, start this window on the current head (or screen).
475*Dimensions*:;; 475*Dimensions*:;;
476 Record the current window height and width. 476 Record the current window height and width.
477*Position*:;; 477*Position*:;;
478 Record the current X and Y coordinates of the window. 478 Record the current X and Y coordinates of the window.
479*Sticky*:;; 479*Sticky*:;;
480 Record whether the window is on all desktops, or not. 480 Record whether the window is on all desktops, or not.
481*Decorations*:;; 481*Decorations*:;;
482 Record the current set of decorations (title bar, grips, tabs, etc) on the window. 482 Record the current set of decorations (title bar, grips, tabs, etc) on the window.
483*Shaded*:;; 483*Shaded*:;;
484 Record whether the window is shaded (or rolled-up) or not. 484 Record whether the window is shaded (or rolled-up) or not.
485*Minimized*:;; 485*Minimized*:;;
486 Record whether the window is iconified (or minimized) or not. 486 Record whether the window is iconified (or minimized) or not.
487*Maximized*:;; 487*Maximized*:;;
488 Record whether the window is maximized or not. 488 Record whether the window is maximized or not.
489*Fullscreen*:;; 489*Fullscreen*:;;
490 Record whether the window is in fullscreen mode or not. 490 Record whether the window is in fullscreen mode or not.
491*Transparency*:;; 491*Transparency*:;;
492 Record the current *Transparency* settings. 492 Record the current *Transparency* settings.
493*Layer*:;; 493*Layer*:;;
494 Record the current layer. 494 Record the current layer.
495*Save on close*:;; 495*Save on close*:;;
496 If selected, any of the above items which are also selected will be updated 496 If selected, any of the above items which are also selected will be updated
497 with the window's current values as it is closed. 497 with the window's current values as it is closed.
498 498
499-- 499--
500+ 500+
@@ -513,24 +513,24 @@ background. This menu contains entries to explore the currently defined
513workspaces, windows, and add/remove/rename workspaces. 513workspaces, windows, and add/remove/rename workspaces.
514 514
515*Icons*::: 515*Icons*:::
516 This menu shows any iconified (or, minimized) windows. Clicking on a window 516 This menu shows any iconified (or, minimized) windows. Clicking on a window
517 in this menu will raise it on the current workspace. 517 in this menu will raise it on the current workspace.
518 518
519'Workspaces'::: 519'Workspaces':::
520 The next section provides one submenu per workspace. Middle-clicking on a 520 The next section provides one submenu per workspace. Middle-clicking on a
521 workspace name will take you to that workspace. The submenu contains a list 521 workspace name will take you to that workspace. The submenu contains a list
522 of all open windows on that workspace. Clicking on a window name will take 522 of all open windows on that workspace. Clicking on a window name will take
523 you to that window and raise it, changing the active workspace if necessary. 523 you to that window and raise it, changing the active workspace if necessary.
524 524
525*New Workspace*::: 525*New Workspace*:::
526 This entry adds a new workspace to the end of the list of current workspaces. 526 This entry adds a new workspace to the end of the list of current workspaces.
527 527
528*Edit current workspace name*::: 528*Edit current workspace name*:::
529 Pops up a dialog to enter a new name for the current workspace. 529 Pops up a dialog to enter a new name for the current workspace.
530 530
531*Remove Last*::: 531*Remove Last*:::
532 Remove the last workspace in the list. Any windows currently open there will 532 Remove the last workspace in the list. Any windows currently open there will
533 be sent to the next-to-last workspace. 533 be sent to the next-to-last workspace.
534 534
535TOOLBAR 535TOOLBAR
536------- 536-------
@@ -596,18 +596,18 @@ All changes take effect immediately. Here are the settings:
596 If this is enabled the toolbar will disappear after a defined time when the 596 If this is enabled the toolbar will disappear after a defined time when the
597 mouse pointer leaves the toolbar. It will slide in when the cursor hits the 597 mouse pointer leaves the toolbar. It will slide in when the cursor hits the
598 remaining edge of the toolbar. See the *session.autoRaiseDelay* resource for 598 remaining edge of the toolbar. See the *session.autoRaiseDelay* resource for
599 the delay time. 599 the delay time.
600 600
601*Toolbar width percentage*::: 601*Toolbar width percentage*:::
602 Sets the width of the toolbar in a percentage of your total screen size. Use 602 Sets the width of the toolbar in a percentage of your total screen size. Use
603 the left mouse button to decrease and the right mouse-button to increase the 603 the left mouse button to decrease and the right mouse-button to increase the
604 value. The value can be from 1-100. 604 value. The value can be from 1-100.
605 605
606*Maximize Over*::: 606*Maximize Over*:::
607 Enabling this option will allow windows to maximize over the toolbar. With 607 Enabling this option will allow windows to maximize over the toolbar. With
608 this switched on they will only expand to the edge of the bar. This option 608 this switched on they will only expand to the edge of the bar. This option
609 may be overridden by the ``Full Maximization'' from the *Configuration 609 may be overridden by the ``Full Maximization'' from the *Configuration
610 Menu*. If that option is enabled, this option will have no effect.. 610 Menu*. If that option is enabled, this option will have no effect..
611 611
612*Layer...*::: 612*Layer...*:::
613 This sets the layer on which the toolbar is set. With this you can set the 613 This sets the layer on which the toolbar is set. With this you can set the
@@ -629,19 +629,19 @@ The first section outlines what types of windows will be shown in the iconbar:
629+ 629+
630-- 630--
631*None*:;; 631*None*:;;
632 Will not show any windows 632 Will not show any windows
633*Icons*:;; 633*Icons*:;;
634 Shows windows from all workspaces that are iconified (or, minimized) 634 Shows windows from all workspaces that are iconified (or, minimized)
635*NoIcons*:;; 635*NoIcons*:;;
636 Shows windows from all workspaces that are not iconified 636 Shows windows from all workspaces that are not iconified
637*WorkspaceIcons*:;; 637*WorkspaceIcons*:;;
638 Shows windows from the current workspace that are iconified 638 Shows windows from the current workspace that are iconified
639*WorkspaceNoIcons*:;; 639*WorkspaceNoIcons*:;;
640 Shows windows from the current workspace that are not iconified 640 Shows windows from the current workspace that are not iconified
641*Workspace*:;; 641*Workspace*:;;
642 Shows all windows (iconified or not) from the current workspace 642 Shows all windows (iconified or not) from the current workspace
643*All Windows*:;; 643*All Windows*:;;
644 Shows all windows (iconified or not) from all workspaces 644 Shows all windows (iconified or not) from all workspaces
645 645
646-- 646--
647+ 647+
@@ -651,11 +651,11 @@ resource:
651+ 651+
652-- 652--
653*Left*:;; 653*Left*:;;
654 All icons will be left-aligned with the width set in the `init' file 654 All icons will be left-aligned with the width set in the `init' file
655*Relative*:;; 655*Relative*:;;
656 All icons will be sized evenly to fill the iconbar completely 656 All icons will be sized evenly to fill the iconbar completely
657*Right*:;; 657*Right*:;;
658 All icons will be right-aligned with the width set in the `init' file 658 All icons will be right-aligned with the width set in the `init' file
659 659
660-- 660--
661+ 661+
@@ -699,16 +699,16 @@ one of the first two and one of the last two. They are:
699There are three more settings in the ``Focus Model'' menu: 699There are three more settings in the ``Focus Model'' menu:
700 700
701*Focus New Windows*::: 701*Focus New Windows*:::
702 If enabled, a new window will grab X focus as soon as it is opened. 702 If enabled, a new window will grab X focus as soon as it is opened.
703 703
704*Auto Raise*:: 704*Auto Raise*::
705 If enabled, focusing on a new window will automatically raise that window 705 If enabled, focusing on a new window will automatically raise that window
706 above all others within its layer. When disabled, you must explicitly raise a 706 above all others within its layer. When disabled, you must explicitly raise a
707 focused window using the window menu, keybinding, or *Click Raises*. 707 focused window using the window menu, keybinding, or *Click Raises*.
708 708
709*Click Raises*:: 709*Click Raises*::
710 If enabled, clicking anywhere on a window will raise it above all others 710 If enabled, clicking anywhere on a window will raise it above all others
711 within its layer. 711 within its layer.
712 712
713TAB OPTIONS 713TAB OPTIONS
714----------- 714-----------
@@ -726,7 +726,7 @@ tabs. Inside of it there are three main options:
726*Maximize Over*::: 726*Maximize Over*:::
727 When this option is on, maximizing a window will disregard the size and 727 When this option is on, maximizing a window will disregard the size and
728 location of external tabs, which means they may be pushed out of the screen 728 location of external tabs, which means they may be pushed out of the screen
729 entirely. 729 entirely.
730 730
731*External Tab Width*::: 731*External Tab Width*:::
732 This specifies in pixels the width of external tabs. 732 This specifies in pixels the width of external tabs.
@@ -786,14 +786,14 @@ All changes take effect immediately. Here are the settings:
786 If this is enabled the slit will disappear after a defined time when the 786 If this is enabled the slit will disappear after a defined time when the
787 mouse pointer leaves the slit. It will slide in when the cursor hits the 787 mouse pointer leaves the slit. It will slide in when the cursor hits the
788 remaining edge of the slit. See the *session.autoRaiseDelay* resource for 788 remaining edge of the slit. See the *session.autoRaiseDelay* resource for
789 the delay time. 789 the delay time.
790 790
791*Maximize Over*::: 791*Maximize Over*:::
792 Enabling this option will allow windows to maximizing over the slit. With 792 Enabling this option will allow windows to maximizing over the slit. With
793 this switched off they will only expand to the edge of the slit. This 793 this switched off they will only expand to the edge of the slit. This
794 option may be overridden by the ``Full Maximization'' from the 794 option may be overridden by the ``Full Maximization'' from the
795 *Configuration Menu*. If that option is enabled, this option will have no 795 *Configuration Menu*. If that option is enabled, this option will have no
796 effect.. 796 effect..
797 797
798*Alpha*::: 798*Alpha*:::
799 This sets the alpha value for the slit. Use the left mouse button to 799 This sets the alpha value for the slit. Use the left mouse button to
@@ -802,11 +802,11 @@ All changes take effect immediately. Here are the settings:
802 802
803*Clients*::: 803*Clients*:::
804 This submenu lets you reorder the the applications running in the 804 This submenu lets you reorder the the applications running in the
805 slit. You are able to hide apps from the slit by unselecting them in the 805 slit. You are able to hide apps from the slit by unselecting them in the
806 list showing. This will not kill the app. You can make them re-appear by 806 list showing. This will not kill the app. You can make them re-appear by
807 selecting them in the list. The "Save SlitList" option saves the new order 807 selecting them in the list. The "Save SlitList" option saves the new order
808 to you slitlist located in *~/.fluxbox/slitlist*. See the next section for 808 to you slitlist located in *~/.fluxbox/slitlist*. See the next section for
809 details. 809 details.
810 810
811Slitlist File 811Slitlist File
812~~~~~~~~~~~~~ 812~~~~~~~~~~~~~
@@ -889,8 +889,8 @@ These allow users to place the slit and toolbar where they like.
889+ 889+
890-- 890--
891Possible options are:;; 891Possible options are:;;
892 *BottomLeft* *BottomCenter* *BottomRight* *LeftBottom* *LeftCenter* *LeftTop* 892 *BottomLeft BottomCenter BottomRight LeftBottom LeftCenter LeftTop
893 *RightBottom* *RightCenter* *RightTop* *TopLeft* *TopCenter* *TopRight* 893 RightBottom RightCenter RightTop TopLeft TopCenter TopRight*
894-- 894--
895+ 895+
896Slit default: *RightBottom* 896Slit default: *RightBottom*
@@ -930,8 +930,8 @@ They may be specified in any order, delimited by the *,* character.
930They will appear in the order given. 930They will appear in the order given.
931+ 931+
932Possible tools:;; 932Possible tools:;;
933*clock* *iconbar* *nextwindow* *prevwindow* *nextworkspace* *prevworkspace* 933*clock iconbar nextwindow prevwindow nextworkspace prevworkspace
934*systemtray* *workspacename* 934systemtray workspacename*
935+ 935+
936Default:;; 936Default:;;
937*workspacename, prevworkspace, nextworkspace, iconbar, prevwindow, nextwindow, 937*workspacename, prevworkspace, nextworkspace, iconbar, prevwindow, nextwindow,
@@ -1178,7 +1178,7 @@ may specify any number, space-delimited.
1178+ 1178+
1179-- 1179--
1180The available options are:;; 1180The available options are:;;
1181 *Close* *Maximize* *MenuIcon* *Minimize* *Shade* *Stick* *LHalf* *RHalf* 1181 *Close Maximize MenuIcon Minimize Shade Stick LHalf RHalf*
1182-- 1182--
1183+ 1183+
1184Default left: *Stick* 1184Default left: *Stick*
@@ -1194,33 +1194,33 @@ files. This is where you can specify different files. Most of the defaults will
1194be located in the user's *~/.fluxbox* directory. 1194be located in the user's *~/.fluxbox* directory.
1195 1195
1196*session.appsFile*: 'location':: 1196*session.appsFile*: 'location'::
1197 Location of persistent application settings, or the `apps' file. See the 1197 Location of persistent application settings, or the `apps' file. See the
1198 *Remember...* item in the *Window Menu* section above or *fluxbox-apps(5)* 1198 *Remember...* item in the *Window Menu* section above or *fluxbox-apps(5)*
1199 for details. 1199 for details.
1200 1200
1201*session.groupFile*: 'location':: 1201*session.groupFile*: 'location'::
1202 Deprecated, auto-grouping is now done in the `apps' file, see 1202 Deprecated, auto-grouping is now done in the `apps' file, see
1203 *fluxbox-apps(5)* for details. 1203 *fluxbox-apps(5)* for details.
1204 1204
1205*session.keyFile*: 'location':: 1205*session.keyFile*: 'location'::
1206 Location of the keyboard mapping settings, or the `keys' file. 1206 Location of the keyboard mapping settings, or the `keys' file.
1207 See *fluxbox-keys(5)* for details. 1207 See *fluxbox-keys(5)* for details.
1208 1208
1209*session.menuFile*: 'location':: 1209*session.menuFile*: 'location'::
1210 Location of the Root Menu file. 1210 Location of the Root Menu file.
1211 See *fluxbox-menu(5)* for details. 1211 See *fluxbox-menu(5)* for details.
1212 1212
1213*session.slitlistFile*: 'location':: 1213*session.slitlistFile*: 'location'::
1214 Location of the file used to remember slit client ordering. 1214 Location of the file used to remember slit client ordering.
1215 See *SLIT* above for details. 1215 See *SLIT* above for details.
1216 1216
1217*session.styleFile*: 'location':: 1217*session.styleFile*: 'location'::
1218 Location of the currently selected style. 1218 Location of the currently selected style.
1219 See *fluxbox-style(5)* for details. 1219 See *fluxbox-style(5)* for details.
1220 1220
1221*session.styleOverlay*: 'location':: 1221*session.styleOverlay*: 'location'::
1222 Location of the style overlay file. 1222 Location of the style overlay file.
1223 See *fluxbox-style(5)* for details. 1223 See *fluxbox-style(5)* for details.
1224 1224
1225*session.screen0.windowMenu*: 'location':: 1225*session.screen0.windowMenu*: 'location'::
1226This optionally specifies the location of a user-defined window menu. If left 1226This optionally specifies the location of a user-defined window menu. If left