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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <link rel="icon" type="image/x-icon" href="/favicon.ico">\r
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
   7 <meta name="generator" content="AsciiDoc 8.6.9" />\r
   8 <title>i3: Debugging i3: How To</title>\r
   9 <link rel="stylesheet" href="/css/style.css" type="text/css" />\r
  10 <link rel="stylesheet" href="/css/xhtml11.css" type="text/css" />\r
  11 <script type="text/javascript">\r
  12 /*<![CDATA[*/\r
  13 document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes();}, false);\r
  14 /*]]>*/\r
  15 </script>\r
  16 <script type="text/javascript" src="/js/asciidoc-xhtml11.js"></script>\r
  17 </head>\r
  18 <body class="article">\r
  19 \r
  20         <div id="main">\r
  21             <a href="/"><h1 id="title">i3 - improved tiling WM</h1></a>\r
  22                         <ul id="nav">\r
  23                                 <li><a style="border-bottom: 2px solid #fff" href="/docs">Docs</a></li>\r
  24                                 <li><a href="/screenshots">Screens</a></li>\r
  25                                 <li><a href="https://www.reddit.com/r/i3wm/">FAQ</a></li>\r
  26                                 <li><a href="/contact">Contact</a></li>\r
  27                                 <li><a href="https://github.com/i3/i3/issues">Bugs</a></li>\r
  28                         </ul>\r
  29         <br style="clear: both">\r
  30 <div id="content">\r
  31 <div id="header">\r
  32 <h1>Debugging i3: How To</h1>\r
  33 <span id="author">Michael Stapelberg</span><br />\r
  34 <span id="email"><tt>&lt;<a href="mailto:michael@i3wm.org">michael@i3wm.org</a>&gt;</tt></span><br />\r
  35 <span id="revdate">January 2014</span>\r
  36 </div>\r
  37 <div id="preamble">\r
  38 <div class="sectionbody">\r
  39 <div class="paragraph"><p>This document describes how to debug i3 to send us useful bug\r
  40 reports, even if you have no knowledge of C programming.</p></div>\r
  41 <div class="paragraph"><p>Thank you for being interested in debugging i3. It really means\r
  42 something to us to get your bug fixed. If you have any questions about the\r
  43 process and/or need further help, do not hesitate to contact us!</p></div>\r
  44 </div>\r
  45 </div>\r
  46 <div class="sect1">\r
  47 <h2 id="_verify_you_are_using_i3_4_13">1. Verify you are using i3 ≥ 4.13</h2>\r
  48 <div class="sectionbody">\r
  49 <div class="paragraph"><p>Only the latest major version of i3 is supported. To verify which version\r
  50 you are running, use:</p></div>\r
  51 <div class="listingblock">\r
  52 <div class="content">\r
  53 <pre><tt>$ i3 --moreversion 2&gt;&amp;- || i3 --version\r
  54 Binary i3 version:  4.7 (2013-12-22, branch "tags/4.7")\r
  55 Running i3 version: 4.7-84-gac74a63 (2014-01-01, branch "next") (pid 1995)</tt></pre>\r
  56 </div></div>\r
  57 <div class="paragraph"><p>Your version can look like this:</p></div>\r
  58 <div class="dlist"><dl>\r
  59 <dt class="hdlist1">\r
  60 4.7 (release version)\r
  61 </dt>\r
  62 <dd>\r
  63 <p>\r
  64 You are using a release version. In many cases, bugs are already\r
  65 fixed in the development version of i3. Even if the bug is not a known fixed\r
  66 one, we will still ask you to reproduce your error with the most recent\r
  67 development version of i3. Therefore, please upgrade to a development version\r
  68 if you can.\r
  69 </p>\r
  70 </dd>\r
  71 <dt class="hdlist1">\r
  72 4.7-85-g9c15b95 (development version)\r
  73 </dt>\r
  74 <dd>\r
  75 <p>\r
  76 Your version is 85 commits newer than 4.7, and the git revision of your\r
  77 version is <tt>9c15b95</tt>. Go to <a href="http://code.i3wm.org/i3/commit/?h=next">http://code.i3wm.org/i3/commit/?h=next</a> and see if\r
  78 the line "commit" starts with the same revision. If so, you are using the\r
  79 latest version.\r
  80 </p>\r
  81 </dd>\r
  82 </dl></div>\r
  83 <div class="paragraph"><p>Development versions of i3 have logging enabled by default and are compiled\r
  84 with debug symbols.</p></div>\r
  85 </div>\r
  86 </div>\r
  87 <div class="sect1">\r
  88 <h2 id="_enabling_logging">2. Enabling logging</h2>\r
  89 <div class="sectionbody">\r
  90 <div class="paragraph"><p>If you are using a development version (see previous section), you don’t need\r
  91 to do anything&#8201;&#8212;&#8201;skip to section 3.</p></div>\r
  92 <div class="paragraph"><p>If you are using a release version with a custom <tt>~/.xsession</tt> (or xinitrc)\r
  93 file, execute i3 with a line like this:</p></div>\r
  94 <div class="listingblock">\r
  95 <div class="content">\r
  96 <pre><tt># Use 25 MiB of RAM for debug logs\r
  97 exec i3 --shmlog-size=26214400</tt></pre>\r
  98 </div></div>\r
  99 <div class="paragraph"><p>If you are <strong>NOT</strong> using an <tt>~/.xsession</tt> file but you just chose "i3" from the\r
 100 list of sessions in your desktop manager (gdm, lxdm, …), edit\r
 101 <tt>/usr/share/xsessions/i3.desktop</tt> and replace the <tt>Exec=i3</tt> line with:</p></div>\r
 102 <div class="listingblock">\r
 103 <div class="content">\r
 104 <pre><tt>Exec=i3 --shmlog-size=26214400</tt></pre>\r
 105 </div></div>\r
 106 <div class="paragraph"><p>If you cannot restart i3 for some reason, you can enable debug logging on the\r
 107 fly:</p></div>\r
 108 <div class="listingblock">\r
 109 <div class="content">\r
 110 <pre><tt>i3-msg 'debuglog on; shmlog on; reload'</tt></pre>\r
 111 </div></div>\r
 112 </div>\r
 113 </div>\r
 114 <div class="sect1">\r
 115 <h2 id="_reproducing_the_problem">3. Reproducing the problem</h2>\r
 116 <div class="sectionbody">\r
 117 <div class="paragraph"><p>Before submitting an issue, please make sure to close down on the problem as\r
 118 much as you can yourself. Here are some steps you should consider:</p></div>\r
 119 <div class="ulist"><ul>\r
 120 <li>\r
 121 <p>\r
 122 Find a deterministic, reliable way to reproduce the problem and provide it\r
 123   with your bug report.\r
 124 </p>\r
 125 </li>\r
 126 <li>\r
 127 <p>\r
 128 Try using the default i3 config to reproduce the problem. If the issue does\r
 129   not appear with the default config, gradually adapt it to track down what\r
 130   change(s) to the config introduce the problem.\r
 131 </p>\r
 132 </li>\r
 133 <li>\r
 134 <p>\r
 135 Reproduce the problem with a minimal setup, i.e., only use as few applications,\r
 136   windows and steps as necessary.\r
 137 </p>\r
 138 </li>\r
 139 <li>\r
 140 <p>\r
 141 In addition, try to stick to applications that are common and, even more\r
 142   importantly, free / open source.\r
 143 </p>\r
 144 </li>\r
 145 <li>\r
 146 <p>\r
 147 Before obtaining the log file, restart i3 in-place, execute the steps to\r
 148   reproduce the problem and then save the logs. This keeps the log file as\r
 149   small as possible and necessary.\r
 150 </p>\r
 151 </li>\r
 152 </ul></div>\r
 153 <div class="paragraph"><p>Please be aware that we cannot support compatibility issues with closed-source\r
 154 software, as digging into compatibility problems without having access to the\r
 155 source code is too time-consuming. Additionally, experience has shown that\r
 156 often, the software in question is responsible for the issue. Please raise an\r
 157 issue with the software in question, not i3.</p></div>\r
 158 </div>\r
 159 </div>\r
 160 <div class="sect1">\r
 161 <h2 id="_obtaining_the_debug_logfile">4. Obtaining the debug logfile</h2>\r
 162 <div class="sectionbody">\r
 163 <div class="admonitionblock">\r
 164 <table><tr>\r
 165 <td class="icon">\r
 166 <div class="title">Caution</div>\r
 167 </td>\r
 168 <td class="content">\r
 169 <div class="paragraph"><p>Logs may contain sensitive information, so please inspect the log before\r
 170 submitting it. Logs may be viewed by anyone, once posted. If you choose to\r
 171 redact the log, make an effort not to discard information which may be relevant\r
 172 to the issue you are reporting.</p></div>\r
 173 <div class="paragraph"><p>The best way to avoid submitting such information is to only run the necessary\r
 174 steps to reproduce the behavior when saving the log file. This will also make\r
 175 analyzing the log file easier.</p></div>\r
 176 </td>\r
 177 </tr></table>\r
 178 </div>\r
 179 <div class="paragraph"><p>No matter whether i3 misbehaved in some way without crashing or whether it just\r
 180 crashed, the logfile provides all information necessary to debug the problem.</p></div>\r
 181 <div class="paragraph"><p>To upload a compressed version of the logfile (for a bugreport), use:</p></div>\r
 182 <div class="listingblock">\r
 183 <div class="content">\r
 184 <pre><tt>DISPLAY=:0 i3-dump-log | bzip2 -c | curl --data-binary @- http://logs.i3wm.org</tt></pre>\r
 185 </div></div>\r
 186 <div class="paragraph"><p>This command does not depend on i3 (it also works while i3 displays\r
 187 the crash dialog), but it requires a working X11 connection.</p></div>\r
 188 <div class="paragraph"><p>After running it, you will get a URL to the logfile. Please include that URL in\r
 189 your bug report.</p></div>\r
 190 </div>\r
 191 </div>\r
 192 <div class="sect1">\r
 193 <h2 id="_on_crashes_obtaining_a_backtrace">5. On crashes: Obtaining a backtrace</h2>\r
 194 <div class="sectionbody">\r
 195 <div class="paragraph"><p>When i3 crashes, it will display a dialog stating “i3 just crashed”, offering\r
 196 you to save a backtrace to a text file.</p></div>\r
 197 <div class="paragraph"><p>To actually get useful backtraces, you should make sure that your version of i3\r
 198 is compiled with debug symbols:</p></div>\r
 199 <div class="listingblock">\r
 200 <div class="content">\r
 201 <pre><tt>$ file `which i3`\r
 202 /usr/bin/i3: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically\r
 203 linked (uses shared libs), for GNU/Linux 2.6.18, not stripped</tt></pre>\r
 204 </div></div>\r
 205 <div class="paragraph"><p>Notice the <tt>not stripped</tt>, which is the important part. If you have a version\r
 206 which is stripped, please check whether your distribution provides debug\r
 207 symbols (package <tt>i3-wm-dbg</tt> on Debian for example) or if you can turn off\r
 208 stripping. If nothing helps, please build i3 from source.</p></div>\r
 209 <div class="paragraph"><p>Once you have made sure that your i3 is compiled with debug symbols and the C\r
 210 debugger <tt>gdb</tt> is installed on your machine, you can let i3 generate a\r
 211 backtrace in the crash dialog.</p></div>\r
 212 <div class="paragraph"><p>After pressing "b" in the crash dialog, you will get a file called\r
 213 <tt>/tmp/i3-backtrace.%d.%d.txt</tt> where the first <tt>%d</tt> is replaced by i3’s process\r
 214 id (PID) and the second one is incremented each time you generate a backtrace,\r
 215 starting at 0.</p></div>\r
 216 </div>\r
 217 </div>\r
 218 <div class="sect1">\r
 219 <h2 id="_sending_bug_reports_debugging_on_irc">6. Sending bug reports/debugging on IRC</h2>\r
 220 <div class="sectionbody">\r
 221 <div class="paragraph"><p>When sending bug reports, please attach the <strong>whole</strong> log file. Even if you think\r
 222 you found the section which clearly highlights the problem, additional\r
 223 information might be necessary to completely diagnose the problem.</p></div>\r
 224 <div class="paragraph"><p>When debugging with us in IRC, be prepared to use a so called nopaste service\r
 225 such as <a href="http://nopaste.info">http://nopaste.info</a> or <a href="http://pastebin.com">http://pastebin.com</a> because pasting large\r
 226 amounts of text in IRC sometimes leads to incomplete lines (servers have line\r
 227 length limitations) or flood kicks.</p></div>\r
 228 </div>\r
 229 </div>\r
 230 <div class="sect1">\r
 231 <h2 id="_debugging_i3bar">7. Debugging i3bar</h2>\r
 232 <div class="sectionbody">\r
 233 <div class="paragraph"><p>To debug i3bar problems, add <tt>verbose yes</tt> to all <tt>bar {}</tt> blocks in your i3\r
 234 config, reload your config and then restart all i3bar instances like this:</p></div>\r
 235 <div class="listingblock">\r
 236 <div class="content">\r
 237 <pre><tt>$ i3 reload\r
 238 $ killall i3bar\r
 239 $ for c in $(i3-msg -t get_bar_config | python -c \\r
 240       'import json,sys;print("\n".join(json.load(sys.stdin)))'); do \\r
 241     (i3bar --bar_id=$c &gt;i3bar.$c.log 2&gt;&amp;1) &amp; \\r
 242   done;</tt></pre>\r
 243 </div></div>\r
 244 <div class="paragraph"><p>There will now be <tt>i3bar.*.log</tt> files in your current directory that you can provide\r
 245 in your bug report.</p></div>\r
 246 </div>\r
 247 </div>\r
 248 </div>\r
 249 <div id="footnotes"><hr /></div>\r
 250 <div id="footer" lang="de">\r
 251 © 2009-2011 Michael Stapelberg, <a href="/impress.html">Impressum</a>\r
 252 </div>\r
 253 </body>\r
 254 </html>\r