diff options
| author | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2015-01-23 19:32:31 +0000 |
|---|---|---|
| committer | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2015-02-04 17:15:34 +0000 |
| commit | 1a28f82926c31ae17b8688bdeb6d68f29d628592 (patch) | |
| tree | 0ecd757a2b158f4c79841b705da72126ab7fa285 /doc | |
| parent | 8a621b8f77706d2ce4feb7b0ffa946b4b95326c8 (diff) | |
| download | dbus-1a28f82926c31ae17b8688bdeb6d68f29d628592.tar.gz dbus-1a28f82926c31ae17b8688bdeb6d68f29d628592.tar.bz2 dbus-1a28f82926c31ae17b8688bdeb6d68f29d628592.zip | |
dbus-monitor: add options to log binary data with or without pcap framing
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=46787
Reviewed-by: Philip Withnall <philip.withnall@collabora.co.uk>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/dbus-monitor.1.xml.in | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/doc/dbus-monitor.1.xml.in b/doc/dbus-monitor.1.xml.in index af05e3aa..2f807d2f 100644 --- a/doc/dbus-monitor.1.xml.in +++ b/doc/dbus-monitor.1.xml.in @@ -22,7 +22,7 @@ <cmdsynopsis> <command>dbus-monitor</command> <group choice='opt'><arg choice='plain'>--system </arg><arg choice='plain'>--session </arg><arg choice='plain'>--address <replaceable>ADDRESS</replaceable></arg></group> - <group choice='opt'><arg choice='plain'>--profile </arg><arg choice='plain'>--monitor </arg></group> + <group choice='opt'><arg choice='plain'>--profile </arg><arg choice='plain'>--monitor </arg><arg choice='plain'>--pcap </arg><arg choice='plain'>--binary </arg></group> <arg choice='opt'><arg choice='plain'><replaceable>watch</replaceable></arg><arg choice='plain'><replaceable>expressions</replaceable></arg></arg> <sbr/> </cmdsynopsis> @@ -44,11 +44,22 @@ monitor the system or session buses respectively. If neither is specified, <command>dbus-monitor</command> monitors the session bus.</para> -<para><command>dbus-monitor</command> has two different output modes, the 'classic'-style -monitoring mode and profiling mode. The profiling format is a compact +<para><command>dbus-monitor</command> has two different text output +modes: the 'classic'-style +monitoring mode, and profiling mode. The profiling format is a compact format with a single line per message and microsecond-resolution timing information. The --profile and --monitor options select the profiling -and monitoring output format respectively. If neither is specified, +and monitoring output format respectively.</para> + +<para><command>dbus-monitor</command> also has two binary output modes. + The binary mode, selected by <literal>--binary</literal>, outputs the + entire binary message stream (without the initial authentication handshake). + The PCAP mode, selected by <literal>--pcap</literal>, adds a + PCAP file header to the beginning of the output, and prepends a PCAP + message header to each message; this produces a binary file that can + be read by, for instance, Wireshark.</para> + +<para>If no mode is specified, <command>dbus-monitor</command> uses the monitoring output format.</para> |