summaryrefslogtreecommitdiff
path: root/tools
diff options
context:
space:
mode:
authorHavoc Pennington <hp@redhat.com>2003-05-03 22:03:16 +0000
committerHavoc Pennington <hp@redhat.com>2003-05-03 22:03:16 +0000
commit24373ede7cad885f67fabafc781f8524459fc475 (patch)
tree0d2bf5d8259e5717ca2967389c041aa16dead431 /tools
parent6c013f3be1c2a48b82a4e8b92ce2163e3770c908 (diff)
downloaddbus-24373ede7cad885f67fabafc781f8524459fc475.tar.gz
2003-05-03 Havoc Pennington <hp@pobox.com>
* tools/Makefile.am, tools/dbus-send.1, tools/dbus-monitor.1: add some man pages
Diffstat (limited to 'tools')
-rw-r--r--tools/Makefile.am3
-rw-r--r--tools/dbus-monitor.139
-rw-r--r--tools/dbus-send.164
3 files changed, 106 insertions, 0 deletions
diff --git a/tools/Makefile.am b/tools/Makefile.am
index f1f9dbac..868b5028 100644
--- a/tools/Makefile.am
+++ b/tools/Makefile.am
@@ -16,3 +16,6 @@ dbus_monitor_SOURCES= \
dbus_send_LDADD= $(top_builddir)/dbus/libdbus-1.la
dbus_monitor_LDADD= $(top_builddir)/glib/libdbus-glib-1.la
+
+man_MANS = dbus-send.1 dbus-monitor.1
+EXTRA_DIST = $(man_MANS)
diff --git a/tools/dbus-monitor.1 b/tools/dbus-monitor.1
new file mode 100644
index 00000000..2c728735
--- /dev/null
+++ b/tools/dbus-monitor.1
@@ -0,0 +1,39 @@
+.\"
+.\" dbus-monitor manual page.
+.\" Copyright (C) 2003 Red Hat, Inc.
+.\"
+.TH dbus-monitor 1
+.SH NAME
+dbus-monitor \- debug probe to print message bus messages
+.SH SYNOPSIS
+.PP
+.B dbus-monitor
+
+.SH DESCRIPTION
+
+The \fIdbus-monitor\fP command is used to monitor messages going
+through a D-BUS message bus. See
+http://www.freedesktop.org/software/dbus/ for more information about
+the big picture.
+
+.PP
+There are two well-known message buses: the systemwide message bus
+(installed on many systems as the "messagebus" service) and the
+per-user-login-session message bus (started each time a user logs in).
+Right now, \fIdbus-monitor\fP is hardcoded to only work with the
+systemwide message bus. It should really be extended to have a
+\-\-session command line option as with \fIdbus-send\fP.
+
+.PP
+The message bus configuration may keep \fIdbus-monitor\fP from seeing
+all messages, especially if you run the monitor as a non-root user.
+
+.SH OPTIONS
+No options are currently supported.
+
+.SH AUTHOR
+dbus-monitor was written by Philip Blundell.
+
+.SH BUGS
+Please send bug reports to the D-BUS mailing list or bug tracker,
+see http://www.freedesktop.org/software/dbus/
diff --git a/tools/dbus-send.1 b/tools/dbus-send.1
new file mode 100644
index 00000000..76358132
--- /dev/null
+++ b/tools/dbus-send.1
@@ -0,0 +1,64 @@
+.\"
+.\" dbus-send manual page.
+.\" Copyright (C) 2003 Red Hat, Inc.
+.\"
+.TH dbus-send 1
+.SH NAME
+dbus-send \- Send a message to a message bus
+.SH SYNOPSIS
+.PP
+.B dbus-send
+[\-\-session] [\-\-dest=SERVICE] <message name> [contents ...]
+
+.SH DESCRIPTION
+
+The \fIdbus-send\fP command is used to send a message to a D-BUS message
+bus. See http://www.freedesktop.org/software/dbus/ for more
+information about the big picture.
+
+.PP
+There are two well-known message buses: the systemwide message bus
+(installed on many systems as the "messagebus" service) and the
+per-user-login-session message bus (started each time a user logs in).
+\fIdbus-send\fP sends messages to the system bus by default, and
+to the per-session bus if you specify \-\-session.
+
+.PP
+Nearly all uses of \fIdbus-send\fP must provide the \-\-dest
+argument which is the name of a service on the bus to send
+the message to. The other required argument is the name
+of the message to send. Following arguments are the message
+contents (message arguments).
+
+.PP
+The message arguments are given as a type name, a colon,
+and then the value of the argument. The possible type names
+are: string, int32, uint32, double, byte, boolean.
+D-BUS supports more types than these, but \fIdbus-send\fP
+does not currently.
+
+.PP
+Here is an example invocation:
+.nf
+
+ dbus-send \-\-dest='org.freedesktop.ExampleService' \\
+ org.freedesktop.ExampleMessage \\
+ int32:47 string:'hello world' double:65.32
+
+.fi
+
+.SH OPTIONS
+The following options are supported:
+.TP
+.I "--session"
+Use the per-login-session message bus instead of the systemwide bus.
+.TP
+.I "--dest=SERVICE"
+Specify the service to receive the message.
+
+.SH AUTHOR
+dbus-send was written by Philip Blundell.
+
+.SH BUGS
+Please send bug reports to the D-BUS mailing list or bug tracker,
+see http://www.freedesktop.org/software/dbus/