Use doxygen compatible comments

[i3/i3] / man / i3.man

diff --git a/man/i3.man b/man/i3.man
index 4f0c3fe417d327b4df3d1168197d08dc74cba9ea..70333805bedc648b695480fefc793498b8fdfd9a 100644 (file)
--- a/man/i3.man
+++ b/man/i3.man
@@ -1,7 +1,7 @@
 i3(1)
 =====
 Michael Stapelberg <michael+i3@stapelberg.de>
-v3.alpha-bf1, May 2009
+v3.delta, November 2009
 
 == NAME
 
@@ -9,7 +9,15 @@ i3 - an improved dynamic, tiling window manager
 
 == SYNOPSIS
 
-i3 [-c configfile]
+i3 [-c configfile] [-a]
+
+== OPTIONS
+
+-c::
+Specifies an alternate configuration file path
+
+-a::
+Disables autostart.
 
 == DESCRIPTION
 
@@ -66,7 +74,8 @@ two virtual screens.
 Here is a short overview of the default keybindings:
 
 j/k/l/;::
-Direction keys (left, down, up, right). They are on your homerow (see the mark on your "j" key).
+Direction keys (left, down, up, right). They are on your homerow (see the mark
+on your "j" key). Alternatively, you can use the cursor keys.
 
 Mod1+<direction>::
 Focus window in <direction>.
@@ -98,8 +107,17 @@ Enable stacking layout for the current container.
 Mod1+e::
 Enable default layout for the current container.
 
+Mod1+Shift+Space::
+Toggle tiling/floating for the current window.
+
+Mod1+t::
+Select the first tiling window if the current window is floating and vice-versa.
+
 Mod1+Shift+q::
-Kills the current client.
+Kills the current window. This is equivalent to "clicking on the close button", meaning a polite
+request to the application to close this window. For example, Firefox will save its session
+upon such a request. If the application does not support that, the window will be killed and
+it depends on the application what happens.
 
 Mod1+Shift+r::
 Restarts i3 in place (without losing any windows, but the layout).
@@ -157,6 +175,13 @@ bind Mod1+43 s
 # Default (Mod1+e)
 bind Mod1+26 d
 
+# Toggle tiling/floating of the current window (Mod1+Shift+Space)
+bind Mod1+Shift+65 t
+
+# Go into the tiling layer / floating layer, depending on whether
+# the current window is tiling / floating (Mod1+t)
+bind Mod1+28 focus ft
+
 # Focus (Mod1+j/k/l/;)
 bind Mod1+44 h
 bind Mod1+45 j
@@ -208,9 +233,13 @@ your login manager (xdm, slim, gdm, …) as soon as you login.
 # Disable DPMS turning off the screen
 xset dpms force on
 xset s off
+
 # Disable bell
 xset -b
 
+# Enable zapping (C-A-<Bksp> kills X)
+setxkbmap -option terminate:ctrl_alt_bksp
+
 # Enforce correct locales from the beginning
 unset LC_COLLATE
 export LC_CTYPE=de_DE.UTF-8
@@ -225,6 +254,12 @@ export LC_TELEPHONE=de_DE.UTF-8
 export LC_MEASUREMENT=de_DE.UTF-8
 export LC_IDENTIFICATION=de_DE.UTF-8
 
+# Use XToolkit in java applications
+export AWT_TOOLKIT=XToolkit
+
+# Set background color
+xsetroot -solid "#333333"
+
 # Enable core dumps in case something goes wrong
 ulimit -c unlimited
 
@@ -238,6 +273,14 @@ exec /usr/bin/i3 >> ~/.i3/logfile
 There is still lot of work to do. Please check our bugtracker for up-to-date information
 about tasks which are still not finished.
 
+== SEE ALSO
+
+You should have a copy of the userguide (featuring nice screenshots/graphics which is why this
+is not integrated into this manpage), the debugging guide and the "how to hack" guide. If you
+are building from source, run +make -C docs+.
+
+You can also access these documents online at http://i3.zekjur.net/
+
 == AUTHOR
 
 Michael Stapelberg and contributors