diff options
Diffstat (limited to 'doc/dbus-daemon.1.in')
| -rw-r--r-- | doc/dbus-daemon.1.in | 154 |
1 files changed, 77 insertions, 77 deletions
diff --git a/doc/dbus-daemon.1.in b/doc/dbus-daemon.1.in index a54f8634..185441c9 100644 --- a/doc/dbus-daemon.1.in +++ b/doc/dbus-daemon.1.in @@ -1,37 +1,37 @@ .\" -.\" dbus-daemon manual page. +.\" dbus\-daemon manual page. .\" Copyright (C) 2003,2008 Red Hat, Inc. .\" -.TH dbus-daemon 1 +.TH dbus\-daemon 1 .SH NAME -dbus-daemon \- Message bus daemon +dbus\-daemon \- Message bus daemon .SH SYNOPSIS .PP -.B dbus-daemon -dbus-daemon [\-\-version] [\-\-session] [\-\-system] [\-\-config-file=FILE] -[\-\-print-address[=DESCRIPTOR]] [\-\-print-pid[=DESCRIPTOR]] [\-\-fork] +.B dbus\-daemon +dbus\-daemon [\-\-version] [\-\-session] [\-\-system] [\-\-config\-file=FILE] +[\-\-print\-address[=DESCRIPTOR]] [\-\-print\-pid[=DESCRIPTOR]] [\-\-fork] .SH DESCRIPTION -\fIdbus-daemon\fP is the D-Bus message bus daemon. See +\fIdbus\-daemon\fP is the D\-Bus message bus daemon. See http://www.freedesktop.org/software/dbus/ for more information about -the big picture. D-Bus is first a library that provides one-to-one -communication between any two applications; \fIdbus-daemon\fP is an +the big picture. D\-Bus is first a library that provides one\-to\-one +communication between any two applications; \fIdbus\-daemon\fP 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. .PP 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). -\fIdbus-daemon\fP is used for both of these instances, but with +per\-user\-login\-session message bus (started each time a user logs in). +\fIdbus\-daemon\fP is used for both of these instances, but with a different configuration file. .PP The \-\-session option is equivalent to -"\-\-config-file=@EXPANDED_SYSCONFDIR@/dbus-1/session.conf" and the \-\-system +"\-\-config\-file=@EXPANDED_SYSCONFDIR@/dbus\-1/session.conf" and the \-\-system option is equivalent to -"\-\-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. +"\-\-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. .PP The systemwide daemon is normally launched by an init script, standardly called simply "messagebus". @@ -39,11 +39,11 @@ standardly called simply "messagebus". The systemwide daemon is largely used for broadcasting system events, such as changes to the printer queue, or adding/removing devices. .PP -The per-session daemon is used for various interprocess communication +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). .PP -SIGHUP will cause the D-Bus daemon to PARTIALLY reload its +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 @@ -52,47 +52,47 @@ with SIGHUP. .SH OPTIONS The following options are supported: .TP -.I "--config-file=FILE" +.I "\-\-config\-file=FILE" Use the given configuration file. .TP -.I "--fork" +.I "\-\-fork" 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. -.I "--nofork" +.I "\-\-nofork" Force the message bus not to fork and become a daemon, even if the configuration file specifies that it should. .TP -.I "--print-address[=DESCRIPTOR]" +.I "\-\-print\-address[=DESCRIPTOR]" 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. .TP -.I "--print-pid[=DESCRIPTOR]" +.I "\-\-print\-pid[=DESCRIPTOR]" 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. .TP -.I "--session" -Use the standard configuration file for the per-login-session message +.I "\-\-session" +Use the standard configuration file for the per\-login\-session message bus. .TP -.I "--system" +.I "\-\-system" Use the standard configuration file for the systemwide message bus. .TP -.I "--version" +.I "\-\-version" Print the version of the daemon. .TP -.I "--introspect" -Print the introspection information for all D-Bus internal interfaces. +.I "\-\-introspect" +Print the introspection information for all D\-Bus internal interfaces. .TP -.I "--address[=ADDRESS]" +.I "\-\-address[=ADDRESS]" Set the address to listen on. This option overrides the address configured in the configuration file. .TP -.I "--systemd-activation" -Enable systemd-style service activation. Only useful in conjunction +.I "\-\-systemd\-activation" +Enable systemd\-style service activation. Only useful in conjunction with the systemd system and session manager on Linux. .SH CONFIGURATION FILE @@ -100,7 +100,7 @@ with the systemd system and session manager on Linux. 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. +while another might set it up to be a per\-user\-login\-session bus. .PP The configuration file also establishes resource limits, security parameters, and so forth. @@ -109,10 +109,10 @@ The configuration file is not part of any interoperability specification and its backward compatibility is not guaranteed; this document is documentation, not specification. .PP -The standard systemwide and per-session message bus setups are -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 +The standard systemwide and per\-session message bus setups are +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. @@ -121,7 +121,7 @@ The configuration file is an XML document. It must have the following doctype declaration: .nf - <!DOCTYPE busconfig PUBLIC "-//freedesktop//DTD D-Bus Bus Configuration 1.0//EN" + <!DOCTYPE busconfig PUBLIC "\-//freedesktop//DTD D\-Bus Bus Configuration 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd"> .fi @@ -139,9 +139,9 @@ Root element. .I "<type>" .PP -The well-known type of the message bus. Currently known values are +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 +either added to the D\-Bus specification, or namespaced. The last <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 @@ -149,7 +149,7 @@ session bus from the system bus is controlled from the other elements in the configuration file. .PP -If the well-known type of the message bus is "session", then the +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 @@ -187,7 +187,7 @@ 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 -@EXPANDED_SYSCONFDIR@/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. .TP @@ -229,7 +229,7 @@ This may be useful to avoid affecting the behavior of child processes. .PP Add an address that the bus should listen on. The -address is in the standard D-Bus format that contains +address is in the standard D\-Bus format that contains a transport name plus possible parameters/options. .PP @@ -258,7 +258,7 @@ 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 +\-\-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. @@ -302,7 +302,7 @@ service will be used). .PP 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. .TP @@ -311,33 +311,33 @@ not the systemwide bus. .PP <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 +Base Directory Specification" with the subdirectory "dbus\-1/services", +so for example "/usr/share/dbus\-1/services" would be among the directories searched. .PP The "XDG Base Directory Specification" can be found at -http://freedesktop.org/wiki/Standards/basedir-spec if it hasn't moved, +http://freedesktop.org/wiki/Standards/basedir\-spec if it hasn't moved, otherwise try your favorite search engine. .PP The <standard_session_servicedirs/> option is only relevant to the -per-user-session bus daemon defined in -@EXPANDED_SYSCONFDIR@/dbus-1/session.conf. Putting it in any other +per\-user\-session bus daemon defined in +@EXPANDED_SYSCONFDIR@/dbus\-1/session.conf. Putting it in any other configuration file would probably be nonsense. .TP .I "<standard_system_servicedirs/>" .PP -<standard_system_servicedirs/> specifies the standard system-wide +<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. +This option defaults to @EXPANDED_DATADIR@/dbus\-1/system\-services. .PP 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 +per\-system bus daemon defined in +@EXPANDED_SYSCONFDIR@/dbus\-1/system.conf. Putting it in any other configuration file would probably be nonsense. .TP @@ -346,11 +346,11 @@ configuration file would probably be nonsense. .PP <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 dbus\-daemon\-launch\-helper executable in located in libexec. .PP -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 +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. .TP @@ -396,7 +396,7 @@ Available limit names are: connection "max_replies_per_connection" : max number of pending method replies per connection - (number of calls-in-progress) + (number of calls\-in\-progress) "reply_timeout" : milliseconds (thousandths) until a method call times out .fi @@ -408,7 +408,7 @@ by max_message_size. .PP 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 +number of users that can work together to denial\-of\-service all other users by using up all connections on the systemwide bus. .PP @@ -426,7 +426,7 @@ they are analogous to a firewall in that they allow expected traffic and prevent unexpected traffic. .PP -Currently, the system bus has a default-deny policy for sending method calls +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. @@ -449,14 +449,14 @@ The <policy> element has one of four attributes: .PP Policies are applied to a connection as follows: .nf - - all context="default" policies are applied - - all group="connection's user's group" policies are applied + \- 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 + \- 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 + \- all at_console="true" policies are applied + \- all at_console="false" policies are applied + \- all context="mandatory" policies are applied .fi .PP @@ -522,7 +522,7 @@ 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. .PP -The other send_* and receive_* attributes are purely textual/by-value +The other send_* and receive_* attributes are purely textual/by\-value matches against the given field in the message header. .PP "Eavesdropping" occurs when an application receives a message that @@ -590,7 +590,7 @@ received" are evaluated separately. 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 +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"/> @@ -614,7 +614,7 @@ creates a mapping. Right now only one kind of association is possible: .PP 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. .PP @@ -668,7 +668,7 @@ associated permissions defined to control operations on objects with that class. .PP -D-Bus performs SELinux security checks in two places. +D\-Bus performs SELinux security checks in two places. .PP First, any time a message is routed from one connection to another @@ -710,8 +710,8 @@ 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. .PP The simplest way to figure out what's happening on the bus is to run -the \fIdbus-monitor\fP program, which comes with the D-Bus -package. You can also send test messages with \fIdbus-send\fP. These +the \fIdbus\-monitor\fP program, which comes with the D\-Bus +package. You can also send test messages with \fIdbus\-send\fP. These programs have their own man pages. .PP If you want to know what the daemon itself is doing, you might consider @@ -722,20 +722,20 @@ 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: .nf - DBUS_VERBOSE=1 dbus-daemon --session --print-address + DBUS_VERBOSE=1 dbus\-daemon \-\-session \-\-print\-address .fi .PP 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 +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. .PP -DBUS_VERBOSE=1 will have NO EFFECT unless your copy of D-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 +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.) .PP If you want to get fancy, you can create a custom bus @@ -748,5 +748,5 @@ for example. See http://www.freedesktop.org/software/dbus/doc/AUTHORS .SH BUGS -Please send bug reports to the D-Bus mailing list or bug tracker, +Please send bug reports to the D\-Bus mailing list or bug tracker, see http://www.freedesktop.org/software/dbus/ |