]> git.sur5r.net Git - i3/i3/blobdiff - man/i3.man
Use doxygen compatible comments
[i3/i3] / man / i3.man
index dc6ebc4259fff4f8e90d03db8ad5eb72bf4ecb35..70333805bedc648b695480fefc793498b8fdfd9a 100644 (file)
@@ -1,7 +1,7 @@
 i3(1)
 =====
 Michael Stapelberg <michael+i3@stapelberg.de>
-v3.alpha, March 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
 
@@ -24,16 +32,6 @@ create i3.
 
 Please be aware that i3 is primarily targeted at advanced users and developers.
 
-=== ABOUT THIS RELEASE
-
-What you are using is i3.alpha. That means, it is a preview release, not yet fully
-stable, may still contain bugs and the implementation of several behaviour is
-subject to change. However, it should provide you with a pretty good picture of
-how i3 will look in subsequent releases.
-
-Please, use i3 and report all the bugs/problems you encounter by sending an
-email to <michael+i3 at stapelberg.de>
-
 === TERMINOLOGY
 
 Client::
@@ -49,7 +47,7 @@ Container::
 A container contains a variable number of clients. Each cell of the table is a container.
 +
 Containers can be used in various modes. The default mode is called "default" and just
-resizes each client equally so that it fits. The stacking mode is currently not implemented.
+resizes each client equally so that it fits.
 
 Workspace::
 A workspace is a set of clients (technically speaking, it’s just a table). Other window
@@ -65,7 +63,7 @@ Using Xinerama, you can have an X11 screen spanning multiple real monitors. Furt
 you can set them up in cloning mode or with positions (monitor 1 is left of monitor 2).
 +
 A virtual screen is the result of your Xinerama setup. For example, if you have attached
-two real monitors (let’s say your laptop screen and a beamer) and enabled cloning, i3
+two real monitors (let’s say your laptop screen and a video projector) and enabled cloning, i3
 will use one virtual screen with the size of the smallest screen you have attached (so
 that you can see all your windows on each screen all the time).
 If you have two monitors attached, one configured to be left of the other, i3 will use
@@ -76,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>.
@@ -102,14 +101,23 @@ Move window to workspace <number>.
 Mod1+f::
 Toggle fullscreen mode.
 
-Mod1+s::
+Mod1+h::
 Enable stacking layout for the current container.
 
-Mod1+d::
+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).
@@ -158,13 +166,22 @@ bind Mod1+Shift+26 exit
 bind Mod1+97 exec sudo sh -c "echo up > /proc/acpi/ibm/brightness"
 bind Mod1+103 exec sudo sh -c "echo down > /proc/acpi/ibm/brightness"
 
-# Fullscreen
+# Fullscreen (Mod1+f)
 bind Mod1+41 f
-# Stacking
+
+# Stacking (Mod1+h)
 bind Mod1+43 s
-# Default
+
+# 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
@@ -216,22 +233,32 @@ 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
-export LC_TIME=de_DE.ISO8859-15
-export LC_NUMERIC=de_DE.ISO8859-15
-export LC_MONETARY=de_DE.ISO8859-15
+export LC_TIME=de_DE.UTF-8
+export LC_NUMERIC=de_DE.UTF-8
+export LC_MONETARY=de_DE.UTF-8
 export LC_MESSAGES=C
-export LC_PAPER=de_DE.ISO8859-15
-export LC_NAME=de_DE.ISO8859-15
-export LC_ADDRESS=de_DE.ISO8859-15
-export LC_TELEPHONE=de_DE.ISO8859-15
-export LC_MEASUREMENT=de_DE.ISO8859-15
-export LC_IDENTIFICATION=de_DE.ISO8859-15
+export LC_PAPER=de_DE.UTF-8
+export LC_NAME=de_DE.UTF-8
+export LC_ADDRESS=de_DE.UTF-8
+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
@@ -243,12 +270,16 @@ exec /usr/bin/i3 >> ~/.i3/logfile
 
 == TODO
 
-There is lots of stuff left to do. This release is to be considered as a technology preview.
-Here is an overwiew of the most important points:
+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+.
 
- * IPC
- * floating
- * do something about applications which don’t use _NET_WM_STATE_FULLSCREEN (like xpdf)
+You can also access these documents online at http://i3.zekjur.net/
 
 == AUTHOR