diff options
author | Pavel Labath <pavelo@centrum.sk> | 2011-08-20 20:05:11 (GMT) |
---|---|---|
committer | Pavel Labath <pavelo@centrum.sk> | 2011-08-20 20:05:11 (GMT) |
commit | 7285bd5f7c5cc7c249969c26ed8f2b060c0714ae (patch) | |
tree | e766b92a96637217fa4462e09ff591e69d64b5a5 | |
parent | f4b482ba09cdf12a1a9472f8f20343e5cc4f1039 (diff) | |
download | fluxbox_pavel-7285bd5f7c5cc7c249969c26ed8f2b060c0714ae.zip fluxbox_pavel-7285bd5f7c5cc7c249969c26ed8f2b060c0714ae.tar.bz2 |
Update resource documentation for lua
Mostly just cosmetic changes reflecting the slight change in syntax. I also took the opportunity
to remove the groupFile resource: it was already marked as deprecated and it wasn't used in a
long time.
-rw-r--r-- | doc/asciidoc/fluxbox.txt | 204 |
1 files changed, 100 insertions, 104 deletions
diff --git a/doc/asciidoc/fluxbox.txt b/doc/asciidoc/fluxbox.txt index 87079b2..3c2d7a7 100644 --- a/doc/asciidoc/fluxbox.txt +++ b/doc/asciidoc/fluxbox.txt | |||
@@ -834,33 +834,37 @@ Usually the *~/.fluxbox/init* resource file is created and maintained by | |||
834 | fluxbox itself. You can use the *Configure Menu*, mentioned above, to set most | 834 | fluxbox itself. You can use the *Configure Menu*, mentioned above, to set most |
835 | of these options. However, we'll cover all of the resource options that are | 835 | of these options. However, we'll cover all of the resource options that are |
836 | available to the user. If you edit this file while fluxbox is running, you must | 836 | available to the user. If you edit this file while fluxbox is running, you must |
837 | ``reconfigure'' to reload the resource options. | 837 | ``reconfigure'' to reload the resource options. This is a lua file, so you can |
838 | use all lua features to set the resources. Just remember that only the final | ||
839 | values of resources matter and your script will get overwritten next time | ||
840 | fluxbox saves the file. | ||
838 | 841 | ||
839 | When running fluxbox in a multiple-screen environment the screen0 key can also | 842 | When running fluxbox in a multiple-screen environment the screen0 key can also |
840 | be screen1, screen2, to customize the behavior of fluxbox on each desktop | 843 | be screen1, screen2, to customize the behavior of fluxbox on each desktop |
841 | accordingly. Here are the resources that are currently available: | 844 | accordingly. Here are the resources that are currently available: |
842 | 845 | ||
843 | *session.screen0.window.{focus|unfocus}.alpha*: 'integer':: | 846 | *session.screen0.window.{focus|unfocus}.alpha* = 'integer':: |
844 | These resources are available to the user to set different levels of | 847 | These resources are available to the user to set different levels of |
845 | transparency for different components of fluxbox. Each one accepts a value | 848 | transparency for different components of fluxbox. Each one accepts a value |
846 | between 0-255, 255 being opaque and 0 being completely transparent. | 849 | between 0-255, 255 being opaque and 0 being completely transparent. |
847 | + | 850 | + |
848 | Default: *255* | 851 | Default: *255* |
849 | 852 | ||
850 | *session.screen0.{slit|toolbar}.autoHide*: 'boolean':: | 853 | *session.screen0.{slit|toolbar}.autoHide* = 'boolean':: |
851 | The autoHide resources allow the user to set the behavior of the toolbar | 854 | The autoHide resources allow the user to set the behavior of the toolbar |
852 | and slit. This behavior can be that they disappear when they are not being | 855 | and slit. This behavior can be that they disappear when they are not being |
853 | used actively by the user, or they remain visible at all times. | 856 | used actively by the user, or they remain visible at all times. |
854 | + | 857 | + |
855 | Default: *False* | 858 | Default: *false* |
856 | 859 | ||
857 | *session.screen0.{slit|toolbar}.layer*: 'layer':: | 860 | *session.screen0.{slit|toolbar}.layer* = 'layer':: |
858 | With these two resources, you can set the layer you want the toolbar and | 861 | With these two resources, you can set the layer you want the toolbar and |
859 | the slit to appear on. Please read the LAYER section for more information. | 862 | the slit to appear on. 'layer' can be either a layer name (in quotes) or a layer |
863 | number. Please read the LAYERS section for more information. | ||
860 | + | 864 | + |
861 | Default: *Dock* | 865 | Default: *"Dock"* |
862 | 866 | ||
863 | *session.screen0.{slit|toolbar}.placement*: 'placement':: | 867 | *session.screen0.{slit|toolbar}.placement* = "'placement'":: |
864 | These allow users to place the slit and toolbar where they like. | 868 | These allow users to place the slit and toolbar where they like. |
865 | + | 869 | + |
866 | -- | 870 | -- |
@@ -869,19 +873,19 @@ Possible options are:;; | |||
869 | *RightBottom* *RightCenter* *RightTop* *TopLeft* *TopCenter* *TopRight* | 873 | *RightBottom* *RightCenter* *RightTop* *TopLeft* *TopCenter* *TopRight* |
870 | -- | 874 | -- |
871 | + | 875 | + |
872 | Slit default: *RightBottom* | 876 | Slit default: *"RightBottom"* |
873 | + | 877 | + |
874 | Toolbar default: *BottomCenter* | 878 | Toolbar default: *"BottomCenter"* |
875 | 879 | ||
876 | *session.screen0.{slit|toolbar|tabs}.maxOver*: 'boolean':: | 880 | *session.screen0.{slit|toolbar|tabs}.maxOver* = 'boolean':: |
877 | Setting these to True will allow application windows to maximize over the | 881 | Setting these to true will allow application windows to maximize over the |
878 | complete screen. Setting to False allows the slit, toolbar, and external | 882 | complete screen. Setting to false allows the slit, toolbar, and external |
879 | tabs to hold their territory and will always be visible when an | 883 | tabs to hold their territory and will always be visible when an |
880 | application is maximized. | 884 | application is maximized. |
881 | + | 885 | + |
882 | Default: *False* | 886 | Default: *false* |
883 | 887 | ||
884 | *session.screen0.slit.clientList* = { 'string', 'string', ... }:: | 888 | *session.screen0.slit.clientList* = { "'string'", "'string'", ... }:: |
885 | This resource is available for those that use dockapps in the slit. It helps | 889 | This resource is available for those that use dockapps in the slit. It helps |
886 | fluxbox keep track of the *order* of the dockapps when in the slit. | 890 | fluxbox keep track of the *order* of the dockapps when in the slit. |
887 | + | 891 | + |
@@ -896,25 +900,25 @@ instances of fluxbox. It is a simple list of window names, as given by | |||
896 | + | 900 | + |
897 | Default: *{}* | 901 | Default: *{}* |
898 | 902 | ||
899 | *session.screen0.toolbar.height*: 'integer':: | 903 | *session.screen0.toolbar.height* = 'integer':: |
900 | Set the height of the toolbar. If the value is set to 0, the style file | 904 | Set the height of the toolbar. If the value is set to 0, the style file |
901 | will gain control over the toolbar height. It is possible to set a fixed | 905 | will gain control over the toolbar height. It is possible to set a fixed |
902 | height by changing this value to something greater than 0. | 906 | height by changing this value to something greater than 0. |
903 | + | 907 | + |
904 | Default: *0* | 908 | Default: *0* |
905 | 909 | ||
906 | *session.screen0.toolbar.visible*: 'boolean':: | 910 | *session.screen0.toolbar.visible* = 'boolean':: |
907 | The user can set whether they want to have a toolbar on screen at all. | 911 | The user can set whether they want to have a toolbar on screen at all. |
908 | Setting to False removes the toolbar from the screen. | 912 | Setting to false removes the toolbar from the screen. |
909 | + | 913 | + |
910 | Default: *True* | 914 | Default: *true* |
911 | 915 | ||
912 | *session.screen0.toolbar.widthPercent*: 'integer':: | 916 | *session.screen0.toolbar.widthPercent* = 'integer':: |
913 | This resource sets the width percentage of the toolbar on the screen. | 917 | This resource sets the width percentage of the toolbar on the screen. |
914 | + | 918 | + |
915 | Default: *100* | 919 | Default: *100* |
916 | 920 | ||
917 | *session.screen0.toolbar.tools*: 'tools':: | 921 | *session.screen0.toolbar.tools* = "'tools'":: |
918 | This resource specifies the tools plugged into the toolbar. Read the | 922 | This resource specifies the tools plugged into the toolbar. Read the |
919 | TOOLBAR section in this manual for a description of each of these. | 923 | TOOLBAR section in this manual for a description of each of these. |
920 | They may be specified in any order, delimited by the *,* character. | 924 | They may be specified in any order, delimited by the *,* character. |
@@ -925,36 +929,36 @@ Possible tools:;; | |||
925 | *systemtray* *workspacename* | 929 | *systemtray* *workspacename* |
926 | + | 930 | + |
927 | Default:;; | 931 | Default:;; |
928 | *workspacename, prevworkspace, nextworkspace, iconbar, prevwindow, nextwindow, | 932 | *"workspacename, prevworkspace, nextworkspace, iconbar, prevwindow, nextwindow, |
929 | systemtray, clock* | 933 | systemtray, clock"* |
930 | 934 | ||
931 | *session.screen0.{slit|toolbar}.onhead*: 'integer':: | 935 | *session.screen0.{slit|toolbar}.onhead* = 'integer':: |
932 | For those that use xinerama, users can set this value to the number of the | 936 | For those that use xinerama, users can set this value to the number of the |
933 | head where they would like to see the slit and toolbar, starting from 1. | 937 | head where they would like to see the slit and toolbar, starting from 1. |
934 | Setting this to 0 will ignore xinerama information. | 938 | Setting this to 0 will ignore xinerama information. |
935 | + | 939 | + |
936 | Default: *0* for slit, *1* for toolbar | 940 | Default: *0* for slit, *1* for toolbar |
937 | 941 | ||
938 | *session.screen0.iconbar.mode*: 'pattern':: | 942 | *session.screen0.iconbar.mode* = "'pattern'":: |
939 | This determines which windows will be displayed in the iconbar. Any window | 943 | This determines which windows will be displayed in the iconbar. Any window |
940 | pattern is acceptable. See the section *CLIENT PATTERNS* in either | 944 | pattern is acceptable. See the section *CLIENT PATTERNS* in either |
941 | *fluxbox-keys(5)* or *fluxbox-apps(5)* for details. | 945 | *fluxbox-keys(5)* or *fluxbox-apps(5)* for details. |
942 | + | 946 | + |
943 | Default: *{static groups} (workspace)* | 947 | Default: *"{static groups} (workspace)"* |
944 | 948 | ||
945 | *session.screen0.iconbar.usePixmap*: 'boolean':: | 949 | *session.screen0.iconbar.usePixmap* = 'boolean':: |
946 | This is also set in the Iconbar Mode menu. When set to True, this will | 950 | This is also set in the Iconbar Mode menu. When set to true, this will |
947 | show the native icon of applications. | 951 | show the native icon of applications. |
948 | + | 952 | + |
949 | Default: *True* | 953 | Default: *true* |
950 | 954 | ||
951 | *session.screen0.iconbar.iconTextPadding*: 'integer':: | 955 | *session.screen0.iconbar.iconTextPadding* = 'integer':: |
952 | This specifies the space between the window title and the edge of the | 956 | This specifies the space between the window title and the edge of the |
953 | button. | 957 | button. |
954 | + | 958 | + |
955 | Default: *10* | 959 | Default: *10* |
956 | 960 | ||
957 | *session.screen0.iconbar.alignment*: 'position':: | 961 | *session.screen0.iconbar.alignment* = "'position'":: |
958 | This value should be changed in the Iconbar Mode menu. | 962 | This value should be changed in the Iconbar Mode menu. |
959 | + | 963 | + |
960 | -- | 964 | -- |
@@ -964,101 +968,101 @@ Available options:;; | |||
964 | - *Right*: Fixed width, aligned right | 968 | - *Right*: Fixed width, aligned right |
965 | -- | 969 | -- |
966 | + | 970 | + |
967 | Default: *Relative* | 971 | Default: *"Relative"* |
968 | 972 | ||
969 | *session.screen0.iconbar.iconWidth*: 'integer':: | 973 | *session.screen0.iconbar.iconWidth* = 'integer':: |
970 | Used to specify the iconbar button width for Left/Right alignment. | 974 | Used to specify the iconbar button width for Left/Right alignment. |
971 | + | 975 | + |
972 | Default: *128* | 976 | Default: *128* |
973 | 977 | ||
974 | *session.screen0.strftimeFormat*: 'date':: | 978 | *session.screen0.strftimeFormat* = "'date'":: |
975 | This adjusts the way the current time is displayed in the toolbar. The | 979 | This adjusts the way the current time is displayed in the toolbar. The |
976 | *strftime(3)* format is used. | 980 | *strftime(3)* format is used. |
977 | + | 981 | + |
978 | Default: *%k:%M* | 982 | Default: *"%k:%M"* |
979 | 983 | ||
980 | *session.screen0.tabs.intitlebar*: 'boolean':: | 984 | *session.screen0.tabs.intitlebar* = 'boolean':: |
981 | This specifies whether tabs should be embedded in the titlebar or placed | 985 | This specifies whether tabs should be embedded in the titlebar or placed |
982 | outside the window. | 986 | outside the window. |
983 | + | 987 | + |
984 | Default: *True* | 988 | Default: *true* |
985 | 989 | ||
986 | *session.screen0.tab.placement*: 'placement':: | 990 | *session.screen0.tab.placement* = "'placement'":: |
987 | This specifies where external tabs will appear on the window. It has the same | 991 | This specifies where external tabs will appear on the window. It has the same |
988 | possible values as *sesion.screen0.{slit|toolbar}.placement*. | 992 | possible values as *sesion.screen0.{slit|toolbar}.placement*. |
989 | + | 993 | + |
990 | Default: *TopLeft* | 994 | Default: *"TopLeft"* |
991 | 995 | ||
992 | *session.screen0.tab.width*: 'integer':: | 996 | *session.screen0.tab.width* = 'integer':: |
993 | This specifies the width of external tabs in pixels. | 997 | This specifies the width of external tabs in pixels. |
994 | + | 998 | + |
995 | Default: *64* | 999 | Default: *64* |
996 | 1000 | ||
997 | *session.screen0.focusModel*: *ClickToFocus|MouseFocus|StrictMouseFocus*:: | 1001 | *session.screen0.focusModel* = *"ClickToFocus"|"MouseFocus"|"StrictMouseFocus"*:: |
998 | This controls how windows gain focus via the mouse. With `ClickToFocus', | 1002 | This controls how windows gain focus via the mouse. With `ClickToFocus', |
999 | the user must click on the window. With `MouseFocus', windows gain focus | 1003 | the user must click on the window. With `MouseFocus', windows gain focus |
1000 | whenever the mouse moves over them, but only when the mouse is moving. With | 1004 | whenever the mouse moves over them, but only when the mouse is moving. With |
1001 | `StrictMouseFocus', windows gain focus whenever the mouse enters any exposed | 1005 | `StrictMouseFocus', windows gain focus whenever the mouse enters any exposed |
1002 | area, even if this is due to layer changes, window movement, changing desktops, closing windows, etc. | 1006 | area, even if this is due to layer changes, window movement, changing desktops, closing windows, etc. |
1003 | + | 1007 | + |
1004 | Default: *ClickToFocus* | 1008 | Default: *"ClickToFocus"* |
1005 | 1009 | ||
1006 | *session.screen0.autoRaise*: 'boolean':: | 1010 | *session.screen0.autoRaise* = 'boolean':: |
1007 | When True, this setting automatically raises any window that gains focus. | 1011 | When true, this setting automatically raises any window that gains focus. |
1008 | + | 1012 | + |
1009 | Default: *True* | 1013 | Default: *true* |
1010 | 1014 | ||
1011 | *session.autoRaiseDelay*: 'integer':: | 1015 | *session.autoRaiseDelay* = 'integer':: |
1012 | Adjusts the delay (in milli-sec) before focused windows will raise | 1016 | Adjusts the delay (in milli-sec) before focused windows will raise |
1013 | when using the Autoraise option. | 1017 | when using the Autoraise option. |
1014 | + | 1018 | + |
1015 | Default: *250* | 1019 | Default: *250* |
1016 | 1020 | ||
1017 | *session.screen0.clickRaises*: 'boolean':: | 1021 | *session.screen0.clickRaises* = 'boolean':: |
1018 | This setting allows a user to click anywhere on a window to bring it on | 1022 | This setting allows a user to click anywhere on a window to bring it on |
1019 | top of other windows. Otherwise, only the titlebar will work. | 1023 | top of other windows. Otherwise, only the titlebar will work. |
1020 | + | 1024 | + |
1021 | Default: *True* | 1025 | Default: *true* |
1022 | 1026 | ||
1023 | *session.screen0.workspacewarping*: 'boolean':: | 1027 | *session.screen0.workspacewarping* = 'boolean':: |
1024 | This setting enables a user to change workspaces by dragging a window | 1028 | This setting enables a user to change workspaces by dragging a window |
1025 | across the edge of the screen. | 1029 | across the edge of the screen. |
1026 | + | 1030 | + |
1027 | Default: *True* | 1031 | Default: *true* |
1028 | 1032 | ||
1029 | *session.screen0.showwindowposition*: 'boolean':: | 1033 | *session.screen0.showwindowposition* = 'boolean':: |
1030 | Setting this resource to True shows the user, in a little window, | 1034 | Setting this resource to true shows the user, in a little window, |
1031 | the exact position of the application window while the user is | 1035 | the exact position of the application window while the user is |
1032 | dragging it. Allows a precise placement of windows on a screen. | 1036 | dragging it. Allows a precise placement of windows on a screen. |
1033 | + | 1037 | + |
1034 | Default: *False* | 1038 | Default: *false* |
1035 | 1039 | ||
1036 | *session.screen0.defaultDeco*: 'string':: | 1040 | *session.screen0.defaultDeco* = "'string'":: |
1037 | This specifies the default window decorations, according to the same | 1041 | This specifies the default window decorations, according to the same |
1038 | options available to the *[Deco]* option in the `apps' file, described in | 1042 | options available to the *[Deco]* option in the `apps' file, described in |
1039 | *fluxbox-apps(5)*. | 1043 | *fluxbox-apps(5)*. |
1040 | + | 1044 | + |
1041 | Default: *NORMAL* | 1045 | Default: *"NORMAL"* |
1042 | 1046 | ||
1043 | *session.screen0.menuDelay*: 'integer':: | 1047 | *session.screen0.menuDelay* = 'integer':: |
1044 | This sets the delay in milliseconds for submenus to open when you hover | 1048 | This sets the delay in milliseconds for submenus to open when you hover |
1045 | over them or to close when you hover over another item. | 1049 | over them or to close when you hover over another item. |
1046 | + | 1050 | + |
1047 | Default: *200* | 1051 | Default: *200* |
1048 | 1052 | ||
1049 | *session.screen0.focusNewWindows*: 'boolean':: | 1053 | *session.screen0.focusNewWindows* = 'boolean':: |
1050 | This sets whether or not new windows will become focused automatically. | 1054 | This sets whether or not new windows will become focused automatically. |
1051 | + | 1055 | + |
1052 | Default: *True* | 1056 | Default: *true* |
1053 | 1057 | ||
1054 | *session.screen0.workspaceNames*: 'names':: | 1058 | *session.screen0.workspaceNames* = { "'string'", "'string'", ... }:: |
1055 | Here is where the user can name their workspaces, in a comma-delimited list. | 1059 | Here is where the user can name their workspaces, in a lua array. |
1056 | However it is recommended to use the tool available in the Workspace Menu to set | 1060 | However it is recommended to use the tool available in the Workspace Menu to set |
1057 | these. | 1061 | these. |
1058 | + | 1062 | + |
1059 | Default: *Workspace 1, Workspace 2, Workspace 3, Workspace 4* | 1063 | Default: *{ "Workspace 1", "Workspace 2", "Workspace 3", "Workspace 4" }* |
1060 | 1064 | ||
1061 | *session.screen0.edgeSnapThreshold*: 'integer':: | 1065 | *session.screen0.edgeSnapThreshold* = 'integer':: |
1062 | When moving a window across your screen, fluxbox is able to have it `snap' | 1066 | When moving a window across your screen, fluxbox is able to have it `snap' |
1063 | to the edges of the screen and other windows for easy placement. This | 1067 | to the edges of the screen and other windows for easy placement. This |
1064 | variable tells fluxbox the distance (in pixels) at which the window will | 1068 | variable tells fluxbox the distance (in pixels) at which the window will |
@@ -1066,7 +1070,7 @@ jump to the edge. | |||
1066 | + | 1070 | + |
1067 | Default: *10* | 1071 | Default: *10* |
1068 | 1072 | ||
1069 | *session.screen0.windowPlacement*: 'strategy':: | 1073 | *session.screen0.windowPlacement* = "'strategy'":: |
1070 | This resource specifies where to place new windows when not otherwise | 1074 | This resource specifies where to place new windows when not otherwise |
1071 | specified (by the program or the `apps' file, for example). | 1075 | specified (by the program or the `apps' file, for example). |
1072 | + | 1076 | + |
@@ -1078,53 +1082,53 @@ Available strategies:;; | |||
1078 | - UnderMousePlacement: places new windows underneath the mouse | 1082 | - UnderMousePlacement: places new windows underneath the mouse |
1079 | -- | 1083 | -- |
1080 | + | 1084 | + |
1081 | Default: *RowSmartPlacement* | 1085 | Default: *"RowSmartPlacement"* |
1082 | 1086 | ||
1083 | *session.screen0.rowPlacementDirection*: *LeftToRight*|*RightToLeft*:: | 1087 | *session.screen0.rowPlacementDirection* = *"LeftToRight"*|*"RightToLeft"*:: |
1084 | These settings control the direction in which windows are tiled using the | 1088 | These settings control the direction in which windows are tiled using the |
1085 | RowSmartPlacement and ColSmartPlacement strategies described above. | 1089 | RowSmartPlacement and ColSmartPlacement strategies described above. |
1086 | + | 1090 | + |
1087 | Default: *LeftToRight* | 1091 | Default: *"LeftToRight"* |
1088 | 1092 | ||
1089 | *session.screen0.colPlacementDirection*: *TopToBottom*|*BottomToTop*:: | 1093 | *session.screen0.colPlacementDirection* = *"TopToBottom"*|*"BottomToTop"*:: |
1090 | These settings control the direction in which windows are tiled using the | 1094 | These settings control the direction in which windows are tiled using the |
1091 | RowSmartPlacement and ColSmartPlacement strategies described above. | 1095 | RowSmartPlacement and ColSmartPlacement strategies described above. |
1092 | + | 1096 | + |
1093 | Default: *TopToBottom* | 1097 | Default: *"TopToBottom"* |
1094 | 1098 | ||
1095 | *session.screen0.fullMaximization*: 'boolean':: | 1099 | *session.screen0.fullMaximization* = 'boolean':: |
1096 | If this setting is enabled, windows will maximize over the toolbar, slit, | 1100 | If this setting is enabled, windows will maximize over the toolbar, slit, |
1097 | and any other window that creates a strut, no matter what their individual | 1101 | and any other window that creates a strut, no matter what their individual |
1098 | settings are. | 1102 | settings are. |
1099 | + | 1103 | + |
1100 | Default: *False* | 1104 | Default: *false* |
1101 | 1105 | ||
1102 | *session.screen0.opaqueMove*: 'boolean':: | 1106 | *session.screen0.opaqueMove* = 'boolean':: |
1103 | When moving a window, setting this to True will draw the window | 1107 | When moving a window, setting this to true will draw the window |
1104 | contents as it moves (this is nasty on slow systems). If False, it | 1108 | contents as it moves (this is nasty on slow systems). If false, it |
1105 | will only draw an outline of the window border. | 1109 | will only draw an outline of the window border. |
1106 | + | 1110 | + |
1107 | Default: *True* | 1111 | Default: *true* |
1108 | 1112 | ||
1109 | *session.screen0.workspaces*: 'integer':: | 1113 | *session.screen0.workspaces* = 'integer':: |
1110 | Set this to the number of workspaces the users wants. | 1114 | Set this to the number of workspaces the users wants. |
1111 | + | 1115 | + |
1112 | Default: *4* | 1116 | Default: *4* |
1113 | 1117 | ||
1114 | *session.cacheLife*: 'minutes':: | 1118 | *session.cacheLife* = 'minutes':: |
1115 | This tells fluxbox how long unused pixmaps may stay in the X | 1119 | This tells fluxbox how long unused pixmaps may stay in the X |
1116 | server's memory. | 1120 | server's memory. |
1117 | + | 1121 | + |
1118 | Default: *5* | 1122 | Default: *5* |
1119 | 1123 | ||
1120 | *session.cacheMax*: 'KbSize':: | 1124 | *session.cacheMax* = 'KbSize':: |
1121 | This tells fluxbox how much memory it may use to store cached | 1125 | This tells fluxbox how much memory it may use to store cached |
1122 | pixmaps on the X server. If your machine runs short of memory, you may | 1126 | pixmaps on the X server. If your machine runs short of memory, you may |
1123 | lower this value. | 1127 | lower this value. |
1124 | + | 1128 | + |
1125 | Default: *200* | 1129 | Default: *200* |
1126 | 1130 | ||
1127 | *session.colorsPerChannel*: 'integer':: | 1131 | *session.colorsPerChannel* = 'integer':: |
1128 | This tells fluxbox how many colors to take from the X server on | 1132 | This tells fluxbox how many colors to take from the X server on |
1129 | pseudo-color displays. A channel would be red, green, or blue. fluxbox | 1133 | pseudo-color displays. A channel would be red, green, or blue. fluxbox |
1130 | will allocate this variable ^ 3 and make them always available. Value must | 1134 | will allocate this variable ^ 3 and make them always available. Value must |
@@ -1133,83 +1137,75 @@ resource to 4. | |||
1133 | + | 1137 | + |
1134 | Default: *4* | 1138 | Default: *4* |
1135 | 1139 | ||
1136 | *session.doubleClickInterval*: 'integer':: | 1140 | *session.doubleClickInterval* = 'integer':: |
1137 | Adjust the delay in milliseconds between mouse clicks for fluxbox to | 1141 | Adjust the delay in milliseconds between mouse clicks for fluxbox to |
1138 | consider a double click. | 1142 | consider a double click. |
1139 | + | 1143 | + |
1140 | Default: *250* | 1144 | Default: *250* |
1141 | 1145 | ||
1142 | *session.forcePseudoTransparency*: 'boolean':: | 1146 | *session.forcePseudoTransparency* = 'boolean':: |
1143 | If you have Xorg's composite extension enabled, this setting will force | 1147 | If you have Xorg's composite extension enabled, this setting will force |
1144 | the menu, windows, toolbar, and slit to use pseudo-transparency instead of | 1148 | the menu, windows, toolbar, and slit to use pseudo-transparency instead of |
1145 | true transparency. | 1149 | true transparency. |
1146 | + | 1150 | + |
1147 | Default: *False* | 1151 | Default: *false* |
1148 | 1152 | ||
1149 | *session.ignoreBorder*: 'boolean':: | 1153 | *session.ignoreBorder* = 'boolean':: |
1150 | This configures the ability to move windows by dragging the border. | 1154 | This configures the ability to move windows by dragging the border. |
1151 | + | 1155 | + |
1152 | Default: *False* | 1156 | Default: *false* |
1153 | 1157 | ||
1154 | *session.tabPadding*: 'integer':: | 1158 | *session.tabPadding* = 'integer':: |
1155 | This specifies the spacing between tabs. | 1159 | This specifies the spacing between tabs. |
1156 | + | 1160 | + |
1157 | Default: *0* | 1161 | Default: *0* |
1158 | 1162 | ||
1159 | *session.tabsAttachArea*: *Window|Titlebar*:: | 1163 | *session.tabsAttachArea* = *"Window"|"Titlebar"*:: |
1160 | With this set to `Window', windows may be grouped by dragging one tab with | 1164 | With this set to `Window', windows may be grouped by dragging one tab with |
1161 | the middle mouse button and dropping it anywhere on another window. With | 1165 | the middle mouse button and dropping it anywhere on another window. With |
1162 | `Titlebar', the user must drop the tab on the target window's titlebar. | 1166 | `Titlebar', the user must drop the tab on the target window's titlebar. |
1163 | + | 1167 | + |
1164 | Default: *Window* | 1168 | Default: *"Window"* |
1165 | 1169 | ||
1166 | *session.titlebar.{left|right}*: 'buttons':: | 1170 | *session.titlebar.{left|right}* = { "'button'", "'button'", ... }:: |
1167 | The buttons or icons to place in the titlebar of decorated windows. You | 1171 | The buttons or icons to place in the titlebar of decorated windows. You |
1168 | may specify any number, space-delimited. | 1172 | may specify any number, in a lua array. |
1169 | + | 1173 | + |
1170 | -- | 1174 | -- |
1171 | The available options are:;; | 1175 | The available options are:;; |
1172 | *Close* *Maximize* *MenuIcon* *Minimize* *Shade* *Stick* | 1176 | *Close* *Maximize* *MenuIcon* *Minimize* *Shade* *Stick* |
1173 | -- | 1177 | -- |
1174 | + | 1178 | + |
1175 | Default left: *Stick* | 1179 | Default left: *{ "Stick" }* |
1176 | + | 1180 | + |
1177 | Default right: *Shade Minimize Maximize Close* | 1181 | Default right: *{ "Shade", "Minimize", "Maximize", "Close" }* |
1178 | 1182 | ||
1179 | All of the 'location' resources following require a pathname to their specific | 1183 | All of the 'location' resources following require a pathname to their specific |
1180 | files. This is where you can specify different files. Most of the defaults will | 1184 | files. This is where you can specify different files. Most of the defaults will |
1181 | be located in the user's *~/.fluxbox* directory. | 1185 | be located in the user's *~/.fluxbox* directory. |
1182 | 1186 | ||
1183 | *session.appsFile*: 'location':: | 1187 | *session.appsFile* = "'location'":: |
1184 | Location of persistent application settings, or the `apps' file. See the | 1188 | Location of persistent application settings, or the `apps' file. See the |
1185 | *Remember...* item in the *Window Menu* section above or *fluxbox-apps(5)* | 1189 | *Remember...* item in the *Window Menu* section above or *fluxbox-apps(5)* |
1186 | for details. | 1190 | for details. |
1187 | 1191 | ||
1188 | *session.groupFile*: 'location':: | 1192 | *session.keyFile* = "'location'":: |
1189 | Deprecated, auto-grouping is now done in the `apps' file, see | ||
1190 | *fluxbox-apps(5)* for details. | ||
1191 | |||
1192 | *session.keyFile*: 'location':: | ||
1193 | Location of the keyboard mapping settings, or the `keys' file. | 1193 | Location of the keyboard mapping settings, or the `keys' file. |
1194 | See *fluxbox-keys(5)* for details. | 1194 | See *fluxbox-keys(5)* for details. |
1195 | 1195 | ||
1196 | *session.menuFile*: 'location':: | 1196 | *session.menuFile* = "'location'":: |
1197 | Location of the Root Menu file. | 1197 | Location of the Root Menu file. |
1198 | See *fluxbox-menu(5)* for details. | 1198 | See *fluxbox-menu(5)* for details. |
1199 | 1199 | ||
1200 | *session.slitlistFile*: 'location':: | 1200 | *session.styleFile* = "'location'":: |
1201 | Location of the file used to remember slit client ordering. | ||
1202 | See *SLIT* above for details. | ||
1203 | |||
1204 | *session.styleFile*: 'location':: | ||
1205 | Location of the currently selected style. | 1201 | Location of the currently selected style. |
1206 | See *fluxbox-style(5)* for details. | 1202 | See *fluxbox-style(5)* for details. |
1207 | 1203 | ||
1208 | *session.styleOverlay*: 'location':: | 1204 | *session.styleOverlay* = "'location'":: |
1209 | Location of the style overlay file. | 1205 | Location of the style overlay file. |
1210 | See *fluxbox-style(5)* for details. | 1206 | See *fluxbox-style(5)* for details. |
1211 | 1207 | ||
1212 | *session.screen0.windowMenu*: 'location':: | 1208 | *session.screen0.windowMenu* = "'location'":: |
1213 | This optionally specifies the location of a user-defined window menu. If left | 1209 | This optionally specifies the location of a user-defined window menu. If left |
1214 | blank, it will use *~/.fluxbox/windowmenu*. | 1210 | blank, it will use *~/.fluxbox/windowmenu*. |
1215 | + | 1211 | + |