summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRay Strode <rstrode@redhat.com>2008-07-11 10:27:07 -0400
committerRay Strode <rstrode@redhat.com>2008-07-12 13:38:04 -0400
commit01e50bcd5d06c3ffdf6a78036d7b1ea8f9ad0762 (patch)
tree7c6b8ebb91552fdd9baba9640fe25236c29e3075
parent37853b6dd04fa32a6f948438d2fbdcd08bd473e4 (diff)
Update man page to make the point of the <type> element more clear
There have been a number of patches in the past try to key system versus session bus policy off of the message bus type, when the policy should be distinguished from more fine-grained options in the individulal policy files. Hopefully, this man page update will make that more clear.
-rw-r--r--bus/dbus-daemon.1.in16
1 files changed, 15 insertions, 1 deletions
diff --git a/bus/dbus-daemon.1.in b/bus/dbus-daemon.1.in
index e230e513..5599afe6 100644
--- a/bus/dbus-daemon.1.in
+++ b/bus/dbus-daemon.1.in
@@ -138,7 +138,21 @@ Root element.
The well-known type of the message bus. Currently known values are
"system" and "session"; if other values are set, they should be
either added to the D-Bus specification, or namespaced. The last
-<type> element "wins" (previous values are ignored).
+<type> element "wins" (previous values are ignored). This element
+only controls which message bus specific environment variables are
+set in activated clients. Most of the policy that distinguishes a
+session bus from the system bus is controlled from the other elements
+in the configuration file.
+
+.PP
+If the well-known type of the message bus is "session", then the
+DBUS_STARTER_BUS_TYPE environment variable will be set to "session"
+and the DBUS_SESSION_BUS_ADDRESS environment variable will be set
+to the address of the session bus. Likewise, if the type of the
+message bus is "system", then the DBUS_STARTER_BUS_TYPE environment
+variable will be set to "system" and the DBUS_SESSION_BUS_ADDRESS
+environment variable will be set to the address of the system bus
+(which is normally well known anyway).
.PP
Example: <type>session</type>