summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJim Ramsay <i.am@jimramsay.com>2009-02-20 19:23:09 (GMT)
committerJim Ramsay <i.am@jimramsay.com>2009-05-26 20:16:07 (GMT)
commit42f2b03f604788b0b95265c89596b0c8472d5807 (patch)
treeca9c0f72a357fc84d14343234c1781b48e921b65
parentce1fb1cf8e56f21051e15257e8198d7a5c5b49e5 (diff)
downloadfluxbox_lack-42f2b03f604788b0b95265c89596b0c8472d5807.zip
fluxbox_lack-42f2b03f604788b0b95265c89596b0c8472d5807.tar.bz2
Updated formatting for RESOURCES and ENVIRONMENT
-rw-r--r--doc/asciidoc/fluxbox.txt621
-rw-r--r--doc/fluxbox.1.in838
2 files changed, 932 insertions, 527 deletions
diff --git a/doc/asciidoc/fluxbox.txt b/doc/asciidoc/fluxbox.txt
index 40e6090..da8d45d 100644
--- a/doc/asciidoc/fluxbox.txt
+++ b/doc/asciidoc/fluxbox.txt
@@ -862,274 +862,371 @@ When running fluxbox in a multiple-screen environment the screen0 key can also
862be screen1, screen2, to customize the behavior of fluxbox on each desktop 862be screen1, screen2, to customize the behavior of fluxbox on each desktop
863accordingly. Here are the resources that are currently available: 863accordingly. Here are the resources that are currently available:
864 864
865................................................................................ 865*session.screen0.window.{focus|unfocus}.alpha*: 'integer'::
866session.screen0.window.focus.alpha: <integer> 866These resources are available to the user to set different levels of
867session.screen0.window.unfocus.alpha: <integer> 867transparency for different components of fluxbox. Each one accepts a value
868 These resources are available to the user to set different levels of 868between 0-255, 255 being opaque and 0 being completely transparent.
869 transparency for different components of fluxbox. Each one accepts a value 869+
870 between 0-255, 255 being opaque and 0 being completely transparent. 870Default: *255*
871 Default: 255 871
872 872*session.screen0.{slit|toolbar}.autoHide*: 'boolean'::
873session.screen0.slit.autoHide: <boolean> 873The autoHide resources allow the user to set the behavior of the toolbar
874session.screen0.toolbar.autoHide: <boolean> 874and slit. This behavior can be that they disappear when they are not being
875 The autoHide resources allow the user to set the behavior of the toolbar 875used actively by the user, or they remain visible at all times.
876 and slit. This behavior can be that they disappear when they are not being 876+
877 used actively by the user, or they remain visible at all times. Default: 877Default: *False*
878 False 878
879 879*session.screen0.{slit|toolbar}.layer*: 'layer'::
880session.screen0.slit.layer: <layer> 880With these two resources, you can set the layer you want the toolbar and
881session.screen0.toolbar.layer: <layer> 881the slit to appear on. Please read the LAYER section for more information.
882 With these two resources, you can set the layer you want the toolbar and 882+
883 the slit to appear on. Please read the LAYER section for more information. 883Default: *Dock*
884 Default: Dock 884
885 885*session.screen0.{slit|toolbar}.placement*: 'placement'::
886session.screen0.slit.placement: <placement> 886These allow users to place the slit and toolbar where they like.
887session.screen0.toolbar.placement: <placement> 887+
888 These allow users to place the slit and toolbar where they like. Possible 888--
889 options are: 889Possible options are:;;
890 - BottomLeft 890 *BottomLeft* *BottomCenter* *BottomRight* *LeftBottom* *LeftCenter* *LeftTop*
891 - BottomCenter 891 *RightBottom* *RightCenter* *RightTop* *TopLeft* *TopCenter* *TopRight*
892 - BottomRight 892--
893 - LeftBottom 893+
894 - LeftCenter 894Slit default: *TopRight*
895 - LeftTop 895+
896 - RightBottom 896Toolbar default: *BottomCenter*
897 - RightCenter 897
898 - RightTop 898*session.screen0.{slit|toolbar|tabs}.maxOver*: 'boolean'::
899 - TopLeft 899Setting these to True will allow application windows to maximize over the
900 - TopCenter 900complete screen. Setting to False allows the slit, toolbar, and external
901 - TopRight 901tabs to hold their territory and will always be visible when an
902 902application is maximized.
903session.screen0.slit.maxOver: <boolean> 903+
904session.screen0.toolbar.maxOver: <boolean> 904Default: *False*
905session.screen0.tabs.maxOver: <boolean> 905
906 Setting these to True will allow application windows to maximize over the 906*session.screen0.toolbar.height*: 'integer'::
907 complete screen. Setting to False allows the slit, toolbar, and external 907Set the height of the toolbar. If the value is set to 0, the style file
908 tabs to hold their territory and will always be visible when an 908will gain control over the toolbar height. It is possible to set a fixed
909 application is maximized. Default: False 909height by changing this value to something greater than 0.
910 910+
911session.screen0.toolbar.height: <integer> 911Default: *0*
912 Set the height of the toolbar. If the value is set to 0, the style file 912
913 will gain control over the toolbar height. It is possible to set a fixed 913*session.screen0.toolbar.visible*: 'boolean'::
914 height by changing this value to something greater than 0. Default: 0 914The user can set whether they want to have a toolbar on screen at all.
915 915Setting to False removes the toolbar from the screen.
916session.screen0.toolbar.visible: <boolean> 916+
917 The user can set whether they want to have a toolbar on screen at all. 917Default: *True*
918 Setting to False removes the toolbar from the screen. Default: True 918
919 919*session.screen0.toolbar.widthPercent*: 'integer'::
920session.screen0.toolbar.widthPercent: <integer> 920This resource sets the width percentage of the toolbar on the screen.
921 This resource sets the width percentage of the toolbar on the screen. 921+
922 Default: 100 922Default: *100*
923 923
924session.screen0.toolbar.tools: <tools> 924*session.screen0.toolbar.tools*: 'tools'::
925 This resource specifies the tools plugged into the toolbar. Read the 925This resource specifies the tools plugged into the toolbar. Read the
926 TOOLBAR section in this manual for a description of each of these. 926TOOLBAR section in this manual for a description of each of these.
927 They may be specified in any order, delimited by the ',' character. 927They may be specified in any order, delimited by the *,* character.
928 They will appear in the order given. 928They will appear in the order given.
929 Possible tools:: 929+
930 - clock 930Possible tools:;;
931 - iconbar 931*clock* *iconbar* *nextwindow* *prevwindow* *nextworkspace* *prevworkspace*
932 - nextwindow 932*systemtray* *workspacename*
933 - prevwindow 933+
934 - nextworkspace 934Default:;;
935 - prevworkspace 935*workspacename, prevworkspace, nextworkspace, iconbar, prevwindow, nextwindow,
936 - systemtray 936systemtray, clock*
937 - workspacename 937
938 938*session.screen0.{slit|toolbar}.onhead*: 'integer'::
939session.screen0.slit.onhead: <integer> 939For those that use xinerama, users can set this value to the number of the
940session.screen0.toolbar.onhead: <integer> 940head where they would like to see the slit and toolbar, starting from 1.
941 For those that use xinerama, users can set this value to the number of the 941Setting this to 0 will ignore xinerama information.
942 head where they would like to see the slit and toolbar, starting from 1. 942+
943 Setting this to 0 will ignore xinerama information. Default: 0 943Default: *0*
944 944
945session.screen0.iconbar.mode: <pattern> 945*session.screen0.iconbar.mode*: 'pattern'::
946 This determines which windows will be displayed in the iconbar. Any window 946This determines which windows will be displayed in the iconbar. Any window
947 pattern available to the Next/PrevWindow keybindings is acceptable. 947pattern is acceptable. See the section *CLIENT PATTERNS* in either
948 Default: {static groups} (workspace) 948*fluxbox-keys(5)* or *fluxbox-apps(5)* for details.
949 949+
950session.screen0.iconbar.usePixmap: <boolean> 950Default: *{static groups} (workspace)*
951 This is also set in the Iconbar Mode menu. When set to True, this will 951
952 show the native icon of applications. Default: True 952*session.screen0.iconbar.usePixmap*: 'boolean'::
953 953This is also set in the Iconbar Mode menu. When set to True, this will
954session.screen0.iconbar.iconTextPadding: <integer> 954show the native icon of applications.
955 This specifies the space between the window title and the edge of the 955+
956 button. Default: 10 956Default: *True*
957 957
958session.screen0.iconbar.alignment: <position> 958*session.screen0.iconbar.iconTextPadding*: 'integer'::
959 This value should be changed in the Iconbar Mode menu. Default: 959This specifies the space between the window title and the edge of the
960 Relative 960button.
961 961+
962 Available options: 962Default: *10*
963 - Left: Fixed width, aligned left 963
964 - Relative: Width varies to fill the iconbar 964*session.screen0.iconbar.alignment*: 'position'::
965 - Right: Fixed width, aligned right 965This value should be changed in the Iconbar Mode menu.
966 966+
967session.screen0.iconbar.iconWidth: <integer> 967--
968 Used to specify the iconbar button width for Left/Right alignment. 968Available options:;;
969 Default: 128 969- *Left*: Fixed width, aligned left
970 970- *Relative*: Width varies to fill the iconbar
971session.screen0.strftimeFormat: <date> 971- *Right*: Fixed width, aligned right
972 This adjusts the way the current time is displayed in the toolbar. The 972--
973 strftime(3) format is used. Default: %I:%M %p 973+
974 974Default: *Relative*
975session.screen0.tabs.intitlebar: <boolean> 975
976 This specifies whether tabs should be embedded in the titlebar or placed 976*session.screen0.iconbar.iconWidth*: 'integer'::
977 outside the window. Default: True 977Used to specify the iconbar button width for Left/Right alignment.
978 978+
979session.screen0.tab.placement: <placement> 979Default: *128*
980 This specifies where external tabs will appear on the window. Default: 980
981 TopLeft 981*session.screen0.strftimeFormat*: 'date'::
982 982This adjusts the way the current time is displayed in the toolbar. The
983session.screen0.tab.width: <integer> 983*strftime(3)* format is used.
984 This specifies the width of external tabs in pixels. Default: 64 984+
985 985Default: *%I:%M %p*
986session.screen0.focusModel: ClickToFocus|MouseFocus 986
987 This controls how windows gain focus via the mouse. With `ClickToFocus', 987*session.screen0.tabs.intitlebar*: 'boolean'::
988 the user must click on the window. With `MouseFocus', windows gain focus 988This specifies whether tabs should be embedded in the titlebar or placed
989 whenever the mouse moves over them. Default: ClickToFocus 989outside the window.
990+
991Default: *True*
992
993*session.screen0.tab.placement*: 'placement'::
994This specifies where external tabs will appear on the window. It has the same
995possible values as *sesion.screen0.{slit|toolbar}.placement*.
996+
997Default: *TopLeft*
998
999*session.screen0.tab.width*: 'integer'::
1000This specifies the width of external tabs in pixels.
1001+
1002Default: *64*
1003
1004*session.screen0.focusModel*: *ClickToFocus|MouseFocus*::
1005This controls how windows gain focus via the mouse. With `ClickToFocus',
1006the user must click on the window. With `MouseFocus', windows gain focus
1007whenever the mouse moves over them.
1008+
1009Default: *ClickToFocus*
990 1010
991session.screen0.autoRaise: <boolean> 1011*session.screen0.autoRaise*: 'boolean'::
992 When True, this setting automatically raises any window that gains focus. 1012When True, this setting automatically raises any window that gains focus.
993 Default: True 1013+
994 1014Default: *True*
995session.autoRaiseDelay: <integer> 1015
996 Adjusts the delay (in milli-sec) before focused windows will raise 1016*session.autoRaiseDelay*: 'integer'::
997 when using the Autoraise option. Default: 250 1017Adjusts the delay (in milli-sec) before focused windows will raise
998 1018when using the Autoraise option.
999session.screen0.clickRaises: <boolean> 1019+
1000 This setting allows a user to click anywhere on a window to bring it on 1020Default: *250*
1001 top of other windows. Otherwise, only the titlebar will work. Default: 1021
1002 True 1022*session.screen0.clickRaises*: 'boolean'::
1003 1023This setting allows a user to click anywhere on a window to bring it on
1004session.screen0.workspacewarping: <boolean> 1024top of other windows. Otherwise, only the titlebar will work.
1005 This setting enables a user to change workspaces by dragging a window 1025+
1006 across the edge of the screen. Default: True 1026Default: *True*
1007 1027
1008session.screen0.showwindowposition: <boolean> 1028*session.screen0.workspacewarping*: 'boolean'::
1009 Setting this resource to True shows the user, in a little window, 1029This setting enables a user to change workspaces by dragging a window
1010 the exact position of the application window while the user is 1030across the edge of the screen.
1011 dragging it. Allows a precise placement of windows on a screen. 1031+
1012 Default: True 1032Default: *True*
1013 1033
1014session.screen0.defaultDeco: <string> 1034*session.screen0.showwindowposition*: 'boolean'::
1015 This specifies the default window decorations, according to the same 1035Setting this resource to True shows the user, in a little window,
1016 options available to the `[Deco]' option in the `apps' file, described in 1036the exact position of the application window while the user is
1017 *fluxbox-apps(5)*. Default: NORMAL. 1037dragging it. Allows a precise placement of windows on a screen.
1018 1038+
1019session.screen0.menuDelay: <integer> 1039Default: *True*
1020 This sets the delay in milliseconds for submenus to open when you hover 1040
1021 over them or to close when you hover over another item. Default: 200 1041*session.screen0.defaultDeco*: 'string'::
1022 1042This specifies the default window decorations, according to the same
1023session.screen0.focusNewWindows: <boolean> 1043options available to the *[Deco]* option in the `apps' file, described in
1024 This sets whether or not new windows will become focused automatically. 1044*fluxbox-apps(5)*.
1025 Default: True 1045+
1026 1046Default: *NORMAL*
1027session.screen0.workspaceNames: <names> 1047
1028 Here is where the user can name their workspaces. However it is 1048*session.screen0.menuDelay*: 'integer'::
1029 recommended to use the tool available in the Workspace Menu to set 1049This sets the delay in milliseconds for submenus to open when you hover
1030 these. Default: one, two, three, four 1050over them or to close when you hover over another item.
1031 1051+
1032session.screen0.edgeSnapThreshold: <integer> 1052Default: *200*
1033 When moving a window across your screen, fluxbox is able to have it `snap' 1053
1034 to the edges of the screen and other windows for easy placement. This 1054*session.screen0.focusNewWindows*: 'boolean'::
1035 variable tells fluxbox the distance (in pixels) at which the window will 1055This sets whether or not new windows will become focused automatically.
1036 jump to the edge. Default: 10 1056+
1037 1057Default: *True*
1038session.screen0.windowPlacement: <placement strategy> 1058
1039 This resource specifies where to place new windows when not otherwise 1059*session.screen0.workspaceNames*: 'names'::
1040 specified (by the program or the `apps' file, for example). Here are the 1060Here is where the user can name their workspaces, in a comma-delimited list.
1041 options: 1061However it is recommended to use the tool available in the Workspace Menu to set
1042 - RowSmartPlacement: tries to place windows in rows without overlapping 1062these.
1043 - ColSmartPlacement: tries to place windows in columns without overlapping 1063+
1044 - CascadePlacement: places windows below the titlebar of the previous one 1064Default: *one, two, three, four*
1045 - UnderMousePlacement: places new windows underneath the mouse 1065
1046 Default: RowSmartPlacement 1066*session.screen0.edgeSnapThreshold*: 'integer'::
1047 1067When moving a window across your screen, fluxbox is able to have it `snap'
1048session.screen0.rowPlacementDirection: LeftToRight|RightToLeft 1068to the edges of the screen and other windows for easy placement. This
1049session.screen0.colPlacementDirection: TopToBottom|BottomToTop 1069variable tells fluxbox the distance (in pixels) at which the window will
1050 These settings control the direction in which windows are tiled using the 1070jump to the edge.
1051 RowSmartPlacement and ColSmartPlacement strategies described above. 1071+
1052 Default: LeftToRight/TopToBottom 1072Default: *10*
1053 1073
1054session.screen0.fullMaximization: <boolean> 1074*session.screen0.windowPlacement*: 'strategy'::
1055 If this setting is enabled, windows will maximize over the toolbar, slit, 1075This resource specifies where to place new windows when not otherwise
1056 and any other window that creates a strut, no matter what their individual 1076specified (by the program or the `apps' file, for example).
1057 settings are. Default: False 1077+
1058 1078--
1059session.screen0.opaqueMove: <boolean> 1079Available strategies:;;
1060 When moving a window, setting this to True will draw the window 1080- RowSmartPlacement: tries to place windows in rows without overlapping
1061 contents as it moves (this is nasty on slow systems). If False, it 1081- ColSmartPlacement: tries to place windows in columns without overlapping
1062 will only draw an outline of the window border. Default: True 1082- CascadePlacement: places windows below the titlebar of the previous one
1063 1083- UnderMousePlacement: places new windows underneath the mouse
1064session.screen0.workspaces: <integer> 1084--
1065 Set this to the number of workspaces the users wants. Default: 4 1085+
1066 1086Default: *RowSmartPlacement*
1067session.screen0.windowMenu: <blank>|<location> 1087
1068 This specifies the location of a user-defined window menu. Default: blank 1088*session.screen0.rowPlacementDirection*: *LeftToRight*|*RightToLeft*::
1069 1089These settings control the direction in which windows are tiled using the
1070session.appsFile: <location> 1090RowSmartPlacement and ColSmartPlacement strategies described above.
1071session.groupFile: <location> 1091+
1072session.keyFile: <location> 1092Default: *LeftToRight*
1073session.menuFile: <location> 1093
1074session.slitlistFile: <location> 1094*session.screen0.colPlacementDirection*: *TopToBottom*|*BottomToTop*::
1075session.styleFile: <location> 1095These settings control the direction in which windows are tiled using the
1076session.styleOverlay: <location> 1096RowSmartPlacement and ColSmartPlacement strategies described above.
1077 All of these resources require a pathname to their specific files. This is 1097+
1078 where you can specify different files. Most of the defaults will be 1098Default: *TopToBottom*
1079 located in the user's ~/.fluxbox directory. 1099
1080 1100*session.screen0.fullMaximization*: 'boolean'::
1081session.cacheLife: <integer> 1101If this setting is enabled, windows will maximize over the toolbar, slit,
1082 This tells fluxbox how long (in minutes) unused pixmaps may stay in the X 1102and any other window that creates a strut, no matter what their individual
1083 server's memory. Default: 5 1103settings are.
1084 1104+
1085session.cacheMax: <integer> 1105Default: *False*
1086 This tells fluxbox how much memory (in Kb) it may use to store cached 1106
1087 pixmaps on the X server. If your machine runs short of memory, you may 1107*session.screen0.opaqueMove*: 'boolean'::
1088 lower this value. Default: 200 1108When moving a window, setting this to True will draw the window
1089 1109contents as it moves (this is nasty on slow systems). If False, it
1090session.colorsPerChannel: <integer> 1110will only draw an outline of the window border.
1091 This tells fluxbox how many colors to take from the X server on 1111+
1092 pseudo-color displays. A channel would be red, green, or blue. fluxbox 1112Default: *True*
1093 will allocate this variable ^ 3 and make them always available. Value must 1113
1094 be between 2-6. When you run fluxbox on an 8bpp display, you must set this 1114*session.screen0.workspaces*: 'integer'::
1095 resource to 4. Default: 4 1115Set this to the number of workspaces the users wants.
1096 1116+
1097session.doubleClickInterval: <integer> 1117Default: *4*
1098 Adjust the delay in milliseconds between mouse clicks for fluxbox to 1118
1099 consider a double click. Default: 250 1119*session.cacheLife*: 'minutes'::
1100 1120This tells fluxbox how long unused pixmaps may stay in the X
1101session.forcePseudoTransparency: <boolean> 1121server's memory.
1102 If you have Xorg's composite extension enabled, this setting will force 1122+
1103 the menu, windows, toolbar, and slit to use pseudo-transparency instead of 1123Default: *5*
1104 true transparency. Default: False 1124
1105 1125*session.cacheMax*: 'KbSize'::
1106session.ignoreBorder: <boolean> 1126This tells fluxbox how much memory it may use to store cached
1107 This configures the ability to move windows by dragging the border. 1127pixmaps on the X server. If your machine runs short of memory, you may
1108 Default: False 1128lower this value.
1109 1129+
1110session.tabPadding: <integer> 1130Default: *200*
1111 This specifies the spacing between tabs. Default: 0 1131
1112 1132*session.colorsPerChannel*: 'integer'::
1113session.tabsAttachArea: Window|Titlebar 1133This tells fluxbox how many colors to take from the X server on
1114 With this set to `Window', windows may be grouped by dragging one tab with 1134pseudo-color displays. A channel would be red, green, or blue. fluxbox
1115 the middle mouse button and dropping it anywhere on another window. With 1135will allocate this variable ^ 3 and make them always available. Value must
1116 `Titlebar', the user must drop the tab on the target window's titlebar. 1136be between 2-6. When you run fluxbox on an 8bpp display, you must set this
1117 Default: Window 1137resource to 4.
1118 1138+
1119session.titlebar.left: Stick 1139Default: *4*
1120session.titlebar.right: Minimize Maximize Close 1140
1121 The icons to place in the titlebar of decorated windows. The available 1141*session.doubleClickInterval*: 'integer'::
1122 options are Close, Maximize, MenuIcon, Minimize, Shade, and Stick. 1142Adjust the delay in milliseconds between mouse clicks for fluxbox to
1123 1143consider a double click.
1124................................................................................ 1144+
1145Default: *250*
1146
1147*session.forcePseudoTransparency*: 'boolean'::
1148If you have Xorg's composite extension enabled, this setting will force
1149the menu, windows, toolbar, and slit to use pseudo-transparency instead of
1150true transparency.
1151+
1152Default: *False*
1153
1154*session.ignoreBorder*: 'boolean'::
1155This configures the ability to move windows by dragging the border.
1156+
1157Default: *False*
1158
1159*session.tabPadding*: 'integer'::
1160This specifies the spacing between tabs.
1161+
1162Default: *0*
1163
1164*session.tabsAttachArea*: *Window|Titlebar*::
1165With this set to `Window', windows may be grouped by dragging one tab with
1166the middle mouse button and dropping it anywhere on another window. With
1167`Titlebar', the user must drop the tab on the target window's titlebar.
1168+
1169Default: *Window*
1170
1171*session.titlebar.{left|right}*: 'buttons'::
1172The buttons or icons to place in the titlebar of decorated windows. You
1173may specify any number, space-delimited.
1174+
1175--
1176The available options are:;;
1177 *Close* *Maximize* *MenuIcon* *Minimize* *Shade* *Stick*
1178--
1179+
1180Default left: *Stick MenuIcon*
1181+
1182Default right: *Shade Minimize Maximize Close*
1183
1184All of the 'location' resources following require a pathname to their specific
1185files. This is where you can specify different files. Most of the defaults will
1186be located in the user's *\~/.fluxbox* directory.
1187
1188*session.appsFile*: 'location'::
1189 Location of persistent application settings, or the `apps' file. See the
1190 *Remember...* item in the *Window Menu* section above or *fluxbox-apps(5)*
1191 for details.
1192
1193*session.groupFile*: 'location'::
1194 Deprecated, auto-grouping is now done in the `apps' file, see
1195 *fluxbox-apps(5)* for details.
1196
1197*session.keyFile*: 'location'::
1198 Location of the keyboard mapping settings, or the `keys' file.
1199 See *fluxbox-keys(5)* for details.
1200
1201*session.menuFile*: 'location'::
1202 Location of the Root Menu file.
1203 See *fluxbox-menu(5)* for details.
1204
1205*session.slitlistFile*: 'location'::
1206 Location of the file used to remember slit client ordering.
1207 See *SLIT* above for details.
1208
1209*session.styleFile*: 'location'::
1210 Location of the currently selected style.
1211 See *fluxbox-style(5)* for details.
1212
1213*session.styleOverlay*: 'location'::
1214 Location of the style overlay file.
1215 See *fluxbox-style(5)* for details.
1216
1217*session.screen0.windowMenu*: 'location':::
1218This optionally specifies the location of a user-defined window menu. If left
1219blank, it will use *\~/.fluxbox/windowmenu*.
1220+
1221Default: *blank*
1125 1222
1126ENVIRONMENT 1223ENVIRONMENT
1127----------- 1224-----------
1128HOME:: 1225*HOME*::
1129 fluxbox uses HOME to find the .fluxbox/init file and to resolve style file 1226 fluxbox uses *$HOME* to find the .fluxbox/init file and to resolve style file
1130 and -directory names. 1227 and -directory names.
1131 1228
1132DISPLAY:: 1229*DISPLAY*::
1133 When no other display was given on the command line, fluxbox will start on 1230 When no other display was given on the command line, fluxbox will start on
1134 the display specified by this variable. 1231 the display specified by this variable.
1135 1232
diff --git a/doc/fluxbox.1.in b/doc/fluxbox.1.in
index da9d0e0..81e451e 100644
--- a/doc/fluxbox.1.in
+++ b/doc/fluxbox.1.in
@@ -1,12 +1,12 @@
1.\" Title: fluxbox 1.\" Title: fluxbox
2.\" Author: [see the "AUTHORS" section] 2.\" Author: [see the "AUTHORS" section]
3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> 3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4.\" Date: 02/19/2009 4.\" Date: 02/20/2009
5.\" Manual: Fluxbox Manual 5.\" Manual: Fluxbox Manual
6.\" Source: fluxbox.txt 1.1.2 6.\" Source: fluxbox.txt 1.1.2
7.\" Language: English 7.\" Language: English
8.\" 8.\"
9.TH "FLUXBOX" "1" "02/19/2009" "fluxbox\&.txt 1\&.1\&.2" "Fluxbox Manual" 9.TH "FLUXBOX" "1" "02/20/2009" "fluxbox\&.txt 1\&.1\&.2" "Fluxbox Manual"
10.\" ----------------------------------------------------------------- 10.\" -----------------------------------------------------------------
11.\" * (re)Define some macros 11.\" * (re)Define some macros
12.\" ----------------------------------------------------------------- 12.\" -----------------------------------------------------------------
@@ -1604,286 +1604,594 @@ The other way to set the layer for a window is through the `apps\' file\&. This
1604Usually the \fB~/\&.fluxbox/init\fR resource file is created and maintained by fluxbox itself\&. You can use the \fBConfigure Menu\fR, mentioned above, to set most of these options\&. However, we\'ll cover all of the resource options that are available to the user\&. If you edit this file while fluxbox is running, you must \(lqreconfigure\(rq to reload the resource options\&. 1604Usually the \fB~/\&.fluxbox/init\fR resource file is created and maintained by fluxbox itself\&. You can use the \fBConfigure Menu\fR, mentioned above, to set most of these options\&. However, we\'ll cover all of the resource options that are available to the user\&. If you edit this file while fluxbox is running, you must \(lqreconfigure\(rq to reload the resource options\&.
1605.sp 1605.sp
1606When running fluxbox in a multiple\-screen environment the screen0 key can also be screen1, screen2, to customize the behavior of fluxbox on each desktop accordingly\&. Here are the resources that are currently available: 1606When running fluxbox in a multiple\-screen environment the screen0 key can also be screen1, screen2, to customize the behavior of fluxbox on each desktop accordingly\&. Here are the resources that are currently available:
1607.PP
1608\fBsession\&.screen0\&.window\&.{focus|unfocus}\&.alpha\fR: \fIinteger\fR
1609.RS 4
1610These resources are available to the user to set different levels of transparency for different components of fluxbox\&. Each one accepts a value between 0\-255, 255 being opaque and 0 being completely transparent\&.
1607.sp 1611.sp
1608.if n \{\ 1612Default:
1613\fB255\fR
1614.RE
1615.PP
1616\fBsession\&.screen0\&.{slit|toolbar}\&.autoHide\fR: \fIboolean\fR
1617.RS 4
1618The autoHide resources allow the user to set the behavior of the toolbar and slit\&. This behavior can be that they disappear when they are not being used actively by the user, or they remain visible at all times\&.
1619.sp
1620Default:
1621\fBFalse\fR
1622.RE
1623.PP
1624\fBsession\&.screen0\&.{slit|toolbar}\&.layer\fR: \fIlayer\fR
1625.RS 4
1626With these two resources, you can set the layer you want the toolbar and the slit to appear on\&. Please read the LAYER section for more information\&.
1627.sp
1628Default:
1629\fBDock\fR
1630.RE
1631.PP
1632\fBsession\&.screen0\&.{slit|toolbar}\&.placement\fR: \fIplacement\fR
1633.RS 4
1634These allow users to place the slit and toolbar where they like\&.
1635.PP
1636Possible options are:
1609.RS 4 1637.RS 4
1610.\}
1611.fam C
1612.ps -1
1613.nf
1614.BB lightgray
1615session\&.screen0\&.window\&.focus\&.alpha: <integer>
1616session\&.screen0\&.window\&.unfocus\&.alpha: <integer>
1617 These resources are available to the user to set different levels of
1618 transparency for different components of fluxbox\&. Each one accepts a value
1619 between 0\-255, 255 being opaque and 0 being completely transparent\&.
1620 Default: 255
1621
1622session\&.screen0\&.slit\&.autoHide: <boolean>
1623session\&.screen0\&.toolbar\&.autoHide: <boolean>
1624 The autoHide resources allow the user to set the behavior of the toolbar
1625 and slit\&. This behavior can be that they disappear when they are not being
1626 used actively by the user, or they remain visible at all times\&. Default:
1627 False
1628
1629session\&.screen0\&.slit\&.layer: <layer>
1630session\&.screen0\&.toolbar\&.layer: <layer>
1631 With these two resources, you can set the layer you want the toolbar and
1632 the slit to appear on\&. Please read the LAYER section for more information\&.
1633 Default: Dock
1634
1635session\&.screen0\&.slit\&.placement: <placement>
1636session\&.screen0\&.toolbar\&.placement: <placement>
1637 These allow users to place the slit and toolbar where they like\&. Possible
1638 options are:
1639 \- BottomLeft
1640 \- BottomCenter
1641 \- BottomRight
1642 \- LeftBottom
1643 \- LeftCenter
1644 \- LeftTop
1645 \- RightBottom
1646 \- RightCenter
1647 \- RightTop
1648 \- TopLeft
1649 \- TopCenter
1650 \- TopRight
1651
1652session\&.screen0\&.slit\&.maxOver: <boolean>
1653session\&.screen0\&.toolbar\&.maxOver: <boolean>
1654session\&.screen0\&.tabs\&.maxOver: <boolean>
1655 Setting these to True will allow application windows to maximize over the
1656 complete screen\&. Setting to False allows the slit, toolbar, and external
1657 tabs to hold their territory and will always be visible when an
1658 application is maximized\&. Default: False
1659
1660session\&.screen0\&.toolbar\&.height: <integer>
1661 Set the height of the toolbar\&. If the value is set to 0, the style file
1662 will gain control over the toolbar height\&. It is possible to set a fixed
1663 height by changing this value to something greater than 0\&. Default: 0
1664
1665session\&.screen0\&.toolbar\&.visible: <boolean>
1666 The user can set whether they want to have a toolbar on screen at all\&.
1667 Setting to False removes the toolbar from the screen\&. Default: True
1668
1669session\&.screen0\&.toolbar\&.widthPercent: <integer>
1670 This resource sets the width percentage of the toolbar on the screen\&.
1671 Default: 100
1672
1673session\&.screen0\&.toolbar\&.tools: <tools>
1674 This resource specifies the tools plugged into the toolbar\&. Read the
1675 TOOLBAR section in this manual for a description of each of these\&.
1676 They may be specified in any order, delimited by the \',\' character\&.
1677 They will appear in the order given\&.
1678 Possible tools::
1679 \- clock
1680 \- iconbar
1681 \- nextwindow
1682 \- prevwindow
1683 \- nextworkspace
1684 \- prevworkspace
1685 \- systemtray
1686 \- workspacename
1687
1688session\&.screen0\&.slit\&.onhead: <integer>
1689session\&.screen0\&.toolbar\&.onhead: <integer>
1690 For those that use xinerama, users can set this value to the number of the
1691 head where they would like to see the slit and toolbar, starting from 1\&.
1692 Setting this to 0 will ignore xinerama information\&. Default: 0
1693
1694session\&.screen0\&.iconbar\&.mode: <pattern>
1695 This determines which windows will be displayed in the iconbar\&. Any window
1696 pattern available to the Next/PrevWindow keybindings is acceptable\&.
1697 Default: {static groups} (workspace)
1698
1699session\&.screen0\&.iconbar\&.usePixmap: <boolean>
1700 This is also set in the Iconbar Mode menu\&. When set to True, this will
1701 show the native icon of applications\&. Default: True
1702
1703session\&.screen0\&.iconbar\&.iconTextPadding: <integer>
1704 This specifies the space between the window title and the edge of the
1705 button\&. Default: 10
1706
1707session\&.screen0\&.iconbar\&.alignment: <position>
1708 This value should be changed in the Iconbar Mode menu\&. Default:
1709 Relative
1710
1711 Available options:
1712 \- Left: Fixed width, aligned left
1713 \- Relative: Width varies to fill the iconbar
1714 \- Right: Fixed width, aligned right
1715
1716session\&.screen0\&.iconbar\&.iconWidth: <integer>
1717 Used to specify the iconbar button width for Left/Right alignment\&.
1718 Default: 128
1719
1720session\&.screen0\&.strftimeFormat: <date>
1721 This adjusts the way the current time is displayed in the toolbar\&. The
1722 strftime(3) format is used\&. Default: %I:%M %p
1723
1724session\&.screen0\&.tabs\&.intitlebar: <boolean>
1725 This specifies whether tabs should be embedded in the titlebar or placed
1726 outside the window\&. Default: True
1727
1728session\&.screen0\&.tab\&.placement: <placement>
1729 This specifies where external tabs will appear on the window\&. Default:
1730 TopLeft
1731
1732session\&.screen0\&.tab\&.width: <integer>
1733 This specifies the width of external tabs in pixels\&. Default: 64
1734
1735session\&.screen0\&.focusModel: ClickToFocus|MouseFocus
1736 This controls how windows gain focus via the mouse\&. With `ClickToFocus\',
1737 the user must click on the window\&. With `MouseFocus\', windows gain focus
1738 whenever the mouse moves over them\&. Default: ClickToFocus
1739
1740session\&.screen0\&.autoRaise: <boolean>
1741 When True, this setting automatically raises any window that gains focus\&.
1742 Default: True
1743
1744session\&.autoRaiseDelay: <integer>
1745 Adjusts the delay (in milli\-sec) before focused windows will raise
1746 when using the Autoraise option\&. Default: 250
1747
1748session\&.screen0\&.clickRaises: <boolean>
1749 This setting allows a user to click anywhere on a window to bring it on
1750 top of other windows\&. Otherwise, only the titlebar will work\&. Default:
1751 True
1752
1753session\&.screen0\&.workspacewarping: <boolean>
1754 This setting enables a user to change workspaces by dragging a window
1755 across the edge of the screen\&. Default: True
1756
1757session\&.screen0\&.showwindowposition: <boolean>
1758 Setting this resource to True shows the user, in a little window,
1759 the exact position of the application window while the user is
1760 dragging it\&. Allows a precise placement of windows on a screen\&.
1761 Default: True
1762
1763session\&.screen0\&.defaultDeco: <string>
1764 This specifies the default window decorations, according to the same
1765 options available to the `[Deco]\' option in the `apps\' file, described in
1766 *fluxbox\-apps(5)*\&. Default: NORMAL\&.
1767
1768session\&.screen0\&.menuDelay: <integer>
1769 This sets the delay in milliseconds for submenus to open when you hover
1770 over them or to close when you hover over another item\&. Default: 200
1771
1772session\&.screen0\&.focusNewWindows: <boolean>
1773 This sets whether or not new windows will become focused automatically\&.
1774 Default: True
1775
1776session\&.screen0\&.workspaceNames: <names>
1777 Here is where the user can name their workspaces\&. However it is
1778 recommended to use the tool available in the Workspace Menu to set
1779 these\&. Default: one, two, three, four
1780
1781session\&.screen0\&.edgeSnapThreshold: <integer>
1782 When moving a window across your screen, fluxbox is able to have it `snap\'
1783 to the edges of the screen and other windows for easy placement\&. This
1784 variable tells fluxbox the distance (in pixels) at which the window will
1785 jump to the edge\&. Default: 10
1786
1787session\&.screen0\&.windowPlacement: <placement strategy>
1788 This resource specifies where to place new windows when not otherwise
1789 specified (by the program or the `apps\' file, for example)\&. Here are the
1790 options:
1791 \- RowSmartPlacement: tries to place windows in rows without overlapping
1792 \- ColSmartPlacement: tries to place windows in columns without overlapping
1793 \- CascadePlacement: places windows below the titlebar of the previous one
1794 \- UnderMousePlacement: places new windows underneath the mouse
1795 Default: RowSmartPlacement
1796
1797session\&.screen0\&.rowPlacementDirection: LeftToRight|RightToLeft
1798session\&.screen0\&.colPlacementDirection: TopToBottom|BottomToTop
1799 These settings control the direction in which windows are tiled using the
1800 RowSmartPlacement and ColSmartPlacement strategies described above\&.
1801 Default: LeftToRight/TopToBottom
1802
1803session\&.screen0\&.fullMaximization: <boolean>
1804 If this setting is enabled, windows will maximize over the toolbar, slit,
1805 and any other window that creates a strut, no matter what their individual
1806 settings are\&. Default: False
1807
1808session\&.screen0\&.opaqueMove: <boolean>
1809 When moving a window, setting this to True will draw the window
1810 contents as it moves (this is nasty on slow systems)\&. If False, it
1811 will only draw an outline of the window border\&. Default: True
1812
1813session\&.screen0\&.workspaces: <integer>
1814 Set this to the number of workspaces the users wants\&. Default: 4
1815
1816session\&.screen0\&.windowMenu: <blank>|<location>
1817 This specifies the location of a user\-defined window menu\&. Default: blank
1818
1819session\&.appsFile: <location>
1820session\&.groupFile: <location>
1821session\&.keyFile: <location>
1822session\&.menuFile: <location>
1823session\&.slitlistFile: <location>
1824session\&.styleFile: <location>
1825session\&.styleOverlay: <location>
1826 All of these resources require a pathname to their specific files\&. This is
1827 where you can specify different files\&. Most of the defaults will be
1828 located in the user\'s ~/\&.fluxbox directory\&.
1829
1830session\&.cacheLife: <integer>
1831 This tells fluxbox how long (in minutes) unused pixmaps may stay in the X
1832 server\'s memory\&. Default: 5
1833 1638
1834session\&.cacheMax: <integer> 1639\fBBottomLeft\fR
1835 This tells fluxbox how much memory (in Kb) it may use to store cached 1640\fBBottomCenter\fR
1836 pixmaps on the X server\&. If your machine runs short of memory, you may 1641\fBBottomRight\fR
1837 lower this value\&. Default: 200 1642\fBLeftBottom\fR
1643\fBLeftCenter\fR
1644\fBLeftTop\fR
1645\fBRightBottom\fR
1646\fBRightCenter\fR
1647\fBRightTop\fR
1648\fBTopLeft\fR
1649\fBTopCenter\fR
1650\fBTopRight\fR
1651.RE
1652.sp
1653Slit default:
1654\fBTopRight\fR
1655.sp
1656Toolbar default:
1657\fBBottomCenter\fR
1658.RE
1659.PP
1660\fBsession\&.screen0\&.{slit|toolbar|tabs}\&.maxOver\fR: \fIboolean\fR
1661.RS 4
1662Setting these to True will allow application windows to maximize over the complete screen\&. Setting to False allows the slit, toolbar, and external tabs to hold their territory and will always be visible when an application is maximized\&.
1663.sp
1664Default:
1665\fBFalse\fR
1666.RE
1667.PP
1668\fBsession\&.screen0\&.toolbar\&.height\fR: \fIinteger\fR
1669.RS 4
1670Set the height of the toolbar\&. If the value is set to 0, the style file will gain control over the toolbar height\&. It is possible to set a fixed height by changing this value to something greater than 0\&.
1671.sp
1672Default:
1673\fB0\fR
1674.RE
1675.PP
1676\fBsession\&.screen0\&.toolbar\&.visible\fR: \fIboolean\fR
1677.RS 4
1678The user can set whether they want to have a toolbar on screen at all\&. Setting to False removes the toolbar from the screen\&.
1679.sp
1680Default:
1681\fBTrue\fR
1682.RE
1683.PP
1684\fBsession\&.screen0\&.toolbar\&.widthPercent\fR: \fIinteger\fR
1685.RS 4
1686This resource sets the width percentage of the toolbar on the screen\&.
1687.sp
1688Default:
1689\fB100\fR
1690.RE
1691.PP
1692\fBsession\&.screen0\&.toolbar\&.tools\fR: \fItools\fR
1693.RS 4
1694This resource specifies the tools plugged into the toolbar\&. Read the TOOLBAR section in this manual for a description of each of these\&. They may be specified in any order, delimited by the
1695\fB,\fR
1696character\&. They will appear in the order given\&.
1697.PP
1698Possible tools:
1699.RS 4
1838 1700
1839session\&.colorsPerChannel: <integer> 1701\fBclock\fR
1840 This tells fluxbox how many colors to take from the X server on 1702\fBiconbar\fR
1841 pseudo\-color displays\&. A channel would be red, green, or blue\&. fluxbox 1703\fBnextwindow\fR
1842 will allocate this variable ^ 3 and make them always available\&. Value must 1704\fBprevwindow\fR
1843 be between 2\-6\&. When you run fluxbox on an 8bpp display, you must set this 1705\fBnextworkspace\fR
1844 resource to 4\&. Default: 4 1706\fBprevworkspace\fR
1707\fBsystemtray\fR
1708\fBworkspacename\fR
1709.RE
1710.PP
1711Default:
1712.RS 4
1845 1713
1846session\&.doubleClickInterval: <integer> 1714\fBworkspacename, prevworkspace, nextworkspace, iconbar, prevwindow, nextwindow, systemtray, clock\fR
1847 Adjust the delay in milliseconds between mouse clicks for fluxbox to 1715.RE
1848 consider a double click\&. Default: 250 1716.RE
1717.PP
1718\fBsession\&.screen0\&.{slit|toolbar}\&.onhead\fR: \fIinteger\fR
1719.RS 4
1720For those that use xinerama, users can set this value to the number of the head where they would like to see the slit and toolbar, starting from 1\&. Setting this to 0 will ignore xinerama information\&.
1721.sp
1722Default:
1723\fB0\fR
1724.RE
1725.PP
1726\fBsession\&.screen0\&.iconbar\&.mode\fR: \fIpattern\fR
1727.RS 4
1728This determines which windows will be displayed in the iconbar\&. Any window pattern is acceptable\&. See the section
1729\fBCLIENT PATTERNS\fR
1730in either
1731\fBfluxbox\-keys(5)\fR
1732or
1733\fBfluxbox\-apps(5)\fR
1734for details\&.
1735.sp
1736Default:
1737\fB{static groups} (workspace)\fR
1738.RE
1739.PP
1740\fBsession\&.screen0\&.iconbar\&.usePixmap\fR: \fIboolean\fR
1741.RS 4
1742This is also set in the Iconbar Mode menu\&. When set to True, this will show the native icon of applications\&.
1743.sp
1744Default:
1745\fBTrue\fR
1746.RE
1747.PP
1748\fBsession\&.screen0\&.iconbar\&.iconTextPadding\fR: \fIinteger\fR
1749.RS 4
1750This specifies the space between the window title and the edge of the button\&.
1751.sp
1752Default:
1753\fB10\fR
1754.RE
1755.PP
1756\fBsession\&.screen0\&.iconbar\&.alignment\fR: \fIposition\fR
1757.RS 4
1758This value should be changed in the Iconbar Mode menu\&.
1759.PP
1760Available options:
1761.RS 4
1849 1762
1850session\&.forcePseudoTransparency: <boolean> 1763.sp
1851 If you have Xorg\'s composite extension enabled, this setting will force 1764.RS 4
1852 the menu, windows, toolbar, and slit to use pseudo\-transparency instead of 1765.ie n \{\
1853 true transparency\&. Default: False 1766\h'-04'\(bu\h'+03'\c
1767.\}
1768.el \{\
1769.sp -1
1770.IP \(bu 2.3
1771.\}
1854 1772
1855session\&.ignoreBorder: <boolean> 1773\fBLeft\fR: Fixed width, aligned left
1856 This configures the ability to move windows by dragging the border\&. 1774.RE
1857 Default: False 1775.sp
1776.RS 4
1777.ie n \{\
1778\h'-04'\(bu\h'+03'\c
1779.\}
1780.el \{\
1781.sp -1
1782.IP \(bu 2.3
1783.\}
1858 1784
1859session\&.tabPadding: <integer> 1785\fBRelative\fR: Width varies to fill the iconbar
1860 This specifies the spacing between tabs\&. Default: 0 1786.RE
1787.sp
1788.RS 4
1789.ie n \{\
1790\h'-04'\(bu\h'+03'\c
1791.\}
1792.el \{\
1793.sp -1
1794.IP \(bu 2.3
1795.\}
1861 1796
1862session\&.tabsAttachArea: Window|Titlebar 1797\fBRight\fR: Fixed width, aligned right
1863 With this set to `Window\', windows may be grouped by dragging one tab with 1798.RE
1864 the middle mouse button and dropping it anywhere on another window\&. With 1799.RE
1865 `Titlebar\', the user must drop the tab on the target window\'s titlebar\&. 1800.sp
1866 Default: Window 1801Default:
1802\fBRelative\fR
1803.RE
1804.PP
1805\fBsession\&.screen0\&.iconbar\&.iconWidth\fR: \fIinteger\fR
1806.RS 4
1807Used to specify the iconbar button width for Left/Right alignment\&.
1808.sp
1809Default:
1810\fB128\fR
1811.RE
1812.PP
1813\fBsession\&.screen0\&.strftimeFormat\fR: \fIdate\fR
1814.RS 4
1815This adjusts the way the current time is displayed in the toolbar\&. The
1816\fBstrftime(3)\fR
1817format is used\&.
1818.sp
1819Default:
1820\fB%I:%M %p\fR
1821.RE
1822.PP
1823\fBsession\&.screen0\&.tabs\&.intitlebar\fR: \fIboolean\fR
1824.RS 4
1825This specifies whether tabs should be embedded in the titlebar or placed outside the window\&.
1826.sp
1827Default:
1828\fBTrue\fR
1829.RE
1830.PP
1831\fBsession\&.screen0\&.tab\&.placement\fR: \fIplacement\fR
1832.RS 4
1833This specifies where external tabs will appear on the window\&. It has the same possible values as
1834\fBsesion\&.screen0\&.{slit|toolbar}\&.placement\fR\&.
1835.sp
1836Default:
1837\fBTopLeft\fR
1838.RE
1839.PP
1840\fBsession\&.screen0\&.tab\&.width\fR: \fIinteger\fR
1841.RS 4
1842This specifies the width of external tabs in pixels\&.
1843.sp
1844Default:
1845\fB64\fR
1846.RE
1847.PP
1848\fBsession\&.screen0\&.focusModel\fR: \fBClickToFocus|MouseFocus\fR
1849.RS 4
1850This controls how windows gain focus via the mouse\&. With `ClickToFocus\', the user must click on the window\&. With `MouseFocus\', windows gain focus whenever the mouse moves over them\&.
1851.sp
1852Default:
1853\fBClickToFocus\fR
1854.RE
1855.PP
1856\fBsession\&.screen0\&.autoRaise\fR: \fIboolean\fR
1857.RS 4
1858When True, this setting automatically raises any window that gains focus\&.
1859.sp
1860Default:
1861\fBTrue\fR
1862.RE
1863.PP
1864\fBsession\&.autoRaiseDelay\fR: \fIinteger\fR
1865.RS 4
1866Adjusts the delay (in milli\-sec) before focused windows will raise when using the Autoraise option\&.
1867.sp
1868Default:
1869\fB250\fR
1870.RE
1871.PP
1872\fBsession\&.screen0\&.clickRaises\fR: \fIboolean\fR
1873.RS 4
1874This setting allows a user to click anywhere on a window to bring it on top of other windows\&. Otherwise, only the titlebar will work\&.
1875.sp
1876Default:
1877\fBTrue\fR
1878.RE
1879.PP
1880\fBsession\&.screen0\&.workspacewarping\fR: \fIboolean\fR
1881.RS 4
1882This setting enables a user to change workspaces by dragging a window across the edge of the screen\&.
1883.sp
1884Default:
1885\fBTrue\fR
1886.RE
1887.PP
1888\fBsession\&.screen0\&.showwindowposition\fR: \fIboolean\fR
1889.RS 4
1890Setting this resource to True shows the user, in a little window, the exact position of the application window while the user is dragging it\&. Allows a precise placement of windows on a screen\&.
1891.sp
1892Default:
1893\fBTrue\fR
1894.RE
1895.PP
1896\fBsession\&.screen0\&.defaultDeco\fR: \fIstring\fR
1897.RS 4
1898This specifies the default window decorations, according to the same options available to the
1899\fB[Deco]\fR
1900option in the `apps\' file, described in
1901\fBfluxbox\-apps(5)\fR\&.
1902.sp
1903Default:
1904\fBNORMAL\fR
1905.RE
1906.PP
1907\fBsession\&.screen0\&.menuDelay\fR: \fIinteger\fR
1908.RS 4
1909This sets the delay in milliseconds for submenus to open when you hover over them or to close when you hover over another item\&.
1910.sp
1911Default:
1912\fB200\fR
1913.RE
1914.PP
1915\fBsession\&.screen0\&.focusNewWindows\fR: \fIboolean\fR
1916.RS 4
1917This sets whether or not new windows will become focused automatically\&.
1918.sp
1919Default:
1920\fBTrue\fR
1921.RE
1922.PP
1923\fBsession\&.screen0\&.workspaceNames\fR: \fInames\fR
1924.RS 4
1925Here is where the user can name their workspaces, in a comma\-delimited list\&. However it is recommended to use the tool available in the Workspace Menu to set these\&.
1926.sp
1927Default:
1928\fBone, two, three, four\fR
1929.RE
1930.PP
1931\fBsession\&.screen0\&.edgeSnapThreshold\fR: \fIinteger\fR
1932.RS 4
1933When moving a window across your screen, fluxbox is able to have it `snap\' to the edges of the screen and other windows for easy placement\&. This variable tells fluxbox the distance (in pixels) at which the window will jump to the edge\&.
1934.sp
1935Default:
1936\fB10\fR
1937.RE
1938.PP
1939\fBsession\&.screen0\&.windowPlacement\fR: \fIstrategy\fR
1940.RS 4
1941This resource specifies where to place new windows when not otherwise specified (by the program or the `apps\' file, for example)\&.
1942.PP
1943Available strategies:
1944.RS 4
1867 1945
1868session\&.titlebar\&.left: Stick 1946.sp
1869session\&.titlebar\&.right: Minimize Maximize Close 1947.RS 4
1870 The icons to place in the titlebar of decorated windows\&. The available 1948.ie n \{\
1871 options are Close, Maximize, MenuIcon, Minimize, Shade, and Stick\&. 1949\h'-04'\(bu\h'+03'\c
1872.EB lightgray 1950.\}
1873.fi 1951.el \{\
1874.fam 1952.sp -1
1875.ps +1 1953.IP \(bu 2.3
1876.if n \{\ 1954.\}
1955RowSmartPlacement: tries to place windows in rows without overlapping
1956.RE
1957.sp
1958.RS 4
1959.ie n \{\
1960\h'-04'\(bu\h'+03'\c
1961.\}
1962.el \{\
1963.sp -1
1964.IP \(bu 2.3
1965.\}
1966ColSmartPlacement: tries to place windows in columns without overlapping
1877.RE 1967.RE
1968.sp
1969.RS 4
1970.ie n \{\
1971\h'-04'\(bu\h'+03'\c
1878.\} 1972.\}
1973.el \{\
1974.sp -1
1975.IP \(bu 2.3
1976.\}
1977CascadePlacement: places windows below the titlebar of the previous one
1978.RE
1979.sp
1980.RS 4
1981.ie n \{\
1982\h'-04'\(bu\h'+03'\c
1983.\}
1984.el \{\
1985.sp -1
1986.IP \(bu 2.3
1987.\}
1988UnderMousePlacement: places new windows underneath the mouse
1989.RE
1990.RE
1991.sp
1992Default:
1993\fBRowSmartPlacement\fR
1994.RE
1995.PP
1996\fBsession\&.screen0\&.rowPlacementDirection\fR: \fBLeftToRight\fR|\fBRightToLeft\fR
1997.RS 4
1998These settings control the direction in which windows are tiled using the RowSmartPlacement and ColSmartPlacement strategies described above\&.
1999.sp
2000Default:
2001\fBLeftToRight\fR
2002.RE
2003.PP
2004\fBsession\&.screen0\&.colPlacementDirection\fR: \fBTopToBottom\fR|\fBBottomToTop\fR
2005.RS 4
2006These settings control the direction in which windows are tiled using the RowSmartPlacement and ColSmartPlacement strategies described above\&.
2007.sp
2008Default:
2009\fBTopToBottom\fR
2010.RE
2011.PP
2012\fBsession\&.screen0\&.fullMaximization\fR: \fIboolean\fR
2013.RS 4
2014If this setting is enabled, windows will maximize over the toolbar, slit, and any other window that creates a strut, no matter what their individual settings are\&.
2015.sp
2016Default:
2017\fBFalse\fR
2018.RE
2019.PP
2020\fBsession\&.screen0\&.opaqueMove\fR: \fIboolean\fR
2021.RS 4
2022When moving a window, setting this to True will draw the window contents as it moves (this is nasty on slow systems)\&. If False, it will only draw an outline of the window border\&.
2023.sp
2024Default:
2025\fBTrue\fR
2026.RE
2027.PP
2028\fBsession\&.screen0\&.workspaces\fR: \fIinteger\fR
2029.RS 4
2030Set this to the number of workspaces the users wants\&.
2031.sp
2032Default:
2033\fB4\fR
2034.RE
2035.PP
2036\fBsession\&.cacheLife\fR: \fIminutes\fR
2037.RS 4
2038This tells fluxbox how long unused pixmaps may stay in the X server\'s memory\&.
2039.sp
2040Default:
2041\fB5\fR
2042.RE
2043.PP
2044\fBsession\&.cacheMax\fR: \fIKbSize\fR
2045.RS 4
2046This tells fluxbox how much memory it may use to store cached pixmaps on the X server\&. If your machine runs short of memory, you may lower this value\&.
2047.sp
2048Default:
2049\fB200\fR
2050.RE
2051.PP
2052\fBsession\&.colorsPerChannel\fR: \fIinteger\fR
2053.RS 4
2054This tells fluxbox how many colors to take from the X server on pseudo\-color displays\&. A channel would be red, green, or blue\&. fluxbox will allocate this variable ^ 3 and make them always available\&. Value must be between 2\-6\&. When you run fluxbox on an 8bpp display, you must set this resource to 4\&.
2055.sp
2056Default:
2057\fB4\fR
2058.RE
2059.PP
2060\fBsession\&.doubleClickInterval\fR: \fIinteger\fR
2061.RS 4
2062Adjust the delay in milliseconds between mouse clicks for fluxbox to consider a double click\&.
2063.sp
2064Default:
2065\fB250\fR
2066.RE
2067.PP
2068\fBsession\&.forcePseudoTransparency\fR: \fIboolean\fR
2069.RS 4
2070If you have Xorg\'s composite extension enabled, this setting will force the menu, windows, toolbar, and slit to use pseudo\-transparency instead of true transparency\&.
2071.sp
2072Default:
2073\fBFalse\fR
2074.RE
2075.PP
2076\fBsession\&.ignoreBorder\fR: \fIboolean\fR
2077.RS 4
2078This configures the ability to move windows by dragging the border\&.
2079.sp
2080Default:
2081\fBFalse\fR
2082.RE
2083.PP
2084\fBsession\&.tabPadding\fR: \fIinteger\fR
2085.RS 4
2086This specifies the spacing between tabs\&.
2087.sp
2088Default:
2089\fB0\fR
2090.RE
2091.PP
2092\fBsession\&.tabsAttachArea\fR: \fBWindow|Titlebar\fR
2093.RS 4
2094With this set to `Window\', windows may be grouped by dragging one tab with the middle mouse button and dropping it anywhere on another window\&. With `Titlebar\', the user must drop the tab on the target window\'s titlebar\&.
2095.sp
2096Default:
2097\fBWindow\fR
2098.RE
2099.PP
2100\fBsession\&.titlebar\&.{left|right}\fR: \fIbuttons\fR
2101.RS 4
2102The buttons or icons to place in the titlebar of decorated windows\&. You may specify any number, space\-delimited\&.
2103.PP
2104The available options are:
2105.RS 4
2106
2107\fBClose\fR
2108\fBMaximize\fR
2109\fBMenuIcon\fR
2110\fBMinimize\fR
2111\fBShade\fR
2112\fBStick\fR
2113.RE
2114.sp
2115Default left:
2116\fBStick MenuIcon\fR
2117.sp
2118Default right:
2119\fBShade Minimize Maximize Close\fR
2120.RE
2121.sp
2122All of the \fIlocation\fR resources following require a pathname to their specific files\&. This is where you can specify different files\&. Most of the defaults will be located in the user\'s \fB~/\&.fluxbox\fR directory\&.
2123.PP
2124\fBsession\&.appsFile\fR: \fIlocation\fR
2125.RS 4
2126Location of persistent application settings, or the `apps\' file\&. See the
2127\fBRemember\&...\fR
2128item in the
2129\fBWindow Menu\fR
2130section above or
2131\fBfluxbox\-apps(5)\fR
2132for details\&.
2133.RE
2134.PP
2135\fBsession\&.groupFile\fR: \fIlocation\fR
2136.RS 4
2137Deprecated, auto\-grouping is now done in the `apps\' file, see
2138\fBfluxbox\-apps(5)\fR
2139for details\&.
2140.RE
2141.PP
2142\fBsession\&.keyFile\fR: \fIlocation\fR
2143.RS 4
2144Location of the keyboard mapping settings, or the `keys\' file\&. See
2145\fBfluxbox\-keys(5)\fR
2146for details\&.
2147.RE
2148.PP
2149\fBsession\&.menuFile\fR: \fIlocation\fR
2150.RS 4
2151Location of the Root Menu file\&. See
2152\fBfluxbox\-menu(5)\fR
2153for details\&.
2154.RE
2155.PP
2156\fBsession\&.slitlistFile\fR: \fIlocation\fR
2157.RS 4
2158Location of the file used to remember slit client ordering\&. See
2159\fBSLIT\fR
2160above for details\&.
2161.RE
2162.PP
2163\fBsession\&.styleFile\fR: \fIlocation\fR
2164.RS 4
2165Location of the currently selected style\&. See
2166\fBfluxbox\-style(5)\fR
2167for details\&.
2168.RE
2169.PP
2170\fBsession\&.styleOverlay\fR: \fIlocation\fR
2171.RS 4
2172Location of the style overlay file\&. See
2173\fBfluxbox\-style(5)\fR
2174for details\&.
2175.RE
2176.PP
2177\fBsession\&.screen0\&.windowMenu\fR: \fIlocation\fR:
2178.RS 4
2179This optionally specifies the location of a user\-defined window menu\&. If left blank, it will use
2180\fB~/\&.fluxbox/windowmenu\fR\&.
2181.sp
2182Default:
2183\fBblank\fR
2184.RE
1879.SH "ENVIRONMENT" 2185.SH "ENVIRONMENT"
1880.PP 2186.PP
1881HOME 2187\fBHOME\fR
1882.RS 4 2188.RS 4
1883fluxbox uses HOME to find the \&.fluxbox/init file and to resolve style file and \-directory names\&. 2189fluxbox uses
2190\fB$HOME\fR
2191to find the \&.fluxbox/init file and to resolve style file and \-directory names\&.
1884.RE 2192.RE
1885.PP 2193.PP
1886DISPLAY 2194\fBDISPLAY\fR
1887.RS 4 2195.RS 4
1888When no other display was given on the command line, fluxbox will start on the display specified by this variable\&. 2196When no other display was given on the command line, fluxbox will start on the display specified by this variable\&.
1889.RE 2197.RE