DESCRIPTION

From 4dda4bb3f7c76c850eff146390e859527ce0379c Mon Sep 17 00:00:00 2001 From: Ralf Habacker Date: Tue, 5 Feb 2013 02:19:28 +0100 Subject: [PATCH 2/4] Updated man docbook xml sources from man page source using doclifter. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=59805 --- cmake/doc/CMakeLists.txt | 2 + doc/dbus-cleanup-sockets.1.xml | 64 +++++ doc/dbus-daemon.1.xml.in | 582 +++++++++++++++++++++++++--------------- doc/dbus-launch.1.xml | 78 ++++-- doc/dbus-monitor.1.xml | 12 +- doc/dbus-send.1.xml | 72 +++-- doc/dbus-uuidgen.1.xml | 125 +++++++++ 7 Dateien geändert, 653 Zeilen hinzugefügt(+), 282 Zeilen entfernt(-) create mode 100644 doc/dbus-cleanup-sockets.1.xml create mode 100644 doc/dbus-uuidgen.1.xml diff --git a/cmake/doc/CMakeLists.txt b/cmake/doc/CMakeLists.txt index 3c6d952..a0bb361 100644 --- a/cmake/doc/CMakeLists.txt +++ b/cmake/doc/CMakeLists.txt @@ -102,6 +102,8 @@ DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-daemon.1.xml html-nochunks) DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-monitor.1.xml html-nochunks) DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-send.1.xml html-nochunks) DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-launch.1.xml html-nochunks) +DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-uuidgen.1.xml html-nochunks) +DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-cleanup-sockets.1.xml html-nochunks) # # handle html index file diff --git a/doc/dbus-cleanup-sockets.1.xml b/doc/dbus-cleanup-sockets.1.xml new file mode 100644 index 0000000..190b68a --- /dev/null +++ b/doc/dbus-cleanup-sockets.1.xml @@ -0,0 +1,64 @@ + + + + + + + + +dbus-cleanup-sockets +1 + + +dbus-cleanup-sockets +clean up leftover sockets in a directory + + + + + dbus-cleanup-sockets DIRECTORY + + + + + +DESCRIPTION +The dbus-cleanup-sockets command cleans up unused D-Bus +connection sockets. See http://www.freedesktop.org/software/dbus/ for +more information about the big picture. + + +If given no arguments, dbus-cleanup-sockets cleans up sockets +in the standard default socket directory for the +per-user-login-session message bus; this is usually /tmp. +Optionally, you can pass a different directory on the command line. + + +On Linux, this program is essentially useless, because D-Bus defaults +to using "abstract sockets" that exist only in memory and don't have a +corresponding file in /tmp. + + +On most other flavors of UNIX, it's possible for the socket files to +leak when programs using D-Bus exit abnormally or without closing +their D-Bus connections. Thus, it might be interesting to run +dbus-cleanup-sockets in a cron job to mop up any leaked sockets. +Or you can just ignore the leaked sockets, they aren't really hurting +anything, other than cluttering the output of "ls /tmp" + + + +AUTHOR +dbus-cleanup-sockets was adapted by Havoc Pennington from +linc-cleanup-sockets written by Michael Meeks. + + + +BUGS +Please send bug reports to the D-Bus mailing list or bug tracker, +see http://www.freedesktop.org/software/dbus/ + + + diff --git a/doc/dbus-daemon.1.xml.in b/doc/dbus-daemon.1.xml.in index f331699..bc602bb 100644 --- a/doc/dbus-daemon.1.xml.in +++ b/doc/dbus-daemon.1.xml.in @@ -1,17 +1,17 @@ - + - - - - + + + dbus-daemon 1 - + dbus-daemon Message bus daemon @@ -41,35 +41,29 @@ application that uses this library to implement a message bus daemon. Multiple programs connect to the message bus daemon and can exchange messages with one another. - -There are two standard message bus instances: the systemwide message bus -(installed on many systems as the "messagebus" init service) and the +There are two standard message bus instances: the systemwide message bus +(installed on many systems as the "messagebus" init service) and the per-user-login-session message bus (started each time a user logs in). -dbus-daemon is used for both of these instances, but with +dbus-daemon is used for both of these instances, but with a different configuration file. - The --session option is equivalent to -"--config-file=/etc/dbus-1/session.conf" and the --system +"--config-file=@EXPANDED_SYSCONFDIR@/dbus-1/session.conf" and the --system option is equivalent to -"--config-file=/etc/dbus-1/system.conf". By creating +"--config-file=@EXPANDED_SYSCONFDIR@/dbus-1/system.conf". By creating additional configuration files and using the --config-file option, additional special-purpose message bus daemons could be created. +The systemwide daemon is normally launched by an init script, +standardly called simply "messagebus". -The systemwide daemon is normally launched by an init script, -standardly called simply "messagebus". - - -The systemwide daemon is largely used for broadcasting system events, +The systemwide daemon is largely used for broadcasting system events, such as changes to the printer queue, or adding/removing devices. - -The per-session daemon is used for various interprocess communication -among desktop applications (however, it is not tied to X or the GUI +The per-session daemon is used for various interprocess communication +among desktop applications (however, it is not tied to X or the GUI in any way). - SIGHUP will cause the D-Bus daemon to PARTIALLY reload its configuration file and to flush its user/group information caches. Some configuration changes would require kicking all apps off the bus; so they will @@ -90,25 +84,28 @@ with SIGHUP. -Force the message bus to fork and become a daemon, even if +Force the message bus to fork and become a daemon, even if the configuration file does not specify that it should. In most contexts the configuration file already gets this -right, though. +right, though. + +Force the message bus not to fork and become a daemon, even if +the configuration file specifies that it should. -Print the address of the message bus to standard output, or -to the given file descriptor. This is used by programs that +Print the address of the message bus to standard output, or +to the given file descriptor. This is used by programs that launch the message bus. -Print the process ID of the message bus to standard output, or -to the given file descriptor. This is used by programs that +Print the process ID of the message bus to standard output, or +to the given file descriptor. This is used by programs that launch the message bus. @@ -129,6 +126,33 @@ bus. Print the version of the daemon. + + + + + +Print the introspection information for all D-Bus internal interfaces. + + + + + +Set the address to listen on. This option overrides the address +configured in the configuration file. + + + + + +Enable systemd-style service activation. Only useful in conjunction +with the systemd system and session manager on Linux. + + + + + +Don't write a PID file even if one is configured in the configuration +files. @@ -137,23 +161,20 @@ bus. CONFIGURATION FILE A message bus daemon has a configuration file that specializes it -for a particular application. For example, one configuration -file might set up the message bus to be a systemwide message bus, +for a particular application. For example, one configuration +file might set up the message bus to be a systemwide message bus, while another might set it up to be a per-user-login-session bus. - The configuration file also establishes resource limits, security parameters, and so forth. - The configuration file is not part of any interoperability specification and its backward compatibility is not guaranteed; this document is documentation, not specification. - The standard systemwide and per-session message bus setups are -configured in the files "/etc/dbus-1/system.conf" and -"/etc/dbus-1/session.conf". These files normally +configured in the files "@EXPANDED_SYSCONFDIR@/dbus-1/system.conf" and +"@EXPANDED_SYSCONFDIR@/dbus-1/session.conf". These files normally <include> a system-local.conf or session-local.conf; you can put local overrides in those files to avoid modifying the primary configuration files. @@ -171,43 +192,50 @@ doctype declaration: The following elements may be present in the configuration file. - - - <busconfig> - - - - - + + + <busconfig> + + + Root element. - - - <type> - + - - - - + <type> + + + 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. + + +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). Example: <type>session</type> - - - <include> - - - - - + + + <include> + + + Include a file <include>filename.conf</include> at this point. If the filename is relative, it is located relative to the configuration file @@ -215,19 +243,16 @@ doing the including. <include> has an optional attribute "ignore_missing=(yes|no)" -which defaults to "no" if not provided. This attribute -controls whether it's a fatal error for the included file +which defaults to "no" if not provided. This attribute +controls whether it's a fatal error for the included file to be absent. - - - <includedir> - + - - - - + <includedir> + + + Include all files in <includedir>foo.d</includedir> at this point. Files in the directory are included in undefined order. @@ -237,18 +262,15 @@ Only files ending in ".conf" are included. This is intended to allow extension of the system bus by particular packages. For example, if CUPS wants to be able to send out notification of printer queue changes, it could install a file to -/etc/dbus-1/system.d that allowed all apps to receive +@EXPANDED_SYSCONFDIR@/dbus-1/system.d that allowed all apps to receive this message and allowed the printer daemon user to send it. - - - <user> - + - - - - + <user> + + + The user account the daemon should run as, as either a username or a UID. If the daemon cannot change to this UID on startup, it will exit. @@ -261,97 +283,127 @@ about its UID. The user is changed after the bus has completed initialization. So sockets etc. will be created before changing user, but no data will be -read from clients before changing user. This means that sockets -and PID files can be created in a location that requires root +read from clients before changing user. This means that sockets +and PID files can be created in a location that requires root privileges for writing. - - - <fork> - - - - - + -If present, the bus daemon becomes a real daemon (forks -into the background, etc.). This is generally used + <fork> + + + + +If present, the bus daemon becomes a real daemon (forks +into the background, etc.). This is generally used rather than the --fork command line option. - - - <listen> - + - - - - + <keep_umask> + + + + +If present, the bus daemon keeps its original umask when forking. +This may be useful to avoid affecting the behavior of child processes. + + -Add an address that the bus should listen on. The -address is in the standard D-Bus format that contains + <listen> + + + + +Add an address that the bus should listen on. The +address is in the standard D-Bus format that contains a transport name plus possible parameters/options. Example: <listen>unix:path=/tmp/foo</listen> -If there are multiple <listen> elements, then the bus listens -on multiple addresses. The bus will pass its address to -started services or other interested parties with -the last address given in <listen> first. That is, +Example: <listen>tcp:host=localhost,port=1234</listen> + + +If there are multiple <listen> elements, then the bus listens +on multiple addresses. The bus will pass its address to +started services or other interested parties with +the last address given in <listen> first. That is, apps will try to connect to the last <listen> address first. - - - <auth> - - - - - +tcp sockets can accept IPv4 addresses, IPv6 addresses or hostnames. +If a hostname resolves to multiple addresses, the server will bind +to all of them. The family=ipv4 or family=ipv6 options can be used +to force it to bind to a subset of addresses + + +Example: <listen>tcp:host=localhost,port=0,family=ipv4</listen> + + +A special case is using a port number of zero (or omitting the port), +which means to choose an available port selected by the operating +system. The port number chosen can be obtained with the +--print-address command line parameter and will be present in other +cases where the server reports its own address, such as when +DBUS_SESSION_BUS_ADDRESS is set. + + +Example: <listen>tcp:host=localhost,port=0</listen> + + +tcp addresses also allow a bind=hostname option, which will override +the host option specifying what address to bind to, without changing +the address reported by the bus. The bind option can also take a +special name '*' to cause the bus to listen on all local address +(INADDR_ANY). The specified host should be a valid name of the local +machine or weird stuff will happen. + + +Example: <listen>tcp:host=localhost,bind=*,port=0</listen> + + + + <auth> + + + Lists permitted authorization mechanisms. If this element doesn't exist, then all known mechanisms are allowed. If there are multiple <auth> elements, all the listed mechanisms are allowed. The order in which mechanisms are listed is not meaningful. - + Example: <auth>EXTERNAL</auth> Example: <auth>DBUS_COOKIE_SHA1</auth> - - - <servicedir> - + - - - - + <servicedir> + + + Adds a directory to scan for .service files. Directories are -scanned starting with the last to appear in the config file -(the first .service file found that provides a particular +scanned starting with the last to appear in the config file +(the first .service file found that provides a particular service will be used). Service files tell the bus how to automatically start a program. -They are primarily used with the per-user-session bus, +They are primarily used with the per-user-session bus, not the systemwide bus. - - - <standard_session_servicedirs/> - + - - - - + <standard_session_servicedirs/> + + + <standard_session_servicedirs/> is equivalent to specifying a series of <servicedir/> elements for each of the data directories in the "XDG @@ -367,18 +419,48 @@ otherwise try your favorite search engine. The <standard_session_servicedirs/> option is only relevant to the per-user-session bus daemon defined in -/etc/dbus-1/session.conf. Putting it in any other +@EXPANDED_SYSCONFDIR@/dbus-1/session.conf. Putting it in any other configuration file would probably be nonsense. - - - <limit> - + - - - - + <standard_system_servicedirs/> + + + + +<standard_system_servicedirs/> specifies the standard system-wide +activation directories that should be searched for service files. +This option defaults to @EXPANDED_DATADIR@/dbus-1/system-services. + + +The <standard_system_servicedirs/> option is only relevant to the +per-system bus daemon defined in +@EXPANDED_SYSCONFDIR@/dbus-1/system.conf. Putting it in any other +configuration file would probably be nonsense. + + + + <servicehelper/> + + + + +<servicehelper/> specifies the setuid helper that is used to launch +system daemons with an alternate user. Typically this should be +the dbus-daemon-launch-helper executable in located in libexec. + + +The <servicehelper/> option is only relevant to the per-system bus daemon +defined in @EXPANDED_SYSCONFDIR@/dbus-1/system.conf. Putting it in any other +configuration file would probably be nonsense. + + + + <limit> + + + <limit> establishes a resource limit. For example: @@ -392,31 +474,36 @@ Available limit names are: "max_incoming_bytes" : total size in bytes of messages incoming from a single connection + "max_incoming_unix_fds" : total number of unix fds of messages + incoming from a single connection "max_outgoing_bytes" : total size in bytes of messages queued up for a single connection + "max_outgoing_unix_fds" : total number of unix fds of messages + queued up for a single connection "max_message_size" : max size of a single message in bytes - "service_start_timeout" : milliseconds (thousandths) until + "max_message_unix_fds" : max unix fds of a single message + "service_start_timeout" : milliseconds (thousandths) until a started service has to connect "auth_timeout" : milliseconds (thousandths) a connection is given to authenticate - "max_completed_connections" : max number of authenticated connections + "max_completed_connections" : max number of authenticated connections "max_incomplete_connections" : max number of unauthenticated connections "max_connections_per_user" : max number of completed connections from the same user "max_pending_service_starts" : max number of service launches in progress at the same time - "max_names_per_connection" : max number of names a single + "max_names_per_connection" : max number of names a single connection can own - "max_match_rules_per_connection": max number of match rules for a single + "max_match_rules_per_connection": max number of match rules for a single connection - "max_replies_per_connection" : max number of pending method + "max_replies_per_connection" : max number of pending method replies per connection (number of calls-in-progress) - "reply_timeout" : milliseconds (thousandths) - until a method call times out + "reply_timeout" : milliseconds (thousandths) + until a method call times out @@ -430,49 +517,60 @@ number of users that can work together to denial-of-service all other users by u up all connections on the systemwide bus. -Limits are normally only of interest on the systemwide bus, not the user session +Limits are normally only of interest on the systemwide bus, not the user session buses. - - - <policy> - + - - - - + <policy> + + + The <policy> element defines a security policy to be applied to a particular set of connections to the bus. A policy is made up of <allow> and <deny> elements. Policies are normally used with the systemwide bus; -they are analogous to a firewall in that they allow expected traffic +they are analogous to a firewall in that they allow expected traffic and prevent unexpected traffic. -The <policy> element has one of three attributes: +Currently, the system bus has a default-deny policy for sending method calls +and owning bus names. Everything else, in particular reply messages, receive +checks, and signals has a default allow policy. + + +In general, it is best to keep system services as small, targeted programs which +run in their own process and provide a single bus name. Then, all that is needed +is an <allow> rule for the "own" permission to let the process claim the bus +name, and a "send_destination" rule to allow traffic from some or all uids to +your service. + + +The <policy> element has one of four attributes: context="(default|mandatory)" + at_console="(true|false)" user="username or userid" group="group name or gid" - -Policies are applied to a connection as follows: +Policies are applied to a connection as follows: - all context="default" policies are applied - all group="connection's user's group" policies are applied in undefined order - all user="connection's auth user" policies are applied in undefined order + - all at_console="true" policies are applied + - all at_console="false" policies are applied - all context="mandatory" policies are applied -Policies applied later will override those applied earlier, -when the policies overlap. Multiple policies with the same -user/group/context are applied in the order they appear +Policies applied later will override those applied earlier, +when the policies overlap. Multiple policies with the same +user/group/context are applied in the order they appear in the config file. @@ -493,16 +591,16 @@ statements, and works just like <deny> but with the inverse meaning.The possible attributes of these elements are: send_interface="interface_name" - send_member="method_or_signal_name" - send_error="error_name" - send_destination="name" - send_type="method_call" | "method_return" | "signal" | "error" + send_member="method_or_signal_name" + send_error="error_name" + send_destination="name" + send_type="method_call" | "method_return" | "signal" | "error" send_path="/path/name" receive_interface="interface_name" - receive_member="method_or_signal_name" - receive_error="error_name" - receive_sender="name" + receive_member="method_or_signal_name" + receive_error="error_name" + receive_sender="name" receive_type="method_call" | "method_return" | "signal" | "error" receive_path="/path/name" @@ -520,9 +618,7 @@ statements, and works just like <deny> but with the inverse meaning.Examples: - <deny send_interface="org.freedesktop.System" send_member="Reboot"/> - <deny receive_interface="org.freedesktop.System" receive_member="Reboot"/> - <deny own="org.freedesktop.System"/> + <deny send_destination="org.freedesktop.Service" send_interface="org.freedesktop.System" send_member="Reboot"/> <deny send_destination="org.freedesktop.System"/> <deny receive_sender="org.freedesktop.System"/> <deny user="john"/> @@ -534,34 +630,29 @@ statements, and works just like <deny> but with the inverse meaning. - send_destination and receive_sender rules mean that messages may not be sent to or received from the *owner* of the given name, not that they may not be sent *to that name*. That is, if a connection owns services A, B, C, and sending to A is denied, sending to B or C will not work either. - The other send_* and receive_* attributes are purely textual/by-value matches against the given field in the message header. - "Eavesdropping" occurs when an application receives a message that -was explicitly addressed to a name the application does not own. -Eavesdropping thus only applies to messages that are addressed to -services (i.e. it does not apply to signals). +was explicitly addressed to a name the application does not own, or +is a reply to such a message. Eavesdropping thus only applies to +messages that are addressed to services and replies to such messages +(i.e. it does not apply to signals). - -For <allow>, eavesdrop="true" indicates that the rule matches even -when eavesdropping. eavesdrop="false" is the default and means that +For <allow>, eavesdrop="true" indicates that the rule matches even +when eavesdropping. eavesdrop="false" is the default and means that the rule only allows messages to go to their specified recipient. -For <deny>, eavesdrop="true" indicates that the rule matches +For <deny>, eavesdrop="true" indicates that the rule matches only when eavesdropping. eavesdrop="false" is the default for <deny> -also, but here it means that the rule applies always, even when +also, but here it means that the rule applies always, even when not eavesdropping. The eavesdrop attribute can only be combined with -receive rules (with receive_* attributes). - - +send and receive rules (with send_* and receive_* attributes). The [send|receive]_requested_reply attribute works similarly to the eavesdrop attribute. It controls whether the <deny> or <allow> matches a reply @@ -582,7 +673,7 @@ requested. [send|receive]_requested_reply="true" indicates that the rule applies always, regardless of pending reply state. -user and group denials mean that the given user or group may +user and group denials mean that the given user or group may not connect to the message bus. @@ -591,6 +682,7 @@ the character "*" can be substituted, meaning "any." Complex globs like "foo.bar.*" aren't allowed for now because they'd be work to implement and maybe encourage sloppy security anyway. + <allow own_prefix="a.b"/> allows you to own the name "a.b" or any name whose first dot-separated elements are "a.b": in particular, you can own "a.b.c" or "a.b.c.d", but not "a.bc" or "a.c". @@ -599,6 +691,7 @@ define a meaning for subtrees of well-known names, such as org.freedesktop.Telepathy.ConnectionManager.(anything) and org.freedesktop.ReserveDevice1.(anything). + It does not make sense to deny a user or group inside a <policy> for a user or group; user/group denials can only be inside context="default" or context="mandatory" policies. @@ -617,42 +710,40 @@ rule, since "whether the message can be sent" and "whether it can be received" are evaluated separately. -Be careful with send_interface/receive_interface, because the -interface field in messages is optional. +Be careful with send_interface/receive_interface, because the +interface field in messages is optional. In particular, do NOT +specify <deny send_interface="org.foo.Bar"/>! This will cause +no-interface messages to be blocked for all services, which is +almost certainly not what you intended. Always use rules of +the form: <deny send_interface="org.foo.Bar" send_destination="org.foo.Service"/> - - - <selinux> - + - - - - + <selinux> + + + The <selinux> element contains settings related to Security Enhanced Linux. More details below. - - - <associate> - + - - - - + <associate> + + + An <associate> element appears below an <selinux> element and creates a mapping. Right now only one kind of association is possible: - <associate own="org.freedesktop.Foobar" context="foo_t"/> + <associate own="org.freedesktop.Foobar" context="foo_t"/> This means that if a connection asks to own the name "org.freedesktop.Foobar" then the source context will be the context -of the connection and the target context will be "foo_t" - see the +of the connection and the target context will be "foo_t" - see the short discussion of SELinux below. @@ -663,7 +754,7 @@ NOT the context of the connection owning the name. There's currently no way to set a default for owning any name, if we add this syntax it will look like: - <associate own="*" context="foo_t"/> + <associate own="*" context="foo_t"/> If you find a reason this is useful, let the developers know. Right now the default will be the security context of the bus itself. @@ -715,30 +806,75 @@ the first connection as source, security context of the second connection as target, object class "dbus" and requested permission "send_msg". -If a security context is not available for a connection -(impossible when using UNIX domain sockets), then the target +If a security context is not available for a connection +(impossible when using UNIX domain sockets), then the target context used is the context of the bus daemon itself. -There is currently no way to change this default, because we're -assuming that only UNIX domain sockets will be used to -connect to the systemwide bus. If this changes, we'll +There is currently no way to change this default, because we're +assuming that only UNIX domain sockets will be used to +connect to the systemwide bus. If this changes, we'll probably add a way to set the default connection context. -Second, any time a connection asks to own a name, -the bus daemon will check permissions with the security +Second, any time a connection asks to own a name, +the bus daemon will check permissions with the security context of the connection as source, the security context specified -for the name in the config file as target, object +for the name in the config file as target, object class "dbus" and requested permission "acquire_svc". -The security context for a bus name is specified with the +The security context for a bus name is specified with the <associate> element described earlier in this document. -If a name has no security context associated in the -configuration file, the security context of the bus daemon +If a name has no security context associated in the +configuration file, the security context of the bus daemon itself will be used. +DEBUGGING +If you're trying to figure out where your messages are going or why +you aren't getting messages, there are several things you can try. + +Remember that the system bus is heavily locked down and if you +haven't installed a security policy file to allow your message +through, it won't work. For the session bus, this is not a concern. + +The simplest way to figure out what's happening on the bus is to run +the dbus-monitor program, which comes with the D-Bus +package. You can also send test messages with dbus-send. These +programs have their own man pages. + +If you want to know what the daemon itself is doing, you might consider +running a separate copy of the daemon to test against. This will allow you +to put the daemon under a debugger, or run it with verbose output, without +messing up your real session and system daemons. + +To run a separate test copy of the daemon, for example you might open a terminal +and type: + + DBUS_VERBOSE=1 dbus-daemon --session --print-address + + +The test daemon address will be printed when the daemon starts. You will need +to copy-and-paste this address and use it as the value of the +DBUS_SESSION_BUS_ADDRESS environment variable when you launch the applications +you want to test. This will cause those applications to connect to your +test bus instead of the DBUS_SESSION_BUS_ADDRESS of your real session bus. + +DBUS_VERBOSE=1 will have NO EFFECT unless your copy of D-Bus +was compiled with verbose mode enabled. This is not recommended in +production builds due to performance impact. You may need to rebuild +D-Bus if your copy was not built with debugging in mind. (DBUS_VERBOSE +also affects the D-Bus library and thus applications using D-Bus; it may +be useful to see verbose output on both the client side and from the daemon.) + +If you want to get fancy, you can create a custom bus +configuration for your test bus (see the session.conf and system.conf +files that define the two default configurations for example). This +would allow you to specify a different directory for .service files, +for example. + + + AUTHOR See http://www.freedesktop.org/software/dbus/doc/AUTHORS diff --git a/doc/dbus-launch.1.xml b/doc/dbus-launch.1.xml index dc34898..ab4d5ed 100644 --- a/doc/dbus-launch.1.xml +++ b/doc/dbus-launch.1.xml @@ -1,17 +1,17 @@ - + - - - + + dbus-launch 1 - + dbus-launch Utility to start a message bus from a shell script @@ -41,7 +41,7 @@ backticks or the $() construct can be used to read information from dbus-launch. With no arguments, dbus-launch will launch a session bus -instance and print the address and pid of that instance to standard +instance and print the address and PID of that instance to standard output. You may specify a program to be run; in this case, dbus-launch @@ -64,7 +64,7 @@ to set up the environment. of the SHELL environment variable to determine which shell syntax should be used. If SHELL ends in "csh", then csh-compatible code is emitted; otherwise Bourne shell code is emitted. Instead of passing ---auto-syntax, you may explicity specify a particular one by using +--auto-syntax, you may explicitly specify a particular one by using --sh-syntax for Bourne syntax, or --csh-syntax for csh syntax. In scripts, it's more robust to avoid --auto-syntax and you hopefully know which shell your script is written in. @@ -73,30 +73,46 @@ know which shell your script is written in. See http://www.freedesktop.org/software/dbus/ for more information about D-Bus. See also the man page for dbus-daemon. + -Here is an example of how to use dbus-launch with an -sh-compatible shell to start the per-session bus daemon: - +EXAMPLES +Distributions running +dbus-launch +as part of a standard X session should run +dbus-launch --exit-with-session +after the X server has started and become available, as a wrapper around +the "main" X client (typically a session manager or window manager), as in +these examples: - ## test for an existing bus daemon, just to be safe - if test -z "$DBUS_SESSION_BUS_ADDRESS" ; then - ## if not found, launch a new one - eval `dbus-launch --sh-syntax --exit-with-session` - echo "D-Bus per-session daemon address is: $DBUS_SESSION_BUS_ADDRESS" - fi +

