<%! section = "docs" %> <%inherit file="_templates/i3.mako" />

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!

These documents are for i3 version 4.2.

For users

User’s Guide
Introduction and reference. Read this one.

Multi-monitor
Interesting for users of the nVidia driver.

Debugging i3
Explains you how to enable the i3 logfile.

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

i3 reference card
Might be useful to memorize i3’s shortcuts.

For developers

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

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

Debugging i3
Explains you how to enable core dumps.

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

i3 testsuite
Explains how our test suite works, including a walk-through of a whole test case.

i3bar protocol
Documents the JSON based protocol which i3bar uses.

i3 buildbot setup
Describes the buildbot setup we use for automatic docs, compilation and debian packages.