]> git.sur5r.net Git - i3/i3/commitdiff
Document binding on Mode_switch in userguide, be more verbose in config
authorMichael Stapelberg <michael@stapelberg.de>
Tue, 26 May 2009 15:37:56 +0000 (17:37 +0200)
committerMichael Stapelberg <michael@stapelberg.de>
Tue, 26 May 2009 15:37:56 +0000 (17:37 +0200)
docs/userguide
i3.config
src/config.c

index 36c2af4b449e31556b1e5790c389fa8254860aa6..3f337a19e401f477a4462be8943d73e55c5a2ebb 100644 (file)
@@ -3,21 +3,23 @@ i3 User’s Guide
 Michael Stapelberg <michael+i3@stapelberg.de>
 May 2009
 
-This document contains all information you need to configuring and using the i3 window
-manager. If it does not, please contact me on IRC, Jabber or E-Mail and I’ll help you out.
+This document contains all information you need to configuring and using the i3
+window manager. If it does not, please contact me on IRC, Jabber or E-Mail and
+I’ll help you out.
 
 == Configuring i3
 
 TODO: document the other options, implement variables before
 
 terminal::
-       Specifies the terminal emulator program you prefer. It will be started by default when
-       you press Mod1+Enter, but you can overwrite this. Refer to it as +$terminal+ to keep things
-       modular.
+       Specifies the terminal emulator program you prefer. It will be started
+       by default when you press Mod1+Enter, but you can overwrite this. Refer
+       to it as +$terminal+ to keep things modular.
 font::
-       Specifies the default font you want i3 to use. Use an X core font descriptor here, like
-       +-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1+. You can use +xfontsel(1)+
-       to pick one.
+       Specifies the default font you want i3 to use. Use an X core font
+       descriptor here, like
+       +-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1+. You can
+       use +xfontsel(1)+ to pick one.
 
 === Keyboard bindings
 
@@ -37,13 +39,27 @@ bind Mod1+41 f
 bind Mod1+Shift+27 restart
 --------------------------------
 
+Available Modifiers:
+
+Mod1-Mod5, Shift, Control::
+Standard modifiers, see +xmodmap(1)+
+
+Mode_switch::
+Unlike other window managers, i3 can use Mode_switch as a modifier. This allows
+you to remap capslock (for example) to Mode_switch and use it for both: typing
+umlauts or special characters 'and' having some comfortably reachable key
+bindings. For example, when typing, capslock+1 or capslock+2 for switching
+workspaces is totally convenient. Try it :-).
+
 === Automatically putting clients on specific workspaces
 
-It is recommended that you match on window classes whereever possible because some applications
-first create their window and then care about setting the correct title. Firefox with Vimperator
-comes to mind, as the window starts up being named Firefox and only when Vimperator is loaded,
-the title changes. As i3 will get the title as soon as the application maps the window (mapping
-means actually displaying it on the screen), you’d need to have to match on Firefox in this case.
+It is recommended that you match on window classes whereever possible because
+some applications first create their window and then care about setting the
+correct title. Firefox with Vimperator comes to mind, as the window starts up
+being named Firefox and only when Vimperator is loaded, the title changes. As
+i3 will get the title as soon as the application maps the window (mapping means
+actually displaying it on the screen), you’d need to have to match on Firefox
+in this case.
 
 *Syntax*:
 ----------------------------------------------------
index c1369c731eccf49cf13de7cb1df6757fa748edff..7bc3fe80927a96dda12681f2250cb45cd7d7d9ab 100644 (file)
--- a/i3.config
+++ b/i3.config
@@ -1,6 +1,9 @@
 # This configuration uses Mod1 and Mod3. Make sure they are mapped properly using xev(1)
 # and xmodmap(1). Usually, Mod1 is Alt (Alt_L) and Mod3 is Windows (Super_L)
 
+# Tell i3 about your preferred terminal. You can refer to this as $terminal
+# later. It is recommended to set this option to allow i3 to open a terminal
+# containing the introduction on first start.
 terminal /usr/bin/urxvt
 
 # ISO 10646 = Unicode
index 562b2e928bb3a02afc72dd1b7be42f56a233f78a..ab9ea9aa0cdc7cd19a0533b85b997ba0b08a66e2 100644 (file)
@@ -144,7 +144,7 @@ void load_configuration(const char *override_configpath) {
                                 class_title++;
                                 char *end = strchr(class_title, '"');
                                 if (end == NULL)
-                                        die("Malformatted assignment, couldn't find finishing quote\n");
+                                        die("Malformed assignment, couldn't find terminating quote\n");
                                 *end = '\0';
                         } else {
                                 /* If it is not quoted, we terminate it at the first space */