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 for i3 v4.2</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 <div class="docs">
  15 <h2>For users</h2>
  16
  17 <p style="font-size: 100%; background-color: #444; border-radius: 5px; padding: 0.5em; width: 90%">
  18 <a href="/docs/userguide.html" style="font-size: 125%"><strong>User’s Guide</strong></a><br>
  19 Introduction and reference. Read this!
  20 </p>
  21
  22 <p>
  23 <a href="/docs/multi-monitor.html"><strong>Multi-monitor</strong></a><br>
  24 Interesting for users of the nVidia driver.
  25 </p>
  26
  27 <p>
  28 <a href="/docs/debugging.html"><strong>Debugging i3</strong></a><br>
  29 Explains you how to enable debug logging.
  30 </p>
  31
  32 <p>
  33 <a href="/docs/wsbar.html"><strong>External workspace bars</strong></a><br>
  34 About bar programs such as i3bar or dzen2.
  35 </p>
  36
  37 <p>
  38 <a href="/docs/refcard.html"><strong>i3 reference card</strong></a><br>
  39 Might be useful to memorize i3’s shortcuts.
  40 </p>
  41 </div>
  42
  43 <div class="docs">
  44 <h2>For developers</h2>
  45
  46 <p style="padding-top: 1em">
  47 <a href="/docs/hacking-howto.html"><strong>Hacking Howto</strong></a><br>
  48 Helps you if you want to get into i3’s source code.
  49 </p>
  50
  51 <p>
  52 <a href="/docs/debugging.html"><strong>Debugging i3</strong></a><br>
  53 Explains you how to enable debug logging.
  54 </p>
  55
  56 <p>
  57 <a href="/docs/ipc.html"><strong>Inter process communication (IPC interface)</strong></a><br>
  58 Read this if you want to talk to i3 within your script.
  59 </p>
  60
  61 <p>
  62 <a href="/docs/testsuite.html"><strong>i3 testsuite</strong></a><br>
  63 Makes you able to read and write i3 testcases.
  64 </p>
  65
  66 <p>
  67 <a href="/docs/i3bar-protocol.html"><strong>i3bar protocol</strong></a><br>
  68 Documents the JSON based protocol which i3bar uses.
  69 </p>
  70
  71 </div>
  72
  73 <br style="clear: both">
  74
  75 <h2>User-contributed articles</h2>
  76
  77 <div class="ugdocs">
  78
  79 <p>
  80 <a href="/docs/buildbot.html"><strong>i3 buildbot setup</strong></a> <span class="author">(2012-09, by Michael)</span><br>
  81 Describes the <a href="http://www.buildbot.net/">buildbot</a> setup i3 uses for
  82 automatic docs, compilation and debian packages.
  83 </p>
  84
  85 <p>
  86 <a href="/docs/user-contributed/lzap-config.html"><strong>Lukáš Zapletal’s i3
  87 configuration</strong></a> <span class="author">(2012-08, by Lukáš)</span><br>
  88 A detailed explanation of Lukáš’s configuration of i3 and related tools.
  89 </p>
  90
  91 <p>
  92 <a href="/docs/user-contributed/swapping-workspaces.html"><strong>Swapping
  93 workspaces</strong></a> <span class="author">(2012-09, by Sagar)</span><br>
  94 Shows how Sagar uses i3’s IPC interface to swap workspaces between two outputs.
  95 </p>
  96
  97 </div>
  98
  99 </div>