From: Michael Stapelberg <michael@stapelberg.de>
Date: Sun, 8 Jan 2012 12:52:45 +0000 (+0000)
Subject: update userguide to reflect the modifier option in i3bar config
X-Git-Tag: 4.2~149^2
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=c72367660fda84c981804fce6d8e4fab0d4d0af0;p=i3%2Fi3

update userguide to reflect the modifier option in i3bar config
---

diff --git a/docs/userguide b/docs/userguide
index 674d2b2a..dce0371f 100644
--- a/docs/userguide
+++ b/docs/userguide
@@ -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