From b09a341cb93278628fb992fe34002f85595fe5e1 Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Wed, 11 Feb 2015 16:59:42 +0000 Subject: [PATCH 1/2] Document dbus-test-tool Bug: https://bugs.freedesktop.org/show_bug.cgi?id=89086 --- configure.ac | 1 + doc/Makefile.am | 1 + doc/dbus-test-tool.1.xml.in | 325 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 327 insertions(+) create mode 100644 doc/dbus-test-tool.1.xml.in diff --git a/configure.ac b/configure.ac index a74590d..7f6cf16 100644 --- a/configure.ac +++ b/configure.ac @@ -1789,6 +1789,7 @@ doc/dbus-launch.1.xml doc/dbus-monitor.1.xml doc/dbus-run-session.1.xml doc/dbus-send.1.xml +doc/dbus-test-tool.1.xml doc/dbus-uuidgen.1.xml dbus-1.pc dbus-1-uninstalled.pc diff --git a/doc/Makefile.am b/doc/Makefile.am index b9a4c10..3879a61 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -7,6 +7,7 @@ man_pages = \ dbus-monitor.1 \ dbus-run-session.1 \ dbus-send.1 \ + dbus-test-tool.1 \ dbus-uuidgen.1 \ $(NULL) diff --git a/doc/dbus-test-tool.1.xml.in b/doc/dbus-test-tool.1.xml.in new file mode 100644 index 0000000..091dee1 --- /dev/null +++ b/doc/dbus-test-tool.1.xml.in @@ -0,0 +1,325 @@ + + + + + + 2015 + Collabora Ltd. + + + This man page is distributed under the same terms as + dbus-test-tool (GPL-2+). There is NO WARRANTY, to the extent + permitted by law. + + + + + dbus-test-tool + 1 + User Commands + D-Bus + @DBUS_VERSION@ + + + dbus-test-tool + D-Bus traffic generator and test tool + + + + + dbus-test-tool + black-hole + + --session + --system + + --name=NAME + --no-read + + + + dbus-test-tool + echo + + --session + --system + + --name=NAME + --sleep=MS + + + + dbus-test-tool + spam + + --session + --system + + --dest=NAME + --count=N + --flood + --ignore-errors + --messages-per-conn=N + --no-reply + --queue=N + --seed=SEED + + --string + --bytes + --empty + + + --payload=S + --stdin + --message-stdin + --random-size + + + + + + DESCRIPTION + dbus-test-tool is a multi-purpose tool + for debugging and profiling D-Bus. + + dbus-test-tool black-hole + connects to D-Bus, optionally requests a name, then does not + reply to messages. It normally reads and discards messages from + its D-Bus socket, but can be configured to sleep forever without + reading. + + dbus-test-tool echo + connects to D-Bus, optionally requests a name, then sends back an + empty reply to every method call, after an optional delay. + + dbus-test-tool spam + connects to D-Bus and makes repeated method calls, + normally named com.example.Spam. + + + + OPTIONS + + Common options + + + + + + Connect to the session bus. This is the default. + + + + + + + Connect to the system bus. + + + + + + + + black-hole mode + + + + NAME + + Before proceeding, request ownership of the well-known + bus name NAME, for example + com.example.NoReply. By default, + no name is requested, and the tool can only be addressed by + a unique bus name such as :1.23. + + + + + + + Do not read from the D-Bus socket. + + + + + + + + echo mode + + + + NAME + + Before proceeding, request ownership of the well-known + bus name NAME, for example + com.example.Echo. By default, + no name is requested, and the tool can only be addressed by + a unique bus name such as :1.23. + + + + + MS + + Block for MS milliseconds + before replying to a method call. + + + + + + + + spam mode + + + + NAME + + Send method calls to the well-known or unique + bus name NAME. + The default is the dbus-daemon, + org.freedesktop.DBus. + + + + + N + + Send N method calls in total. + The default is 1. + + + + + N + + Send N method calls before + waiting for any replies, then send one new call per reply + received, keeping N method calls + "in flight" at all times until the number of messages specified + with the option have been sent. + The default is 1, unless + is used. + + + + + + + Send all messages without waiting for a reply, + equivalent to with an arbitrarily + large N. + + + + + + + Set the "no reply desired" flag on the messages. + This implies , since it disables + the replies that would be used for a finite + length. + + + + + N + + If given, send N method calls + on the same connection, then disconnect and reconnect. + The default is to use the same connection for all method + calls. + + + + + + + The payload of each message is a UTF-8 string. This is the + default. The actual string used is given by the + or + option, defaulting to "hello, world!". + + + + + + + The payload of each message is a byte-array. + The actual bytes used are given by the + or + option, defaulting to the ASCII encoding of + "hello, world!". + + + + + + + The messages have no payload. + + + + + S + + Use S as the + or + in the messages. The default is "hello, world!". + + + + + + + Read from standard input until end-of-file is reached, + and use that as the or + in the messages. + + + + + + + Read a complete binary D-Bus method call message from + standard input, and use that for each method call. + + + + + + + Read whitespace-separated ASCII decimal numbers from + standard input, choose one at random for each message, + and send a message whose payload is a string of that + length. + + + + + SEED + + Use SEED as the seed + for the pseudorandom number generator, to have somewhat + repeatable sequences of random messages. + + + + + + + + + BUGS + Please send bug reports to the D-Bus bug tracker or mailing list. + See http://www.freedesktop.org/software/dbus/. + + + + SEE ALSO + dbus-send1 + + -- 2.1.4