Documentation

One of i3’s goals is good documentation. The documents which you will find below will hopefully answer all your questions. If you have any corrections or suggestions please let us know!

Because version 4.0 is quite new, we still have the old documentation for 3.ε online for a few weeks. You can chose which version you want by clicking on the boxes right next to the links.

For users

User’s Guide 4.0 3.ε
Introduction and reference. Read this one.

Multi-monitor 4.0 3.ε
Interesting for users of the nVidia driver.

Debugging i3 4.0 3.ε
Explains you how to enable the i3 logfile.

External workspace bars 4.0 3.ε
About bar programs such as i3bar or dzen2.

i3 reference card (PDF) 4.0 3.ε
Might be useful to memorize i3’s shortcuts.

For developers

Downloads → Development version
Tells you how to check out our git repository.

Hacking Howto 4.0 3.ε
Helps you if you want to get into i3’s source code.

Debugging i3 4.0 3.ε
Explains you how to enable core dumps.

IPC documentation 4.0 3.ε
Explains how i3’s Inter Process Communication interface works. Read this if you want to talk to i3 within your own scripts or programs.