mirror of
https://gitlab.freedesktop.org/dbus/dbus.git
synced 2026-01-04 16:40:16 +01:00
added some docs for windows and updated the documentation index
This commit is contained in:
Ralf Habacker
parent
a931e61763
commit
0793857c92
6 changed files with 1307 additions and 5 deletions
744
cmake/bus/dbus-daemon.xml
Normal file
744
cmake/bus/dbus-daemon.xml
Normal file
|
|
@ -0,0 +1,744 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
<!-- lifted from troff+man by doclifter -->
|
||||
<refentry id='dbus-daemon'>
|
||||
<!-- -->
|
||||
<!-- dbus\-daemon manual page. -->
|
||||
<!-- Copyright (C) 2003 Red Hat, Inc. -->
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>dbus-daemon</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</refmeta>
|
||||
<refnamediv id='name'>
|
||||
<refname>dbus-daemon</refname>
|
||||
<refpurpose>Message bus daemon</refpurpose>
|
||||
</refnamediv>
|
||||
<!-- body begins here -->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<cmdsynopsis>
|
||||
<command>dbus-daemon</command></cmdsynopsis>
|
||||
<cmdsynopsis>
|
||||
<command>dbus-daemon</command> <arg choice='opt'>--version </arg>
|
||||
<arg choice='opt'>--session </arg>
|
||||
<arg choice='opt'>--system </arg>
|
||||
<arg choice='opt'>--config-file=<replaceable>FILE</replaceable></arg>
|
||||
<arg choice='opt'><arg choice='plain'>--print-address </arg><arg choice='opt'><replaceable>=DESCRIPTOR</replaceable></arg></arg>
|
||||
<arg choice='opt'><arg choice='plain'>--print-pid </arg><arg choice='opt'><replaceable>=DESCRIPTOR</replaceable></arg></arg>
|
||||
<arg choice='opt'>--fork </arg>
|
||||
<sbr/>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
<refsect1 id='description'><title>DESCRIPTION</title>
|
||||
<para><command>dbus-daemon</command> is the D-Bus message bus daemon. See
|
||||
<ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink> for more information about
|
||||
the big picture. D-Bus is first a library that provides one-to-one
|
||||
communication between any two applications; <command>dbus-daemon</command> is an
|
||||
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.</para>
|
||||
|
||||
|
||||
<para>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).
|
||||
<command>dbus-daemon</command> is used for both of these instances, but with
|
||||
a different configuration file.</para>
|
||||
|
||||
|
||||
<para>The --session option is equivalent to
|
||||
"--config-file=/etc/dbus-1/session.conf" and the --system
|
||||
option is equivalent to
|
||||
"--config-file=/etc/dbus-1/system.conf". By creating
|
||||
additional configuration files and using the --config-file option,
|
||||
additional special-purpose message bus daemons could be created.</para>
|
||||
|
||||
|
||||
<para>The systemwide daemon is normally launched by an init script,
|
||||
standardly called simply "messagebus".</para>
|
||||
|
||||
|
||||
<para>The systemwide daemon is largely used for broadcasting system events,
|
||||
such as changes to the printer queue, or adding/removing devices.</para>
|
||||
|
||||
|
||||
<para>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).</para>
|
||||
|
||||
|
||||
<para>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
|
||||
only take effect if you restart the daemon. Policy changes should take effect
|
||||
with SIGHUP.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='options'><title>OPTIONS</title>
|
||||
<para>The following options are supported:</para>
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><option>--config-file=FILE</option></term>
|
||||
<listitem>
|
||||
<para>Use the given configuration file.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--fork</option></term>
|
||||
<listitem>
|
||||
<para>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.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--print-address[=DESCRIPTOR]</option></term>
|
||||
<listitem>
|
||||
<para>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.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--print-pid[=DESCRIPTOR]</option></term>
|
||||
<listitem>
|
||||
<para>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.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--session</option></term>
|
||||
<listitem>
|
||||
<para>Use the standard configuration file for the per-login-session message
|
||||
bus.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--system</option></term>
|
||||
<listitem>
|
||||
<para>Use the standard configuration file for the systemwide message bus.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--version</option></term>
|
||||
<listitem>
|
||||
<para>Print the version of the daemon.</para>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='configuration_file'><title>CONFIGURATION FILE</title>
|
||||
<para>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,
|
||||
while another might set it up to be a per-user-login-session bus.</para>
|
||||
|
||||
|
||||
<para>The configuration file also establishes resource limits, security
|
||||
parameters, and so forth.</para>
|
||||
|
||||
|
||||
<para>The configuration file is not part of any interoperability
|
||||
specification and its backward compatibility is not guaranteed; this
|
||||
document is documentation, not specification.</para>
|
||||
|
||||
|
||||
<para>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
|
||||
<include> a system-local.conf or session-local.conf; you can put local
|
||||
overrides in those files to avoid modifying the primary configuration
|
||||
files.</para>
|
||||
|
||||
|
||||
<para>The configuration file is an XML document. It must have the following
|
||||
doctype declaration:</para>
|
||||
<literallayout remap='.nf'>
|
||||
|
||||
<!DOCTYPE busconfig PUBLIC "-//freedesktop//DTD D-Bus Bus Configuration 1.0//EN"
|
||||
"<ulink url='http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd'>http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd</ulink>">
|
||||
|
||||
</literallayout> <!-- .fi -->
|
||||
|
||||
|
||||
<para>The following elements may be present in the configuration file.</para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><busconfig></emphasis></term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>Root element.</para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><type></emphasis></term>
|
||||
<listitem>
|
||||
|
||||
<para></para> <!-- FIXME: blank list item -->
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>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).</para>
|
||||
|
||||
|
||||
<para>Example: <type>session</type></para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><include></emphasis></term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>Include a file <include>filename.conf</include> at this point. If the
|
||||
filename is relative, it is located relative to the configuration file
|
||||
doing the including.</para>
|
||||
|
||||
|
||||
<para><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
|
||||
to be absent.</para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><includedir></emphasis></term>
|
||||
<listitem>
|
||||
|
||||
<para></para> <!-- FIXME: blank list item -->
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>Include all files in <includedir>foo.d</includedir> at this
|
||||
point. Files in the directory are included in undefined order.
|
||||
Only files ending in ".conf" are included.</para>
|
||||
|
||||
|
||||
<para>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
|
||||
this message and allowed the printer daemon user to send it.</para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><user></emphasis></term>
|
||||
<listitem>
|
||||
|
||||
<para></para> <!-- FIXME: blank list item -->
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>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.
|
||||
If this element is not present, the daemon will not change or care
|
||||
about its UID.</para>
|
||||
|
||||
|
||||
<para>The last <user> entry in the file "wins", the others are ignored.</para>
|
||||
|
||||
|
||||
<para>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
|
||||
privileges for writing.</para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><fork></emphasis></term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>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.</para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><listen></emphasis></term>
|
||||
<listitem>
|
||||
|
||||
<para></para> <!-- FIXME: blank list item -->
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>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.</para>
|
||||
|
||||
|
||||
<para>Example: <listen>unix:path=/tmp/foo</listen></para>
|
||||
|
||||
|
||||
<para>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.</para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><auth></emphasis></term>
|
||||
<listitem>
|
||||
|
||||
<para></para> <!-- FIXME: blank list item -->
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>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.</para>
|
||||
|
||||
|
||||
<para>Example: <auth>EXTERNAL</auth></para>
|
||||
|
||||
|
||||
<para>Example: <auth>DBUS_COOKIE_SHA1</auth></para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><servicedir></emphasis></term>
|
||||
<listitem>
|
||||
|
||||
<para></para> <!-- FIXME: blank list item -->
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>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
|
||||
service will be used).</para>
|
||||
|
||||
|
||||
<para>Service files tell the bus how to automatically start a program.
|
||||
They are primarily used with the per-user-session bus,
|
||||
not the systemwide bus.</para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><standard_session_servicedirs/></emphasis></term>
|
||||
<listitem>
|
||||
|
||||
<para></para> <!-- FIXME: blank list item -->
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para><standard_session_servicedirs/> is equivalent to specifying a series
|
||||
of <servicedir/> elements for each of the data directories in the "XDG
|
||||
Base Directory Specification" with the subdirectory "dbus-1/services",
|
||||
so for example "/usr/share/dbus-1/services" would be among the
|
||||
directories searched.</para>
|
||||
|
||||
|
||||
<para>The "XDG Base Directory Specification" can be found at
|
||||
<ulink url='http://freedesktop.org/wiki/Standards/basedir-spec'>http://freedesktop.org/wiki/Standards/basedir-spec</ulink> if it hasn't moved,
|
||||
otherwise try your favorite search engine.</para>
|
||||
|
||||
|
||||
<para>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
|
||||
configuration file would probably be nonsense.</para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><limit></emphasis></term>
|
||||
<listitem>
|
||||
|
||||
<para></para> <!-- FIXME: blank list item -->
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para><limit> establishes a resource limit. For example:</para>
|
||||
<literallayout remap='.nf'>
|
||||
<limit name="max_message_size">64</limit>
|
||||
<limit name="max_completed_connections">512</limit>
|
||||
</literallayout> <!-- .fi -->
|
||||
|
||||
|
||||
<para>The name attribute is mandatory.
|
||||
Available limit names are:</para>
|
||||
<literallayout remap='.nf'>
|
||||
"max_incoming_bytes" : total size in bytes of messages
|
||||
incoming from a single connection
|
||||
"max_outgoing_bytes" : total size in bytes 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
|
||||
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_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
|
||||
connection can own
|
||||
"max_match_rules_per_connection": max number of match rules for a single
|
||||
connection
|
||||
"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
|
||||
</literallayout> <!-- .fi -->
|
||||
|
||||
|
||||
<para>The max incoming/outgoing queue sizes allow a new message to be queued
|
||||
if one byte remains below the max. So you can in fact exceed the max
|
||||
by max_message_size.</para>
|
||||
|
||||
|
||||
<para>max_completed_connections divided by max_connections_per_user is the
|
||||
number of users that can work together to denial-of-service all other users by using
|
||||
up all connections on the systemwide bus.</para>
|
||||
|
||||
|
||||
<para>Limits are normally only of interest on the systemwide bus, not the user session
|
||||
buses.</para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><policy></emphasis></term>
|
||||
<listitem>
|
||||
|
||||
<para></para> <!-- FIXME: blank list item -->
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>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
|
||||
and prevent unexpected traffic.</para>
|
||||
|
||||
|
||||
<para>The <policy> element has one of three attributes:</para>
|
||||
<literallayout remap='.nf'>
|
||||
context="(default|mandatory)"
|
||||
user="username or userid"
|
||||
group="group name or gid"
|
||||
</literallayout> <!-- .fi -->
|
||||
|
||||
|
||||
<para>
|
||||
Policies are applied to a connection as follows:</para>
|
||||
<literallayout remap='.nf'>
|
||||
- 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 context="mandatory" policies are applied
|
||||
</literallayout> <!-- .fi -->
|
||||
|
||||
|
||||
<para>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.</para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><deny></emphasis></term>
|
||||
<listitem>
|
||||
<para><emphasis remap='I'><allow></emphasis></para>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>A <deny> element appears below a <policy> element and prohibits some
|
||||
action. The <allow> element makes an exception to previous <deny>
|
||||
statements, and works just like <deny> but with the inverse meaning.</para>
|
||||
|
||||
|
||||
<para>The possible attributes of these elements are:</para>
|
||||
<literallayout remap='.nf'>
|
||||
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_path="/path/name"
|
||||
|
||||
receive_interface="interface_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"
|
||||
|
||||
send_requested_reply="true" | "false"
|
||||
receive_requested_reply="true" | "false"
|
||||
|
||||
eavesdrop="true" | "false"
|
||||
|
||||
own="name"
|
||||
user="username"
|
||||
group="groupname"
|
||||
</literallayout> <!-- .fi -->
|
||||
|
||||
|
||||
<para>Examples:</para>
|
||||
<literallayout remap='.nf'>
|
||||
<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.System"/>
|
||||
<deny receive_sender="org.freedesktop.System"/>
|
||||
<deny user="john"/>
|
||||
<deny group="enemies"/>
|
||||
</literallayout> <!-- .fi -->
|
||||
|
||||
|
||||
<para>The <deny> element's attributes determine whether the deny "matches" a
|
||||
particular action. If it matches, the action is denied (unless later
|
||||
rules in the config file allow it).</para>
|
||||
|
||||
|
||||
<para>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.</para>
|
||||
|
||||
|
||||
<para>The other send_* and receive_* attributes are purely textual/by-value
|
||||
matches against the given field in the message header.</para>
|
||||
|
||||
|
||||
<para>"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).</para>
|
||||
|
||||
|
||||
<para>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
|
||||
only when eavesdropping. eavesdrop="false" is the default for <deny>
|
||||
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).</para>
|
||||
|
||||
|
||||
|
||||
<para>The [send|receive]_requested_reply attribute works similarly to the eavesdrop
|
||||
attribute. It controls whether the <deny> or <allow> matches a reply
|
||||
that is expected (corresponds to a previous method call message).
|
||||
This attribute only makes sense for reply messages (errors and method
|
||||
returns), and is ignored for other message types.</para>
|
||||
|
||||
|
||||
<para>For <allow>, [send|receive]_requested_reply="true" is the default and indicates that
|
||||
only requested replies are allowed by the
|
||||
rule. [send|receive]_requested_reply="false" means that the rule allows any reply
|
||||
even if unexpected.</para>
|
||||
|
||||
|
||||
<para>For <deny>, [send|receive]_requested_reply="false" is the default but indicates that
|
||||
the rule matches only when the reply was not
|
||||
requested. [send|receive]_requested_reply="true" indicates that the rule applies
|
||||
always, regardless of pending reply state.</para>
|
||||
|
||||
|
||||
<para>user and group denials mean that the given user or group may
|
||||
not connect to the message bus.</para>
|
||||
|
||||
|
||||
<para>For "name", "username", "groupname", etc.
|
||||
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.</para>
|
||||
|
||||
|
||||
<para>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.</para>
|
||||
|
||||
|
||||
<para>A single <deny> rule may specify combinations of attributes such as
|
||||
send_destination and send_interface and send_type. In this case, the
|
||||
denial applies only if both attributes match the message being denied.
|
||||
e.g. <deny send_interface="foo.bar" send_destination="foo.blah"/> would
|
||||
deny messages with the given interface AND the given bus name.
|
||||
To get an OR effect you specify multiple <deny> rules.</para>
|
||||
|
||||
|
||||
<para>You can't include both send_ and receive_ attributes on the same
|
||||
rule, since "whether the message can be sent" and "whether it can be
|
||||
received" are evaluated separately.</para>
|
||||
|
||||
|
||||
<para>Be careful with send_interface/receive_interface, because the
|
||||
interface field in messages is optional.</para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><selinux></emphasis></term>
|
||||
<listitem>
|
||||
|
||||
<para></para> <!-- FIXME: blank list item -->
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>The <selinux> element contains settings related to Security Enhanced Linux.
|
||||
More details below.</para>
|
||||
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><emphasis remap='I'><associate></emphasis></term>
|
||||
<listitem>
|
||||
|
||||
<para></para> <!-- FIXME: blank list item -->
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>An <associate> element appears below an <selinux> element and
|
||||
creates a mapping. Right now only one kind of association is possible:</para>
|
||||
<literallayout remap='.nf'>
|
||||
<associate own="org.freedesktop.Foobar" context="foo_t"/>
|
||||
</literallayout> <!-- .fi -->
|
||||
|
||||
|
||||
<para>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
|
||||
short discussion of SELinux below.</para>
|
||||
|
||||
|
||||
<para>Note, the context here is the target context when requesting a name,
|
||||
NOT the context of the connection owning the name.</para>
|
||||
|
||||
|
||||
<para>There's currently no way to set a default for owning any name, if
|
||||
we add this syntax it will look like:</para>
|
||||
<literallayout remap='.nf'>
|
||||
<associate own="*" context="foo_t"/>
|
||||
</literallayout> <!-- .fi -->
|
||||
<para>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.</para>
|
||||
|
||||
|
||||
<para>If two <associate> elements specify the same name, the element
|
||||
appearing later in the configuration file will be used.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='selinux'><title>SELinux</title>
|
||||
<para>See <ulink url='http://www.nsa.gov/selinux/'>http://www.nsa.gov/selinux/</ulink> for full details on SELinux. Some useful excerpts:</para>
|
||||
|
||||
|
||||
<para>Every subject (process) and object (e.g. file, socket, IPC object,
|
||||
etc) in the system is assigned a collection of security attributes,
|
||||
known as a security context. A security context contains all of the
|
||||
security attributes associated with a particular subject or object
|
||||
that are relevant to the security policy.</para>
|
||||
|
||||
|
||||
<para>In order to better encapsulate security contexts and to provide
|
||||
greater efficiency, the policy enforcement code of SELinux typically
|
||||
handles security identifiers (SIDs) rather than security contexts. A
|
||||
SID is an integer that is mapped by the security server to a security
|
||||
context at runtime.</para>
|
||||
|
||||
|
||||
<para>When a security decision is required, the policy enforcement code
|
||||
passes a pair of SIDs (typically the SID of a subject and the SID of
|
||||
an object, but sometimes a pair of subject SIDs or a pair of object
|
||||
SIDs), and an object security class to the security server. The object
|
||||
security class indicates the kind of object, e.g. a process, a regular
|
||||
file, a directory, a TCP socket, etc.</para>
|
||||
|
||||
|
||||
<para>Access decisions specify whether or not a permission is granted for a
|
||||
given pair of SIDs and class. Each object class has a set of
|
||||
associated permissions defined to control operations on objects with
|
||||
that class.</para>
|
||||
|
||||
|
||||
<para>D-Bus performs SELinux security checks in two places.</para>
|
||||
|
||||
|
||||
<para>First, any time a message is routed from one connection to another
|
||||
connection, the bus daemon will check permissions with the security context of
|
||||
the first connection as source, security context of the second connection
|
||||
as target, object class "dbus" and requested permission "send_msg".</para>
|
||||
|
||||
|
||||
<para>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
|
||||
probably add a way to set the default connection context.</para>
|
||||
|
||||
|
||||
<para>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
|
||||
class "dbus" and requested permission "acquire_svc".</para>
|
||||
|
||||
|
||||
<para>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
|
||||
itself will be used.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='author'><title>AUTHOR</title>
|
||||
<para>See <ulink url='http://www.freedesktop.org/software/dbus/doc/AUTHORS'>http://www.freedesktop.org/software/dbus/doc/AUTHORS</ulink></para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='bugs'><title>BUGS</title>
|
||||
<para>Please send bug reports to the D-Bus mailing list or bug tracker,
|
||||
see <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink></para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
@ -92,11 +92,10 @@ DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-test-plan.xml html-nochunks)
|
|||
DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-tutorial.xml html-nochunks)
|
||||
DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-specification.xml html-nochunks)
|
||||
DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-faq.xml html-nochunks)
|
||||
# optional: we do not like to have troff installed on windows too and therefore need files converted from troff to docbook by doclifter
|
||||
DOCBOOK(${CMAKE_SOURCE_DIR}/../bus/dbus-daemon.xml html-nochunks)
|
||||
DOCBOOK(${CMAKE_SOURCE_DIR}/../tools/dbus-monitor.xml html-nochunks)
|
||||
DOCBOOK(${CMAKE_SOURCE_DIR}/../tools/dbus-send.xml html-nochunks)
|
||||
DOCBOOK(${CMAKE_SOURCE_DIR}/../tools/dbus-launch.xml html-nochunks)
|
||||
DOCBOOK(${CMAKE_SOURCE_DIR}/bus/dbus-daemon.xml html-nochunks)
|
||||
DOCBOOK(${CMAKE_SOURCE_DIR}/tools/dbus-monitor.xml html-nochunks)
|
||||
DOCBOOK(${CMAKE_SOURCE_DIR}/tools/dbus-send.xml html-nochunks)
|
||||
DOCBOOK(${CMAKE_SOURCE_DIR}/tools/dbus-launch.xml html-nochunks)
|
||||
|
||||
#
|
||||
# handle html index file
|
||||
|
|
|
|||
55
cmake/doc/index.html.cmake
Normal file
55
cmake/doc/index.html.cmake
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
<html>
|
||||
<head>
|
||||
<title>D-Bus Documentation Index</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1>D-Bus Documentation Index</h1>
|
||||
<p>Version @DBUS_VERSION_STRING@</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th width=10%>
|
||||
</th>
|
||||
<th width=30% align=left>
|
||||
generic documentation
|
||||
</th>
|
||||
<th width=30% align=left>
|
||||
application manuals
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign=top>
|
||||
</td>
|
||||
<td valign=top>
|
||||
<a href="http://dbus.freedesktop.org">D-Bus Website</a>
|
||||
<br>
|
||||
<br>
|
||||
<a href="dbus-tutorial.html">D-Bus Tutorial</a>
|
||||
<br>
|
||||
<br>
|
||||
<a href="dbus-specification.html">D-Bus Specification</a>
|
||||
<br>
|
||||
<br>
|
||||
<a href="dbus-faq.html">D-Bus FAQ</a>
|
||||
<br>
|
||||
<br>
|
||||
<a href="dbus-test-plan.html">D-Bus Test Plan</a>
|
||||
<br>
|
||||
<br>
|
||||
</td>
|
||||
<td valign=top>
|
||||
<a href="dbus-daemon.html">D-Bus Daemon manual</a>
|
||||
<br>
|
||||
<br>
|
||||
<a href="dbus-launch.html">D-Bus launch manual</a>
|
||||
<br>
|
||||
<br>
|
||||
<a href="dbus-send.html">D-Bus send tool manual</a>
|
||||
<br>
|
||||
<br>
|
||||
<a href="dbus-monitor.html">D-Bus monitor manual</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
240
cmake/tools/dbus-launch.xml
Normal file
240
cmake/tools/dbus-launch.xml
Normal file
|
|
@ -0,0 +1,240 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
<!-- lifted from troff+man by doclifter -->
|
||||
<refentry id='dbuslaunch1'>
|
||||
<!-- -->
|
||||
<!-- dbus\-launch manual page. -->
|
||||
<!-- Copyright (C) 2003 Red Hat, Inc. -->
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>dbus-launch</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</refmeta>
|
||||
<refnamediv id='name'>
|
||||
<refname>dbus-launch</refname>
|
||||
<refpurpose>Utility to start a message bus from a shell script</refpurpose>
|
||||
</refnamediv>
|
||||
<!-- body begins here -->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<cmdsynopsis>
|
||||
<command>dbus-launch</command> <arg choice='opt'>--version </arg>
|
||||
<arg choice='opt'>--sh-syntax </arg>
|
||||
<arg choice='opt'>--csh-syntax </arg>
|
||||
<arg choice='opt'>--auto-syntax </arg>
|
||||
<arg choice='opt'>--exit-with-session </arg>
|
||||
<arg choice='opt'>--autolaunch=<replaceable>MACHINEID</replaceable></arg>
|
||||
<arg choice='opt'>--config-file=<replaceable>FILENAME</replaceable></arg>
|
||||
<arg choice='opt'><replaceable>PROGRAM</replaceable></arg>
|
||||
<arg choice='opt' rep='repeat'><replaceable>ARGS</replaceable></arg>
|
||||
<sbr/>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
<refsect1 id='description'><title>DESCRIPTION</title>
|
||||
<para>The <command>dbus-launch</command> command is used to start a session bus
|
||||
instance of <emphasis remap='I'>dbus-daemon</emphasis> from a shell script.
|
||||
It would normally be called from a user's login
|
||||
scripts. Unlike the daemon itself, <command>dbus-launch</command> exits, so
|
||||
backticks or the $() construct can be used to read information from
|
||||
<command>dbus-launch</command>.</para>
|
||||
|
||||
<para>With no arguments, <command>dbus-launch</command> will launch a session bus
|
||||
instance and print the address and pid of that instance to standard
|
||||
output.</para>
|
||||
|
||||
<para>You may specify a program to be run; in this case, <command>dbus-launch</command>
|
||||
will launch a session bus instance, set the appropriate environment
|
||||
variables so the specified program can find the bus, and then execute the
|
||||
specified program, with the specified arguments. See below for
|
||||
examples.</para>
|
||||
|
||||
<para>If you launch a program, <command>dbus-launch</command> will not print the
|
||||
information about the new bus to standard output.</para>
|
||||
|
||||
<para>When <command>dbus-launch</command> prints bus information to standard output, by
|
||||
default it is in a simple key-value pairs format. However, you may
|
||||
request several alternate syntaxes using the --sh-syntax, --csh-syntax,
|
||||
--binary-syntax, or
|
||||
--auto-syntax options. Several of these cause <command>dbus-launch</command> to emit shell code
|
||||
to set up the environment.</para>
|
||||
|
||||
<para>With the --auto-syntax option, <command>dbus-launch</command> looks at the value
|
||||
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
|
||||
--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.</para>
|
||||
|
||||
|
||||
<para>See <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink> for more information
|
||||
about D-Bus. See also the man page for <emphasis remap='I'>dbus-daemon</emphasis>.</para>
|
||||
|
||||
|
||||
<para>Here is an example of how to use <command>dbus-launch</command> with an
|
||||
sh-compatible shell to start the per-session bus daemon:</para>
|
||||
<literallayout remap='.nf'>
|
||||
|
||||
## 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
|
||||
|
||||
</literallayout> <!-- .fi -->
|
||||
<para>You might run something like that in your login scripts.</para>
|
||||
|
||||
|
||||
<para>Another way to use <command>dbus-launch</command> is to run your main session
|
||||
program, like so:</para>
|
||||
<literallayout remap='.nf'>
|
||||
|
||||
dbus-launch gnome-session
|
||||
|
||||
</literallayout> <!-- .fi -->
|
||||
<para>The above would likely be appropriate for ~/.xsession or ~/.Xclients.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='automatic_launching'><title>AUTOMATIC LAUNCHING</title>
|
||||
<para>If DBUS_SESSION_BUS_ADDRESS is not set for a process that tries to use
|
||||
D-Bus, by default the process will attempt to invoke dbus-launch with
|
||||
the --autolaunch option to start up a new session bus or find the
|
||||
existing bus address on the X display or in a file in
|
||||
~/.dbus/session-bus/</para>
|
||||
|
||||
|
||||
<para>Whenever an autolaunch occurs, the application that had to
|
||||
start a new bus will be in its own little world; it can effectively
|
||||
end up starting a whole new session if it tries to use a lot of
|
||||
bus services. This can be suboptimal or even totally broken, depending
|
||||
on the app and what it tries to do.</para>
|
||||
|
||||
|
||||
<para>There are two common reasons for autolaunch. One is ssh to a remote
|
||||
machine. The ideal fix for that would be forwarding of
|
||||
DBUS_SESSION_BUS_ADDRESS in the same way that DISPLAY is forwarded.
|
||||
In the meantime, you can edit the session.conf config file to
|
||||
have your session bus listen on TCP, and manually set
|
||||
DBUS_SESSION_BUS_ADDRESS, if you like.</para>
|
||||
|
||||
|
||||
<para>The second common reason for autolaunch is an su to another user, and
|
||||
display of X applications running as the second user on the display
|
||||
belonging to the first user. Perhaps the ideal fix in this case
|
||||
would be to allow the second user to connect to the session bus of the
|
||||
first user, just as they can connect to the first user's display.
|
||||
However, a mechanism for that has not been coded.</para>
|
||||
|
||||
|
||||
<para>You can always avoid autolaunch by manually setting
|
||||
DBUS_SESSION_BUS_ADDRESS. Autolaunch happens because the default
|
||||
address if none is set is "autolaunch:", so if any other address is
|
||||
set there will be no autolaunch. You can however include autolaunch in
|
||||
an explicit session bus address as a fallback, for example
|
||||
DBUS_SESSION_BUS_ADDRESS="something:,autolaunch:" - in that case if
|
||||
the first address doesn't work, processes will autolaunch. (The bus
|
||||
address variable contains a comma-separated list of addresses to try.)</para>
|
||||
|
||||
|
||||
<para>The --autolaunch option is considered an internal implementation
|
||||
detail of libdbus, and in fact there are plans to change it. There's
|
||||
no real reason to use it outside of the libdbus implementation anyhow.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='options'><title>OPTIONS</title>
|
||||
<para>The following options are supported:</para>
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><option>--auto-syntax</option></term>
|
||||
<listitem>
|
||||
<para>Choose --csh-syntax or --sh-syntax based on the SHELL environment variable.</para>
|
||||
|
||||
<para><option>--binary-syntax</option>
|
||||
Write to stdout a nul-terminated bus address, then the bus PID as a
|
||||
binary integer of size sizeof(pid_t), then the bus X window ID as a
|
||||
binary integer of size sizeof(long). Integers are in the machine's
|
||||
byte order, not network byte order or any other canonical byte order.</para>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--close-stderr</option></term>
|
||||
<listitem>
|
||||
<para>Close the standard error output stream before starting the D-Bus
|
||||
daemon. This is useful if you want to capture dbus-launch error
|
||||
messages but you don't want dbus-daemon to keep the stream open to
|
||||
your application.</para>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--config-file=FILENAME</option></term>
|
||||
<listitem>
|
||||
<para>Pass --config-file=FILENAME to the bus daemon, instead of passing it
|
||||
the --session argument. See the man page for dbus-daemon</para>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--csh-syntax</option></term>
|
||||
<listitem>
|
||||
<para>Emit csh compatible code to set up environment variables.</para>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--exit-with-session</option></term>
|
||||
<listitem>
|
||||
<para>If this option is provided, a persistent "babysitter" process will be
|
||||
created that watches stdin for HUP and tries to connect to the X
|
||||
server. If this process gets a HUP on stdin or loses its X connection,
|
||||
it kills the message bus daemon.</para>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--autolaunch=MACHINEID</option></term>
|
||||
<listitem>
|
||||
<para>This option implies that <command>dbus-launch</command> should scan for a
|
||||
previously-started session and reuse the values found there. If no
|
||||
session is found, it will start a new session. The
|
||||
--exit-with-session option is implied if --autolaunch is given.
|
||||
This option is for the exclusive use of libdbus, you do not want to
|
||||
use it manually. It may change in the future.</para>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--sh-syntax</option></term>
|
||||
<listitem>
|
||||
<para>Emit Bourne-shell compatible code to set up environment variables.</para>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--version</option></term>
|
||||
<listitem>
|
||||
<para>Print the version of dbus-launch</para>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='author'><title>AUTHOR</title>
|
||||
<para>See <ulink url='http://www.freedesktop.org/software/dbus/doc/AUTHORS'>http://www.freedesktop.org/software/dbus/doc/AUTHORS</ulink></para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='bugs'><title>BUGS</title>
|
||||
<para>Please send bug reports to the D-Bus mailing list or bug tracker,
|
||||
see <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink></para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
121
cmake/tools/dbus-monitor.xml
Normal file
121
cmake/tools/dbus-monitor.xml
Normal file
|
|
@ -0,0 +1,121 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
<!-- lifted from troff+man by doclifter -->
|
||||
<refentry id='dbusmonitor1'>
|
||||
<!-- -->
|
||||
<!-- dbus\-monitor manual page. -->
|
||||
<!-- Copyright (C) 2003 Red Hat, Inc. -->
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>dbus-monitor</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</refmeta>
|
||||
<refnamediv id='name'>
|
||||
<refname>dbus-monitor</refname>
|
||||
<refpurpose>debug probe to print message bus messages</refpurpose>
|
||||
</refnamediv>
|
||||
<!-- body begins here -->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<cmdsynopsis>
|
||||
<command>dbus-monitor</command>
|
||||
<group choice='opt'><arg choice='plain'>--system </arg><arg choice='plain'>--session </arg><arg choice='plain'>--address <replaceable>ADDRESS</replaceable></arg></group>
|
||||
<group choice='opt'><arg choice='plain'>--profile </arg><arg choice='plain'>--monitor </arg></group>
|
||||
<arg choice='opt'><arg choice='plain'><replaceable>watch</replaceable></arg><arg choice='plain'><replaceable>expressions</replaceable></arg></arg>
|
||||
<sbr/>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
<refsect1 id='description'><title>DESCRIPTION</title>
|
||||
<para>The <command>dbus-monitor</command> command is used to monitor messages going
|
||||
through a D-Bus message bus. See
|
||||
<ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink> for more information about
|
||||
the big picture.</para>
|
||||
|
||||
|
||||
<para>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 <command>dbus-monitor</command> to
|
||||
monitor the system or session buses respectively. If neither is
|
||||
specified, <command>dbus-monitor</command> monitors the session bus.</para>
|
||||
|
||||
|
||||
<para><command>dbus-monitor</command> has two different output modes, the 'classic'-style
|
||||
monitoring mode and profiling mode. The profiling format is a compact
|
||||
format with a single line per message and microsecond-resolution timing
|
||||
information. The --profile and --monitor options select the profiling
|
||||
and monitoring output format respectively. If neither is specified,
|
||||
<command>dbus-monitor</command> uses the monitoring output format.</para>
|
||||
|
||||
|
||||
<para>In order to get <command>dbus-monitor</command> to see the messages you are interested
|
||||
in, you should specify a set of watch expressions as you would expect to
|
||||
be passed to the <emphasis remap='I'>dbus_bus_add_match</emphasis> function.</para>
|
||||
|
||||
|
||||
<para>The message bus configuration may keep <command>dbus-monitor</command> from seeing
|
||||
all messages, especially if you run the monitor as a non-root user.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='options'><title>OPTIONS</title>
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><option>--system</option></term>
|
||||
<listitem>
|
||||
<para>Monitor the system message bus.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--session</option></term>
|
||||
<listitem>
|
||||
<para>Monitor the session message bus. (This is the default.)</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--address ADDRESS</option></term>
|
||||
<listitem>
|
||||
<para>Monitor an arbitrary message bus given at ADDRESS.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--profile</option></term>
|
||||
<listitem>
|
||||
<para>Use the profiling output format.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--monitor</option></term>
|
||||
<listitem>
|
||||
<para>Use the monitoring output format. (This is the default.)</para>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='example'><title>EXAMPLE</title>
|
||||
<para>Here is an example of using dbus-monitor to watch for the gnome typing
|
||||
monitor to say things</para>
|
||||
<literallayout remap='.nf'>
|
||||
|
||||
dbus-monitor "type='signal',sender='org.gnome.TypingMonitor',interface='org.gnome.TypingMonitor'"
|
||||
|
||||
</literallayout> <!-- .fi -->
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='author'><title>AUTHOR</title>
|
||||
<para>dbus-monitor was written by Philip Blundell.
|
||||
The profiling output mode was added by Olli Salli.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='bugs'><title>BUGS</title>
|
||||
<para>Please send bug reports to the D-Bus mailing list or bug tracker,
|
||||
see <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink></para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
143
cmake/tools/dbus-send.xml
Normal file
143
cmake/tools/dbus-send.xml
Normal file
|
|
@ -0,0 +1,143 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
<!-- lifted from troff+man by doclifter -->
|
||||
<refentry id='dbussend1'>
|
||||
<!-- -->
|
||||
<!-- dbus\-send manual page. -->
|
||||
<!-- Copyright (C) 2003 Red Hat, Inc. -->
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>dbus-send</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</refmeta>
|
||||
<refnamediv id='name'>
|
||||
<refname>dbus-send</refname>
|
||||
<refpurpose>Send a message to a message bus</refpurpose>
|
||||
</refnamediv>
|
||||
<!-- body begins here -->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<cmdsynopsis>
|
||||
<command>dbus-send</command>
|
||||
<group choice='opt'><arg choice='plain'>--system </arg><arg choice='plain'>--session </arg></group>
|
||||
<arg choice='opt'>--dest=<replaceable>NAME</replaceable></arg>
|
||||
<arg choice='opt'>--print-reply </arg>
|
||||
<arg choice='opt'>--type=<replaceable>TYPE</replaceable></arg>
|
||||
<arg choice='plain'><replaceable><destination</replaceable></arg>
|
||||
<arg choice='plain'><replaceable>object</replaceable></arg>
|
||||
<arg choice='plain'><replaceable>path></replaceable></arg>
|
||||
<arg choice='plain'><replaceable><message</replaceable></arg>
|
||||
<arg choice='plain'><replaceable>name></replaceable></arg>
|
||||
<arg choice='opt' rep='repeat'><replaceable>contents</replaceable></arg>
|
||||
<sbr/>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
<refsect1 id='description'><title>DESCRIPTION</title>
|
||||
<para>The <command>dbus-send</command> command is used to send a message to a D-Bus message
|
||||
bus. See <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink> for more
|
||||
information about the big picture.</para>
|
||||
|
||||
|
||||
<para>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 <command>dbus-send</command> to send
|
||||
messages to the system or session buses respectively. If neither is
|
||||
specified, <command>dbus-send</command> sends to the session bus.</para>
|
||||
|
||||
|
||||
<para>Nearly all uses of <command>dbus-send</command> must provide the --dest argument
|
||||
which is the name of a connection on the bus to send the message to. If
|
||||
--dest is omitted, no destination is set.</para>
|
||||
|
||||
|
||||
<para>The object path and the name of the message to send must always be
|
||||
specified. Following arguments, if any, are the message contents
|
||||
(message arguments). These are given as type-specified values and
|
||||
may include containers (arrays, dicts, and variants) as described below.</para>
|
||||
|
||||
<literallayout remap='.nf'>
|
||||
<contents> ::= <item> | <container> [ <item> | <container>...]
|
||||
<item> ::= <type>:<value>
|
||||
<container> ::= <array> | <dict> | <variant>
|
||||
<array> ::= array:<type>:<value>[,<value>...]
|
||||
<dict> ::= dict:<type>:<type>:<key>,<value>[,<key>,<value>...]
|
||||
<variant> ::= variant:<type>:<value>
|
||||
<type> ::= string | int16 | uint 16 | int32 | uint32 | int64 | uint64 | double | byte | boolean | objpath
|
||||
</literallayout> <!-- .fi -->
|
||||
|
||||
<para>D-Bus supports more types than these, but <command>dbus-send</command> currently
|
||||
does not. Also, <command>dbus-send</command> does not permit empty containers
|
||||
or nested containers (e.g. arrays of variants).</para>
|
||||
|
||||
|
||||
<para>Here is an example invocation:</para>
|
||||
<literallayout remap='.nf'>
|
||||
|
||||
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
|
||||
|
||||
</literallayout> <!-- .fi -->
|
||||
|
||||
<para>Note that the interface is separated from a method or signal
|
||||
name by a dot, though in the actual protocol the interface
|
||||
and the interface member are separate fields.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='options'><title>OPTIONS</title>
|
||||
<para>The following options are supported:</para>
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term><option>--dest=NAME</option></term>
|
||||
<listitem>
|
||||
<para>Specify the name of the connection to receive the message.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--print-reply</option></term>
|
||||
<listitem>
|
||||
<para>Block for a reply to the message sent, and print any reply received.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--system</option></term>
|
||||
<listitem>
|
||||
<para>Send to the system message bus.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--session</option></term>
|
||||
<listitem>
|
||||
<para>Send to the session message bus. (This is the default.)</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--type=TYPE</option></term>
|
||||
<listitem>
|
||||
<para>Specify "method_call" or "signal" (defaults to "signal").</para>
|
||||
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='author'><title>AUTHOR</title>
|
||||
<para>dbus-send was written by Philip Blundell.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='bugs'><title>BUGS</title>
|
||||
<para>Please send bug reports to the D-Bus mailing list or bug tracker,
|
||||
see <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink></para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
Loading…
Add table
Reference in a new issue