]> git.sur5r.net Git - i3/i3/commitdiff
update userguide to reflect the modifier option in i3bar config
authorMichael Stapelberg <michael@stapelberg.de>
Sun, 8 Jan 2012 12:52:45 +0000 (12:52 +0000)
committerMichael Stapelberg <michael@stapelberg.de>
Sun, 8 Jan 2012 12:52:45 +0000 (12:52 +0000)
docs/userguide

index 674d2b2a2299fc825b3169b85d7b9a97ba549c91..dce0371f19679fb4c1284bbf6016735f73d3ffbf 100644 (file)
@@ -847,26 +847,31 @@ bar {
 
 You can have i3bar either be visible permanently at one edge of the screen
 (+dock+ mode) or make it show up when you press your modifier key (+hide+
-mode).
+mode). The modifier key can be configured using the +modifier+ option.
 
 The hide mode maximizes screen space that can be used for actual windows. Also,
 i3bar sends the +SIGSTOP+ and +SIGCONT+ signals to the statusline process to
 save battery power.
 
-The default is dock mode.
+The default is dock mode; in hide mode, the default modifier is Mod4 (usually
+the windows key).
 
 *Syntax*:
 ----------------
 mode <dock|hide>
+modifier <Modifier>
 ----------------
 
 *Example*:
 ----------------
 bar {
     mode hide
+    modifier Mod1
 }
 ----------------
 
+Available modifiers are Mod1-Mod5, Shift, Control (see +xmodmap(1)+).
+
 [[i3bar_position]]
 === Position