make the 4.0 docs the default

[i3/i3.github.io] / docs / debugging.html

diff --git a/docs/debugging.html b/docs/debugging.html
index 9ff561e262f16e58db11872db615bf71515fe6a3..4101fc0afcd5298fc09813f8f817e768362ac642 100644 (file)
--- a/docs/debugging.html
+++ b/docs/debugging.html
@@ -31,7 +31,7 @@ window.onload = function(){asciidoc.footnotes();}
 <h1>Debugging i3: How To</h1>\r
 <span id="author">Michael Stapelberg</span><br />\r
 <span id="email"><tt>&lt;<a href="mailto:michael+i3@stapelberg.de">michael+i3@stapelberg.de</a>&gt;</tt></span><br />\r
-<span id="revdate">March 2010</span>\r
+<span id="revdate">July 2011</span>\r
 </div>\r
 <div id="preamble">\r
 <div class="sectionbody">\r
@@ -45,14 +45,20 @@ debugging and/or need further help, do not hesitate to contact us!</p></div>
 <div class="sect1">\r
 <h2 id="_enabling_logging">1. Enabling logging</h2>\r
 <div class="sectionbody">\r
-<div class="paragraph"><p>i3 spits out much information onto stdout, if told so. To have a clearly\r
-defined place where log files will be saved, you should redirect stdout and\r
-stderr in xsession. While you’re at it, putting each run of i3 in a separate\r
-log file with date/time in it is a good idea to not get confused about the\r
-different log files later on.</p></div>\r
+<div class="paragraph"><p>i3 logs useful information to stdout. To have a clearly defined place where log\r
+files will be saved, you should redirect stdout and stderr in your\r
+<tt>~/.xsession</tt>. While you’re at it, putting each run of i3 in a separate log\r
+file with date/time in its filename is a good idea to not get confused about\r
+the different log files later on.</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>exec /usr/bin/i3 -V -d all &gt;/home/michael/i3/i3log-$(date +'%F-%k-%M-%S') 2&gt;&amp;1</tt></pre>\r
+<pre><tt>exec /usr/bin/i3 &gt;~/i3log-$(date +'%F-%k-%M-%S') 2&gt;&amp;1</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>To enable verbose output and all levels of debug output (required when\r
+attaching logfiles to bugreports), add the parameters <tt>-V -d all</tt>, like this:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>exec /usr/bin/i3 -V -d all &gt;~/i3log-$(date +'%F-%k-%M-%S') 2&gt;&amp;1</tt></pre>\r
 </div></div>\r
 </div>\r
 </div>\r
@@ -64,7 +70,7 @@ of the memory of the i3 process which can be loaded into a debugger). To get a
 core dump, you have to make sure that the user limit for core dump files is set\r
 high enough. Many systems ship with a default value which even forbids core\r
 dumps completely. To disable the limit completely and thus enable core dumps,\r
-use the following command (in your .xsession, before starting i3):</p></div>\r
+use the following command (in your <tt>~/.xsession</tt>, before starting i3):</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt>ulimit -c unlimited</tt></pre>\r
@@ -85,9 +91,9 @@ process id (%p) in it. You can save this setting across reboots using
 <h2 id="_compiling_with_debug_symbols">3. Compiling with debug symbols</h2>\r
 <div class="sectionbody">\r
 <div class="paragraph"><p>To actually get useful core dumps, you should make sure that your version of i3\r
-is compiled with debug symbols, that is, that they are not stripped during the\r
-build process. You can check whether your executable contains symbols by\r
-issuing the following command:</p></div>\r
+is compiled with debug symbols, that is, that the symbols are not stripped\r
+during the build process. You can check whether your executable contains\r
+symbols by issuing the following command:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt>file $(which i3)</tt></pre>\r