summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWill Thompson <will@willthompson.co.uk>2012-01-17 16:31:51 +0000
committerWill Thompson <will@willthompson.co.uk>2012-01-17 16:31:51 +0000
commit1b3cb496088b1c075a1cf4fd79f7d9dd0b01f822 (patch)
treedfa3d504518ee3bee0e3bac350dee010c1d8160e
parentb97a8fa45584f6f30db17426061017543e2b9c30 (diff)
Update "documentation"
-rw-r--r--HACKING2
-rw-r--r--INSTALL2
-rw-r--r--README29
3 files changed, 17 insertions, 16 deletions
diff --git a/HACKING b/HACKING
index e7c7ddb..b91f82e 100644
--- a/HACKING
+++ b/HACKING
@@ -7,5 +7,3 @@ Grab the latest code from git:
and get stuck in! Please submit patches, or links to git branches, as
bugs on <https://bugs.freedesktop.org/enter_bug.cgi?product=Bustle>.
-
-Hacking bustle-dbus-monitor.c is not advised.
diff --git a/INSTALL b/INSTALL
index 7b1cade..44ab5c4 100644
--- a/INSTALL
+++ b/INSTALL
@@ -30,4 +30,4 @@ you can view logs generated on your fancy embedded hardware on your more
pedestrian Linux laptop. The logger depends on a few widely-available
libraries:
- sudo apt-get install libdbus-1-dev libglib2.0-dev libpcap-dev
+ sudo apt-get install libglib2.0-dev libpcap-dev
diff --git a/README b/README
index b8feb70..5d6dc21 100644
--- a/README
+++ b/README
@@ -10,29 +10,32 @@ times.
Using Bustle
============
-Capture some D-Bus traffic:
+Run it:
- bustle-pcap logfile.bustle
+ bustle
+
+Now click **File → New…** to start recording session bus traffic. When you're
+done, click **Stop**, and explore the log.
-Now look at some diagrams and statistics based on it:
+If you want to record traffic without running the UI (maybe on an embedded
+platform which doesn't have Gtk+), you can use the stand-alone logger:
- bustle logfile.bustle
+ bustle-pcap logfile.bustle
-Or get some ASCII art versions of those stats:
+You can then open `logfile.bustle` in Bustle. You can also get some ASCII-art
+version of the statistics shown in the UI:
bustle --count logfile.bustle
bustle --time logfile.bustle
+If you want to log all system bus traffic, you need to edit
+/etc/dbus/system.conf to enable eavesdropping, and then remove the include of
+/etc/dbus-1/system.conf.d which seems to re-enable strictness. Then you can run
+the stand-alone logger against the system bus:
-FAQ
-===
-
-How do I log the system bus?
-----------------------------
+ bustle-pcap --system system-log.bustle
-You need to edit /etc/dbus/system.conf to enable eavesdropping, and then
-remove the include of /etc/dbus-1/system.conf.d which seems to re-enable
-strictness. Please remember to undo your changes when you're done logging!
+Please remember to **undo these changes** when you're done.
More information