diff options
author | markt <markt> | 2007-02-03 18:21:38 (GMT) |
---|---|---|
committer | markt <markt> | 2007-02-03 18:21:38 (GMT) |
commit | e46f152ee5c41771521b8af4a3c5f6558acd16c1 (patch) | |
tree | a66c7d9956fdf1e38b6b3da355f81dea8b7b5bd8 /doc/asciidoc | |
parent | 2f4d0f6cdea116e203daddffae4ab2be802b024f (diff) | |
download | fluxbox-e46f152ee5c41771521b8af4a3c5f6558acd16c1.zip fluxbox-e46f152ee5c41771521b8af4a3c5f6558acd16c1.tar.bz2 |
updated documentation
Diffstat (limited to 'doc/asciidoc')
-rw-r--r-- | doc/asciidoc/fluxbox.txt | 105 |
1 files changed, 24 insertions, 81 deletions
diff --git a/doc/asciidoc/fluxbox.txt b/doc/asciidoc/fluxbox.txt index a61a3a0..409163f 100644 --- a/doc/asciidoc/fluxbox.txt +++ b/doc/asciidoc/fluxbox.txt | |||
@@ -188,34 +188,6 @@ default, tabs are located just above the window, but they may be embedded in the | |||
188 | titlebar or moved to other locations on the outside of the window. Configuration | 188 | titlebar or moved to other locations on the outside of the window. Configuration |
189 | is discussed in TAB OPTIONS section. | 189 | is discussed in TAB OPTIONS section. |
190 | 190 | ||
191 | Miscellaneous | ||
192 | ~~~~~~~~~~~~~ | ||
193 | When you want to drag a window, but cannot see either the bottom handle or | ||
194 | its titlebar you can press (and hold!) | ||
195 | |||
196 | ALT + Left Mousebutton (mouse button 1) | ||
197 | |||
198 | and move it anywhere in the current workspace. This key combination can | ||
199 | also be used to raise a partially visible window. | ||
200 | |||
201 | The key combination | ||
202 | |||
203 | ALT + Right Mousebutton (mouse button 3) | ||
204 | |||
205 | will allow you to resize the window. This behavior can be altered in the init | ||
206 | file with: | ||
207 | |||
208 | session.modKey: <modifier> | ||
209 | |||
210 | You can also alter how resizing is done. By default, you drag the bottom right | ||
211 | corner. You can drag the corner closest to the mouse pointer instead if you set | ||
212 | |||
213 | session.screen0.resizeMode: Quadrant | ||
214 | |||
215 | or all corners at the same time if you set it to: | ||
216 | |||
217 | session.screen0.resizeMode: Center | ||
218 | |||
219 | MENUS | 191 | MENUS |
220 | ----- | 192 | ----- |
221 | fluxbox installs a default menu file in @pkgdatadir@/menu. You can also use | 193 | fluxbox installs a default menu file in @pkgdatadir@/menu. You can also use |
@@ -718,32 +690,12 @@ RESOURCES | |||
718 | Usually the ~/.fluxbox/init resource file is created and maintained by fluxbox | 690 | Usually the ~/.fluxbox/init resource file is created and maintained by fluxbox |
719 | itself. You can use the [config] menu to set most of these options. However, | 691 | itself. You can use the [config] menu to set most of these options. However, |
720 | we'll cover all of the resource options that are available to the user. If you | 692 | we'll cover all of the resource options that are available to the user. If you |
721 | edit this file while fluxbox is running, you must `restart' to reload the | 693 | edit this file while fluxbox is running, you must `reconfigure' to reload the |
722 | resource options. | 694 | resource options. |
723 | 695 | ||
724 | When running fluxbox in a multiple desktop environment the screen0 key can also | 696 | When running fluxbox in a multiple desktop environment the screen0 key can also |
725 | be screen1, screen2, etc. You can customize the behavior of fluxbox on each | 697 | be screen1, screen2, etc. You can customize the behavior of fluxbox on each |
726 | desktop accordingly. Here is an example, and a favorite of the fluxbox | 698 | desktop accordingly. Here are the resources that are currently available: |
727 | documentation manager: | ||
728 | |||
729 | ................................................. | ||
730 | session.screen0.toolbar.onTop: False | ||
731 | session.screen0.toolbar.autoHide: True | ||
732 | session.screen0.toolbar.placement: BottomCenter | ||
733 | session.screen0.toolbar.widthPercent: 42 | ||
734 | session.screen0.slit.onTop: False | ||
735 | session.screen0.slit.autoHide: True | ||
736 | session.screen0.slit.placement: TopLeft | ||
737 | session.screen0.slit.direction: Vertical | ||
738 | session.screen0.strftimeFormat: %I:%M %p | ||
739 | session.screen1.toolbar.onTop: True | ||
740 | session.screen1.slit.autoHide: False | ||
741 | session.screen1.slit.placement: CenterRight | ||
742 | session.screen1.slit.direction: Vertical | ||
743 | session.screen1.strftimeFormat: %a %d %R [%s] | ||
744 | ................................................. | ||
745 | |||
746 | Here are the resources that are currently available: | ||
747 | 699 | ||
748 | ................................................................................ | 700 | ................................................................................ |
749 | session.screen0.window.focus.alpha: <integer> | 701 | session.screen0.window.focus.alpha: <integer> |
@@ -782,12 +734,6 @@ session.screen0.toolbar.layer: <layer> | |||
782 | the slit to appear on. Please read the LAYER section for more information. | 734 | the slit to appear on. Please read the LAYER section for more information. |
783 | Default: Desktop | 735 | Default: Desktop |
784 | 736 | ||
785 | session.screen0.slit.onTop: <boolean> | ||
786 | session.screen0.toolbar.onTop: <boolean> | ||
787 | A user can set whether or not the toolbar or slit are always on top of the | ||
788 | screen. Setting these resources will put the slit and toolbar above | ||
789 | everything visible on the workspace. Default: False | ||
790 | |||
791 | session.screen0.slit.placement: <placement> | 737 | session.screen0.slit.placement: <placement> |
792 | session.screen0.toolbar.placement: <placement> | 738 | session.screen0.toolbar.placement: <placement> |
793 | These allow users to place the slit and toolbar where they like. Possible | 739 | These allow users to place the slit and toolbar where they like. Possible |
@@ -913,17 +859,16 @@ session.screen0.userFollowModel: <model> | |||
913 | This specifies the behavior when a window on another workspace becomes the | 859 | This specifies the behavior when a window on another workspace becomes the |
914 | active window. The former is used when an application asks to focus the | 860 | active window. The former is used when an application asks to focus the |
915 | window, and the latter is used when the window is activated due to user | 861 | window, and the latter is used when the window is activated due to user |
916 | actions, such as clicking in the iconbar, menu, or pager. `Ignore' does | 862 | actions, such as clicking in the iconbar, menu, or a pager. `Ignore' does |
917 | nothing. `Follow' moves to the window's workspace. `Current' moves the | 863 | nothing. `Follow' moves to the window's workspace. `Current' moves the |
918 | window to the current workspace. `SemiFollow' acts like `Current' for | 864 | window to the current workspace. `SemiFollow' acts like `Current' for |
919 | iconified windows and like `Follow' otherwise. Defaults: Ignore and | 865 | iconified windows and like `Follow' otherwise. Defaults: Ignore and |
920 | Follow, respectively. | 866 | Follow, respectively. |
921 | 867 | ||
922 | session.screen0.resizeMode: Bottom|Quadrant|Center | 868 | session.screen0.resizeMode: Bottom|Quadrant|Center |
923 | Setting this resource to `Quadrant' makes resizing by ALT + Right | 869 | Setting this resource to `Quadrant' makes resizing by using the modkey |
924 | Mousebutton (mouse button 3) grab the corner closest to the mouse pointer | 870 | grab the corner closest to the mouse pointer instead of the bottom right |
925 | instead of the bottom right corner. `Center' resizes all corners at the | 871 | corner. `Center' resizes all corners at the same time. Default: Bottom |
926 | same time. Default: Bottom | ||
927 | 872 | ||
928 | session.screen0.focusModel: ClickToFocus|MouseFocus | 873 | session.screen0.focusModel: ClickToFocus|MouseFocus |
929 | This controls how windows gain focus via the mouse. With `ClickToFocus', | 874 | This controls how windows gain focus via the mouse. With `ClickToFocus', |
@@ -954,13 +899,14 @@ session.screen0.showwindowposition: <boolean> | |||
954 | Default: True | 899 | Default: True |
955 | 900 | ||
956 | session.screen0.decorateTransient: <boolean> | 901 | session.screen0.decorateTransient: <boolean> |
957 | This controls whether or not transient windows get window decorations, | 902 | This controls whether or not transient windows get certain window |
958 | such as a titlebar. Default: False | 903 | decorations, currently the maximize button and handle. |
904 | Default: False | ||
959 | 905 | ||
960 | session.screen0.defaultDeco: <bitmask> | 906 | session.screen0.defaultDeco: <bitmask> |
961 | This specifies the default window decorations, according to the same | 907 | This specifies the default window decorations, according to the same |
962 | bitmask as used by the `[Deco]' option in the `apps' file, described later | 908 | bitmask as used by the `[Deco]' option in the `apps' file, described in |
963 | in this document. Default: all bits set. | 909 | the APPLICATIONS section. Default: all bits set. |
964 | 910 | ||
965 | session.screen0.menuMode: Delay|Click | 911 | session.screen0.menuMode: Delay|Click |
966 | This setting controls the circumstances under which submenus open. With | 912 | This setting controls the circumstances under which submenus open. With |
@@ -1003,6 +949,9 @@ session.screen0.windowPlacement: <placement strategy> | |||
1003 | 949 | ||
1004 | session.screen0.rowPlacementDirection: LeftToRight|RightToLeft | 950 | session.screen0.rowPlacementDirection: LeftToRight|RightToLeft |
1005 | session.screen0.colPlacementDirection: TopToBottom|BottomToTop | 951 | session.screen0.colPlacementDirection: TopToBottom|BottomToTop |
952 | These settings control the direction in which windows are tiled using the | ||
953 | RowSmartPlacement and ColSmartPlacement strategies described above. | ||
954 | Default: LeftToRight/TopToBottom | ||
1006 | 955 | ||
1007 | session.screen0.fullMaximization: <boolean> | 956 | session.screen0.fullMaximization: <boolean> |
1008 | If this setting is enabled, windows will maximize over the toolbar and | 957 | If this setting is enabled, windows will maximize over the toolbar and |
@@ -1011,9 +960,10 @@ session.screen0.fullMaximization: <boolean> | |||
1011 | session.screen0.rootCommand: <command> | 960 | session.screen0.rootCommand: <command> |
1012 | This runs a command when fluxbox starts, intended for setting a default | 961 | This runs a command when fluxbox starts, intended for setting a default |
1013 | background. If you want to override backgrounds set by styles, you should | 962 | background. If you want to override backgrounds set by styles, you should |
1014 | add `background: none' to your overlay. NOTE: Setting this command can be | 963 | add `background: none' to your style overlay (see section STYLE OVERLAY). |
1015 | dangerous. Please make sure you know what you are doing when setting this | 964 | NOTE: Setting this command can be dangerous. Please make sure you know |
1016 | resource to a value other than a desktop wallpaper command. | 965 | what you are doing when setting this resource to a value other than a |
966 | desktop wallpaper command. | ||
1017 | 967 | ||
1018 | session.screen0.imageDither: <boolean> | 968 | session.screen0.imageDither: <boolean> |
1019 | This controls whether or not fluxbox created dithered images. Default: | 969 | This controls whether or not fluxbox created dithered images. Default: |
@@ -1026,10 +976,6 @@ session.screen0.opaqueMove: <boolean> | |||
1026 | session.screen0.workspaces: <integer> | 976 | session.screen0.workspaces: <integer> |
1027 | Set this to the number of workspaces the users wants. Default: 4 | 977 | Set this to the number of workspaces the users wants. Default: 4 |
1028 | 978 | ||
1029 | session.screen0.focusLastWindow: <boolean> | ||
1030 | This controls whether or not to focus the last focused window when | ||
1031 | switching workspaces. Default: True | ||
1032 | |||
1033 | session.screen0.windowMenu: <blank>|<location> | 979 | session.screen0.windowMenu: <blank>|<location> |
1034 | This specifies the location of a user-defined window menu. Default: blank | 980 | This specifies the location of a user-defined window menu. Default: blank |
1035 | 981 | ||
@@ -1069,13 +1015,9 @@ session.forcePseudoTransparency: <boolean> | |||
1069 | the menu, windows, toolbar, and slit to use pseudo-transparency instead of | 1015 | the menu, windows, toolbar, and slit to use pseudo-transparency instead of |
1070 | true transparency. Default: False | 1016 | true transparency. Default: False |
1071 | 1017 | ||
1072 | session.iconbar: <boolean> | ||
1073 | Set this value to `<boolean>' or `<boolean>' to enable or disable fluxbox | ||
1074 | using the toolbar to display iconified windows. Default: <boolean> | ||
1075 | |||
1076 | session.ignoreBorder: <boolean> | 1018 | session.ignoreBorder: <boolean> |
1077 | When using MouseFocus, don't change focus when the mouse hovers over the | 1019 | This configures the ability to move windows by dragging the border. |
1078 | window border. Default: False | 1020 | Default: False |
1079 | 1021 | ||
1080 | session.numLayers: <integer> | 1022 | session.numLayers: <integer> |
1081 | This controls how many layers fluxbox should have. Default: 13 | 1023 | This controls how many layers fluxbox should have. Default: 13 |
@@ -1092,7 +1034,7 @@ session.tabsAttachArea: Window|Titlebar | |||
1092 | With this set to `Window', windows may be grouped by dragging one tab with | 1034 | With this set to `Window', windows may be grouped by dragging one tab with |
1093 | the middle mouse button and dropping it anywhere on another window. With | 1035 | the middle mouse button and dropping it anywhere on another window. With |
1094 | `Titlebar', the user must drop the tab on the target window's titlebar. | 1036 | `Titlebar', the user must drop the tab on the target window's titlebar. |
1095 | Default: True | 1037 | Default: Window |
1096 | 1038 | ||
1097 | session.titlebar.left: Stick | 1039 | session.titlebar.left: Stick |
1098 | session.titlebar.right: Minimize Maximize Close | 1040 | session.titlebar.right: Minimize Maximize Close |
@@ -1100,8 +1042,9 @@ session.titlebar.right: Minimize Maximize Close | |||
1100 | options are Close, Maximize, MenuIcon, Minimize, Shade, and Stick. | 1042 | options are Close, Maximize, MenuIcon, Minimize, Shade, and Stick. |
1101 | 1043 | ||
1102 | session.modKey: <modifier> | 1044 | session.modKey: <modifier> |
1103 | This specifies which modifier to use to drag and resize windows without | 1045 | This specifies a modifier to use to drag and resize windows without |
1104 | clicking on the border or titlebar. Default: Mod1 | 1046 | clicking on the border or titlebar. For example, Alt + Left click will |
1047 | move windows, and Alt + Right click will resize. Default: Mod1 | ||
1105 | 1048 | ||
1106 | ................................................................................ | 1049 | ................................................................................ |
1107 | 1050 | ||