Merge pull request #1669 from Airblader/feature-docs-2

[i3/i3] / docs / debugging

diff --git a/docs/debugging b/docs/debugging
index 9dec3056ec0643b7b8b0c0eb32a0d0bd35037ded..894a873b10b1111b3bea5bc2c97fff60b275c1d3 100644 (file)
--- a/docs/debugging
+++ b/docs/debugging
@@ -10,10 +10,10 @@ Thank you for being interested in debugging i3. It really means
 something to us to get your bug fixed. If you have any questions about the
 process and/or need further help, do not hesitate to contact us!
 
-== Verify you are using i3 ≥ 4.7
+== Verify you are using i3 ≥ 4.10
 
-Only the latest major version of i3 is supported, i.e. version 4.7 currently.
-To verify which version you are running, use:
+Only the latest major version of i3 is supported. To verify which version
+you are running, use:
 
 ---------------
 $ i3 --moreversion 2>&- || i3 --version
@@ -72,15 +72,17 @@ i3-msg 'debuglog on; shmlog on; reload'
 No matter whether i3 misbehaved in some way without crashing or whether it just
 crashed, the logfile provides all information necessary to debug the problem.
 
-To save a compressed version of the logfile (suitable for attaching it to a
-bugreport), use:
---------------------------------------------------------------------
-DISPLAY=:0 i3-dump-log | bzip2 -c > /tmp/i3.log.bz2
---------------------------------------------------------------------
+To upload a compressed version of the logfile (for a bugreport), use:
+------------------------------------------------------------------------------
+DISPLAY=:0 i3-dump-log | bzip2 -c | curl --data-binary @- http://logs.i3wm.org
+------------------------------------------------------------------------------
 
 This command does not depend on i3 (it also works while i3 displays
 the crash dialog), but it requires a working X11 connection.
 
+After running it, you will get a URL to the logfile. Please include that URL in
+your bug report.
+
 == On crashes: Obtaining a backtrace
 
 When i3 crashes, it will display a dialog stating “i3 just crashed”, offering
@@ -119,3 +121,19 @@ When debugging with us in IRC, be prepared to use a so called nopaste service
 such as http://nopaste.info or http://pastebin.com because pasting large
 amounts of text in IRC sometimes leads to incomplete lines (servers have line
 length limitations) or flood kicks.
+
+== Debugging i3bar
+
+To debug i3bar problems, add +verbose yes+ to all +bar {}+ blocks in your i3 config
+and then restart all i3bar instances like this:
+
+---------------------------------------------------------------------
+$ killall i3bar
+$ for c in $(i3-msg -t get_bar_config | python -c \
+      'import json,sys;print("\n".join(json.load(sys.stdin)))'); do \
+    (i3bar --bar_id=$c >i3bar.$c.log 2>&1) & \
+  done;
+---------------------------------------------------------------------
+
+There will now be +i3bar.*.log+ files in your current directory that you can provide
+in your bug report.