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

   1 <%!
   2         section = "docs"
   3 %>
   4 <%inherit file="_templates/i3.mako" />
   5 <div id="content">
   6 <h2>Documentation</h2>
   7
   8 <p>
   9 One of i3’s goals is good documentation. The documents which you will find
  10 below will hopefully answer all your questions. If you have any corrections or
  11 suggestions please let us know!
  12 </p>
  13
  14 <p>
  15 Because version 4.0 is quite new, we still have the old documentation for 3.ε
  16 online for a few weeks. You can chose which version you want by clicking on the
  17 boxes right next to the links.
  18 </p>
  19
  20 <div class="docs">
  21 <h2>For users</h2>
  22
  23 <p style="font-size: 100%">
  24 <a href="/docs/userguide.html"><strong>User’s Guide</strong></a>
  25 <span class="docversion"><a href="/docs/4.0/userguide.html">4.0</a></span>
  26 <span class="docversion"><a href="/docs/3.e/userguide.html">3.ε</a></span><br>
  27 Introduction and reference. Read this one.
  28 </p>
  29
  30 <p>
  31 <a href="/docs/multi-monitor.html"><strong>Multi-monitor</strong></a>
  32 <span class="docversion"><a href="/docs/4.0/multi-monitor.html">4.0</a></span>
  33 <span class="docversion"><a href="/docs/3.e/multi-monitor.html">3.ε</a></span><br>
  34 Interesting for users of the nVidia driver.
  35 </p>
  36
  37 <p>
  38 <a href="/docs/debugging.html"><strong>Debugging i3</strong></a>
  39 <span class="docversion"><a href="/docs/4.0/debugging.html">4.0</a></span>
  40 <span class="docversion"><a href="/docs/3.e/debugging.html">3.ε</a></span><br>
  41 Explains you how to enable the i3 logfile.
  42 </p>
  43
  44 <p>
  45 <a href="/docs/wsbar.html"><strong>External workspace bars</strong></a>
  46 <span class="docversion"><a href="/docs/4.0/wsbar.html">4.0</a></span>
  47 <span class="docversion"><a href="/docs/3.e/wsbar.html">3.ε</a></span><br>
  48 About bar programs such as i3bar or dzen2.
  49 </p>
  50
  51 <p>
  52 <a href="/docs/refcard.pdf"><strong>i3 reference card (PDF)</strong></a>
  53 <span class="docversion"><a href="/docs/4.0/refcard.pdf">4.0</a></span>
  54 <span class="docversion"><a href="/docs/3.e/refcard.pdf">3.ε</a></span><br>
  55 Might be useful to memorize i3’s shortcuts.
  56 </p>
  57 </div>
  58
  59 <div class="docs">
  60 <h2>For developers</h2>
  61
  62 <p>
  63 <a href="/downloads/#development-version"><strong>Downloads → Development version</strong></a><br>
  64 Tells you how to check out our git repository.
  65 </p>
  66
  67 <p>
  68 <a href="/docs/hacking-howto.html"><strong>Hacking Howto</strong></a>
  69 <span class="docversion"><a href="/docs/4.0/hacking-howto.html">4.0</a></span>
  70 <span class="docversion"><a href="/docs/3.e/hacking-howto.html">3.ε</a></span><br>
  71 Helps you if you want to get into i3’s source code.
  72 </p>
  73
  74 <p>
  75 <a href="/docs/debugging.html"><strong>Debugging i3</strong></a>
  76 <span class="docversion"><a href="/docs/4.0/debugging.html">4.0</a></span>
  77 <span class="docversion"><a href="/docs/3.e/debugging.html">3.ε</a></span><br>
  78 Explains you how to enable core dumps.
  79 </p>
  80
  81 <p>
  82 <a href="/docs/ipc.html"><strong>IPC documentation</strong></a>
  83 <span class="docversion"><a href="/docs/4.0/ipc.html">4.0</a></span>
  84 <span class="docversion"><a href="/docs/3.e/ipc.html">3.ε</a></span><br>
  85 Explains how i3’s Inter Process Communication interface works. Read this if you
  86 want to talk to i3 within your own scripts or programs.
  87 </p>
  88
  89 </div>
  90
  91 <br style="clear: both">
  92
  93 </div>