Add 20081002-1.

[ion3.git] / etc / cfg_ion.lua

diff --git a/etc/cfg_ion.lua b/etc/cfg_ion.lua
index 339a026952c9a527e48e4792a9508c171f02a3ce..c16103ad80e0b66f517c3e425c605b711e397e1d 100644 (file)
--- a/etc/cfg_ion.lua
+++ b/etc/cfg_ion.lua
@@ -3,7 +3,14 @@
 --
 -- This file only includes some settings that are rather frequently altered.
 -- The rest of the settings are in cfg_ioncore.lua and individual modules'
--- configuration files (cfg_modulename.lua).
+-- configuration files (cfg_modulename.lua). 
+--
+-- When any binding and other customisations that you want are minor, it is 
+-- recommended that you include them in a copy of this file in ~/.ion3/.
+-- Simply create or copy the relevant settings at the end of this file (from
+-- the other files), recalling that a key can be unbound by passing 'nil' 
+-- (without the quotes) as the callback. For more information, please see 
+-- the Ion configuration manual available from the Ion Web page.
 --
 
 -- Set default modifiers. Alt should usually be mapped to Mod1 on
@@ -32,19 +39,42 @@ ioncore.set{
     -- Movement commands warp the pointer to frames instead of just
     -- changing focus. Enabled by default.
     --warp=true,
+    
+    -- Switch frames to display newly mapped windows
+    --switchto=true,
+    
+    -- Default index for windows in frames: one of 'last', 'next' (for
+    -- after current), or 'next-act' (for after current and anything with
+    -- activity right after it).
+    --frame_default_index='next',
+    
+    -- Auto-unsqueeze transients/menus/queries.
+    --unsqueeze=true,
+    
+    -- Display notification tooltips for activity on hidden workspace.
+    --screen_notify=true,
 }
 
--- cfg_ioncore contains configuration of the Ion 'core'
-dopath("cfg_ioncore")
+
+-- Load default settings. The file cfg_defaults loads all the files
+-- commented out below, except mod_dock. If you do not want to load
+-- something, comment out this line, and uncomment the lines corresponding
+-- the the modules or configuration files that you want, below.
+-- The modules' configuration files correspond to the names of the 
+-- modules with 'mod' replaced by 'cfg'.
+dopath("cfg_defaults")
+
+-- Load configuration of the Ion 'core'. Most bindings are here.
+--dopath("cfg_ioncore")
 
 -- Load some kludges to make apps behave better.
-dopath("cfg_kludges")
+--dopath("cfg_kludges")
 
--- Load some modules. Disable the loading of cfg_modules by commenting out 
--- the corresponding line with -- if you don't want the whole default set 
--- (everything except mod_dock). Then uncomment the lines for the modules
--- you want. 
-dopath("cfg_modules")
+-- Define some layouts. 
+--dopath("cfg_layouts")
+
+-- Load some modules. Bindings and other configuration specific to modules
+-- are in the files cfg_modulename.lua.
 --dopath("mod_query")
 --dopath("mod_menu")
 --dopath("mod_tiling")
@@ -52,9 +82,19 @@ dopath("cfg_modules")
 --dopath("mod_dock")
 --dopath("mod_sp")
 
--- Define some default layouts. This is also done by cfg_modules
--- if loaded.
---dopath("cfg_layouts", true)
 
--- Deprecated.
-dopath("cfg_user", true)
+--
+-- Common customisations
+--
+
+-- Uncommenting the following lines should get you plain-old-menus instead
+-- of query-menus.
+
+--defbindings("WScreen", {
+--    kpress(ALTMETA.."F12", "mod_menu.menu(_, _sub, 'mainmenu', {big=true})"),
+--})
+--
+--defbindings("WMPlex.toplevel", {
+--    kpress(META.."M", "mod_menu.menu(_, _sub, 'ctxmenu')"),
+--})
+