2003-05-03 Havoc Pennington <hp@pobox.com>

	* tools/Makefile.am, tools/dbus-send.1, tools/dbus-monitor.1:
	add some man pages

diff --git a/ChangeLog b/ChangeLog
index 31417b9b28760b1f1b6252818f6f604370845779..4d526ceb1ec7518b32ef14d2872a0e109fae1a73 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2003-05-03  Havoc Pennington  <hp@pobox.com>
+
+       * tools/Makefile.am, tools/dbus-send.1, tools/dbus-monitor.1: 
+       add some man pages
+
 2003-05-03  Colin Walters  <walters@verbum.org>
 
        * dbus/dbus-sysdeps.c (fill_user_info): Test against

diff --git a/tools/Makefile.am b/tools/Makefile.am
index f1f9dbac1f251e5f8eac620f2a63fb8e0d4ee83a..868b50283ecc05498e36bd28bca8c7d2f44f5bf5 100644 (file)
--- 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 (file)
index 0000000..2c72873
--- /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 (file)
index 0000000..7635813
--- /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/