X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Findex.html.mako;h=fba865e62e94392512a752b7ceb6971f61736b25;hb=32b9b3682e5ae50d8979284d900ac9d80bc94f3d;hp=78d08d1f0fa9d27c1c369fd7ed2ff5062af58179;hpb=d412d183db4600a4ddebd3dbaf6218089e4788bb;p=i3%2Fi3.github.io diff --git a/docs/index.html.mako b/docs/index.html.mako index 78d08d1..fba865e 100644 --- a/docs/index.html.mako +++ b/docs/index.html.mako @@ -3,7 +3,7 @@ %> <%inherit file="_templates/i3.mako" />
-

Documentation

+

Documentation for i3 v4.8

One of i3’s goals is good documentation. The documents which you will find @@ -11,18 +11,20 @@ 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.1.1. -

-

For users

-

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

+User’s Guide
+Introduction and reference. Read this! +

+ +

+Layout saving/restoring
+Explains how to save a layout and restore it in a new i3 session.

+

Multi-monitor
Interesting for users of the nVidia driver. @@ -30,7 +32,7 @@ Interesting for users of the nVidia driver.

Debugging i3
-Explains you how to enable the i3 logfile. +Explains you how to enable debug logging.

@@ -39,7 +41,7 @@ About bar programs such as i3bar or dzen2.

-i3 reference card (PDF)
+i3 reference card
Might be useful to memorize i3’s shortcuts.

@@ -47,35 +49,76 @@ 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. +Explains you how to enable debug logging.

-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. +Inter process communication (IPC interface)
+Read this if you want to talk to i3 within your script.

i3 testsuite
-Explains how our test suite works, including a walk-through of a whole test -case. +Makes you able to read and write i3 testcases. +

+ +

+i3bar protocol
+Documents the JSON based protocol which i3bar uses.


+

User-contributed articles

+ +
+ +

+i3 buildbot setup (2012-09, by Michael)
+Describes the buildbot setup i3 uses for +automatic docs, compilation and debian packages. +

+ +

+Lukáš Zapletal’s i3 +configuration (2012-08, by Lukáš)
+A detailed explanation of Lukáš’s configuration of i3 and related tools. +

+ +

+Swapping +workspaces (2012-09, by Sagar)
+Shows how Sagar uses i3’s IPC interface to swap workspaces between two outputs. +

+ +

+Using conky with +i3bar (2012-11, by Gianrico)
+Shows how to configure conky to generate JSON input for i3bar (with colors)! +

+ +

+Enhanced and extensible +i3bar with py3status (2013-02, by Ultrabug)
+Introduces py3status, a wrapper script for i3status which is easily extensible. +

+ +

+i3wm T-shirts +(2013-12, by Stefan)
+Where and how to order official i3 T-shirts. +

+ + +
+