git.sur5r.net Git - i3/i3.github.io/blob - docs/index.html

   1 ---
   2 layout: default
   3 title: Docs
   4 group: Docs
   5 ---
   6 <div id="content">
   7 <h2>Documentation for i3 v4.8</h2>
   8
   9 <p>
  10 One of i3’s goals is good documentation. The documents which you will find
  11 below will hopefully answer all your questions. If you have any corrections or
  12 suggestions please let us know!
  13 </p>
  14
  15 <div class="docs">
  16 <h2>For users</h2>
  17
  18 <p style="font-size: 100%; background-color: #444; border-radius: 5px; padding: 0.5em; width: 90%">
  19 <a href="/docs/userguide.html" style="font-size: 125%"><strong>User’s Guide</strong></a><br>
  20 Introduction and reference. Read this!
  21 </p>
  22
  23 <p>
  24 <a href="/docs/layout-saving.html"><strong>Layout saving/restoring</strong></a><br>
  25 Explains how to save a layout and restore it in a new i3 session.
  26 </p>
  27
  28
  29 <p>
  30 <a href="/docs/multi-monitor.html"><strong>Multi-monitor</strong></a><br>
  31 Interesting for users of the nVidia driver.
  32 </p>
  33
  34 <p>
  35 <a href="/docs/debugging.html"><strong>Debugging i3</strong></a><br>
  36 Explains you how to enable debug logging.
  37 </p>
  38
  39 <p>
  40 <a href="/docs/wsbar.html"><strong>External workspace bars</strong></a><br>
  41 About bar programs such as i3bar or dzen2.
  42 </p>
  43
  44 <p>
  45 <a href="/docs/refcard.html"><strong>i3 reference card</strong></a><br>
  46 Might be useful to memorize i3’s shortcuts.
  47 </p>
  48 </div>
  49
  50 <div class="docs">
  51 <h2>For developers</h2>
  52
  53 <p style="padding-top: 1em">
  54 <a href="/docs/hacking-howto.html"><strong>Hacking Howto</strong></a><br>
  55 Helps you if you want to get into i3’s source code.
  56 </p>
  57
  58 <p>
  59 <a href="/docs/debugging.html"><strong>Debugging i3</strong></a><br>
  60 Explains you how to enable debug logging.
  61 </p>
  62
  63 <p>
  64 <a href="/docs/ipc.html"><strong>Inter process communication (IPC interface)</strong></a><br>
  65 Read this if you want to talk to i3 within your script.
  66 </p>
  67
  68 <p>
  69 <a href="/docs/testsuite.html"><strong>i3 testsuite</strong></a><br>
  70 Makes you able to read and write i3 testcases.
  71 </p>
  72
  73 <p>
  74 <a href="/docs/i3bar-protocol.html"><strong>i3bar protocol</strong></a><br>
  75 Documents the JSON based protocol which i3bar uses.
  76 </p>
  77
  78 </div>
  79
  80 <br style="clear: both">
  81
  82 <h2>User-contributed articles</h2>
  83
  84 <div class="ugdocs">
  85
  86 <p>
  87 <a href="/docs/buildbot.html"><strong>i3 buildbot setup</strong></a> <span class="author">(2012-09, by Michael)</span><br>
  88 Describes the <a href="http://www.buildbot.net/">buildbot</a> setup i3 uses for
  89 automatic docs, compilation and debian packages.
  90 </p>
  91
  92 <p>
  93 <a href="/docs/user-contributed/lzap-config.html"><strong>Lukáš Zapletal’s i3
  94 configuration</strong></a> <span class="author">(2012-08, by Lukáš)</span><br>
  95 A detailed explanation of Lukáš’s configuration of i3 and related tools.
  96 </p>
  97
  98 <p>
  99 <a href="/docs/user-contributed/swapping-workspaces.html"><strong>Swapping
 100 workspaces</strong></a> <span class="author">(2012-09, by Sagar)</span><br>
 101 Shows how Sagar uses i3’s IPC interface to swap workspaces between two outputs.
 102 </p>
 103
 104 <p>
 105 <a href="/docs/user-contributed/conky-i3bar.html"><strong>Using conky with
 106 i3bar</strong></a> <span class="author">(2012-11, by Gianrico)</span><br>
 107 Shows how to configure conky to generate JSON input for i3bar (with colors)!
 108 </p>
 109
 110 <p>
 111 <a href="/docs/user-contributed/py3status.html"><strong>Enhanced and extensible
 112 i3bar with py3status</strong></a> <span class="author">(2013-02, by Ultrabug)</span><br>
 113 Introduces py3status, a wrapper script for i3status which is easily extensible.
 114 </p>
 115
 116 <p>
 117 <a href="/docs/tshirts.html"><strong>i3wm T-shirts</strong></a>
 118 <span class="author">(2013-12, by Stefan)</span><br>
 119 Where and how to order official i3 T-shirts.
 120 </p>
 121
 122
 123 </div>
 124
 125 </div>