+dbus-launch --exit-with-session gnome-session - -You might run something like that in your login scripts. +dbus-launch --exit-with-session openbox +dbus-launch --exit-with-session ~/.xsession +

-Another way to use dbus-launch is to run your main session -program, like so: - +If your distribution does not do this, you can achieve similar results +by running your session or window manager in the same way in a script +run by your X session, such as +~/.xsession, +~/.xinitrc +or +~/.Xclients. -dbus-launch gnome-session +To start a D-Bus session within a text-mode session, you can run +dbus-launch in the background. For instance, in a sh-compatible shell: + + ## test for an existing bus daemon, just to be safe + if test -z "$DBUS_SESSION_BUS_ADDRESS" ; then + ## if not found, launch a new one + eval `dbus-launch --sh-syntax` + echo "D-Bus per-session daemon address is: $DBUS_SESSION_BUS_ADDRESS" + fi -The above would likely be appropriate for ~/.xsession or ~/.Xclients. +Note that in this case, dbus-launch will exit, and dbus-daemon will not be +terminated automatically on logout. @@ -227,6 +243,20 @@ use it manually. It may change in the future. +NOTES +If you run +dbus-launch myapp +(with any other options), dbus-daemon will +not +exit when +myapp +terminates: this is because +myapp +is assumed to be part of a larger session, rather than a session in its +own right. + + + AUTHOR See http://www.freedesktop.org/software/dbus/doc/AUTHORS diff --git a/doc/dbus-monitor.1.xml b/doc/dbus-monitor.1.xml index b41cace..20e9301 100644 --- a/doc/dbus-monitor.1.xml +++ b/doc/dbus-monitor.1.xml @@ -1,17 +1,17 @@ - + - - - + + dbus-monitor 1 - + dbus-monitor debug probe to print message bus messages diff --git a/doc/dbus-send.1.xml b/doc/dbus-send.1.xml index 7fefc03..30d57c5 100644 --- a/doc/dbus-send.1.xml +++ b/doc/dbus-send.1.xml @@ -1,17 +1,17 @@ - + - - - + + dbus-send 1 - + dbus-send Send a message to a message bus @@ -21,14 +21,12 @@ dbus-send --system --session --dest=NAME - --print-reply + --print-reply =literal + --reply-timeout=MSEC --type=TYPE - <destination - object - path> - <message - name> - contents + OBJECT_PATH + INTERFACE.MEMBER + CONTENTS @@ -43,14 +41,14 @@ information about the big picture. 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). -The --system and --session options direct dbus-send to send -messages to the system or session buses respectively. If neither is -specified, dbus-send sends to the session bus. +The and options direct +dbus-send to send messages to the system or session buses respectively. +If neither is specified, dbus-send sends to the session bus. -Nearly all uses of dbus-send must provide the --dest argument +Nearly all uses of dbus-send must provide the argument which is the name of a connection on the bus to send the message to. If ---dest is omitted, no destination is set. + is omitted, no destination is set. The object path and the name of the message to send must always be @@ -76,13 +74,13 @@ or nested containers (e.g. arrays of variants). Here is an example invocation: - dbus-send --dest=org.freedesktop.ExampleName \ - /org/freedesktop/sample/object/name \ - org.freedesktop.ExampleInterface.ExampleMethod \ - int32:47 string:'hello world' double:65.32 \ - array:string:"1st item","next item","last item" \ - dict:string:int32:"one",1,"two",2,"three",3 \ - variant:int32:-8 \ + dbus-send --dest=org.freedesktop.ExampleName \ + /org/freedesktop/sample/object/name \ + org.freedesktop.ExampleInterface.ExampleMethod \ + int32:47 string:'hello world' double:65.32 \ + array:string:"1st item","next item","last item" \ + dict:string:int32:"one",1,"two",2,"three",3 \ + variant:int32:-8 \ objpath:/org/freedesktop/sample/object/name @@ -97,7 +95,7 @@ and the interface member are separate fields. The following options are supported: - + NAME Specify the name of the connection to receive the message. @@ -105,7 +103,23 @@ and the interface member are separate fields. -Block for a reply to the message sent, and print any reply received. +Block for a reply to the message sent, and print any reply received +in a human-readable form. + + + + + +Block for a reply to the message sent, and print the body of the +reply. If the reply is an object path or a string, it is printed +literally, with no punctuation, escape characters etc. + + + + MSEC + +Wait for a reply for up to MSEC milliseconds. +The default is implementation‐defined, typically 25 seconds. @@ -121,9 +135,9 @@ and the interface member are separate fields. - + TYPE -Specify "method_call" or "signal" (defaults to "signal"). +Specify method_call or signal (defaults to "signal"). diff --git a/doc/dbus-uuidgen.1.xml b/doc/dbus-uuidgen.1.xml new file mode 100644 index 0000000..3d99ef8 --- /dev/null +++ b/doc/dbus-uuidgen.1.xml @@ -0,0 +1,125 @@ + + + + + + + + +dbus-uuidgen +1 + + +dbus-uuidgen +Utility to generate UUIDs + + + + + dbus-uuidgen --version + --ensure =FILENAME + --get =FILENAME + + + + + +DESCRIPTION +The dbus-uuidgen command generates or reads a universally unique ID. + + +Note that the D-Bus UUID has no relationship to RFC 4122 and does not generate +UUIDs compatible with that spec. Many systems have a separate command +for that (often called "uuidgen"). + + +See http://www.freedesktop.org/software/dbus/ for more information +about D-Bus. + + +The primary usage of dbus-uuidgen is to run in the post-install +script of a D-Bus package like this: + + dbus-uuidgen --ensure + + + +This will ensure that /var/lib/dbus/machine-id exists and has the uuid in it. +It won't overwrite an existing uuid, since this id should remain fixed +for a single machine until the next reboot at least. + + +The important properties of the machine UUID are that 1) it remains +unchanged until the next reboot and 2) it is different for any two +running instances of the OS kernel. That is, if two processes see the +same UUID, they should also see the same shared memory, UNIX domain +sockets, local X displays, localhost.localdomain resolution, process +IDs, and so forth. + + +If you run dbus-uuidgen with no options it just prints a new uuid made +up out of thin air. + + +If you run it with --get, it prints the machine UUID by default, or +the UUID in the specified file if you specify a file. + + +If you try to change an existing machine-id on a running system, it will +probably result in bad things happening. Don't try to change this file. Also, +don't make it the same on two different systems; it needs to be different +anytime there are two different kernels running. + + +The UUID should be different on two different virtual machines, +because there are two different kernels. + + + +OPTIONS +The following options are supported: + + + + +If a filename is not given, defaults to localstatedir/lib/dbus/machine-id +(localstatedir is usually /var). If this file exists and is valid, the +uuid in the file is printed on stdout. Otherwise, the command exits +with a nonzero status. + + + + + + +If a filename is not given, defaults to localstatedir/lib/dbus/machine-id +(localstatedir is usually /var). If this file exists then it will be +validated, and a failure code returned if it contains the wrong thing. +If the file does not exist, it will be created with a new uuid in it. +On success, prints no output. + + + + + + +Print the version of dbus-uuidgen + + + + + + +AUTHOR +See http://www.freedesktop.org/software/dbus/doc/AUTHORS + + + +BUGS +Please send bug reports to the D-Bus mailing list or bug tracker, +see http://www.freedesktop.org/software/dbus/ + + + -- 1.7.10.4