fdo-mirrors/dbus
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/dbus/dbus.git synced 2025-12-29 11:20:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

man pages: replace all unescaped hyphen/minus characters with \-

Browse source 
In a man page, "-" officially means a typographical (Unicode) hyphen,
which frequently breaks the ability to copy and paste code examples from
a man page. "\-" means the ASCII hyphen/minus character. See
<http://lintian.debian.org/tags/hyphen-used-as-minus-sign.html> for
more details.

Rather than trying to distinguish between hyphens, em-dashes and
hyphen/minus, I just replaced all ambiguous hyphens with \- by applying
this vim command repeatedly until it didn't find anything:

     %s/\(^\|[^\\]\)-/\1\\-/g

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=38284
Reviewed-by: Lennart Poettering <lennart@poettering.net>
This commit is contained in:
Simon McVittie 2011-06-14 10:10:24 +01:00
parent 638828526a
commit 4335a09280
6 changed files with 217 additions and 217 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
doc/dbus-cleanup-sockets.1
View file

@ -1,43 +1,43 @@
.\"
.\" dbus-cleanup-sockets manual page.
.\" dbus\-cleanup\-sockets manual page.
.\" Copyright (C) 2003 Red Hat, Inc.
.\"
.TH dbus-cleanup-sockets 1
.TH dbus\-cleanup\-sockets 1
.SH NAME
dbus-cleanup-sockets \- clean up leftover sockets in a directory
dbus\-cleanup\-sockets \- clean up leftover sockets in a directory
.SH SYNOPSIS
.PP
.B dbus-cleanup-sockets [DIRECTORY]
.B dbus\-cleanup\-sockets [DIRECTORY]
.SH DESCRIPTION
The \fIdbus-cleanup-sockets\fP command cleans up unused D-Bus
The \fIdbus\-cleanup\-sockets\fP command cleans up unused D\-Bus
connection sockets. See http://www.freedesktop.org/software/dbus/ for
more information about the big picture.
.PP
If given no arguments, \fIdbus-cleanup-sockets\fP cleans up sockets
If given no arguments, \fIdbus\-cleanup\-sockets\fP cleans up sockets
in the standard default socket directory for the
per-user-login-session message bus; this is usually /tmp.
per\-user\-login\-session message bus; this is usually /tmp.
Optionally, you can pass a different directory on the command line.
.PP
On Linux, this program is essentially useless, because D-Bus defaults
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.
.PP
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.
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"
.SH AUTHOR
dbus-cleanup-sockets was adapted by Havoc Pennington from
linc-cleanup-sockets written by Michael Meeks.
dbus\-cleanup\-sockets was adapted by Havoc Pennington from
linc\-cleanup\-sockets written by Michael Meeks.
.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/

154
doc/dbus-daemon.1.in
View file

@ -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/

114
doc/dbus-launch.1
View file

@ -1,77 +1,77 @@
.\"
.\" dbus-launch manual page.
.\" dbus\-launch manual page.
.\" Copyright (C) 2003 Red Hat, Inc.
.\"
.TH dbus-launch 1
.TH dbus\-launch 1
.SH NAME
dbus-launch \- Utility to start a message bus from a shell script
dbus\-launch \- Utility to start a message bus from a shell script
.SH SYNOPSIS
.PP
.B dbus-launch [\-\-version] [\-\-sh-syntax] [\-\-csh-syntax] [\-\-auto-syntax] [\-\-exit-with-session] [\-\-autolaunch=MACHINEID] [\-\-config-file=FILENAME] [PROGRAM] [ARGS...]
.B dbus\-launch [\-\-version] [\-\-sh\-syntax] [\-\-csh\-syntax] [\-\-auto\-syntax] [\-\-exit\-with\-session] [\-\-autolaunch=MACHINEID] [\-\-config\-file=FILENAME] [PROGRAM] [ARGS...]
.SH DESCRIPTION
The \fIdbus-launch\fP command is used to start a session bus
instance of \fIdbus-daemon\fP from a shell script.
The \fIdbus\-launch\fP command is used to start a session bus
instance of \fIdbus\-daemon\fP from a shell script.
It would normally be called from a user's login
scripts. Unlike the daemon itself, \fIdbus-launch\fP exits, so
scripts. Unlike the daemon itself, \fIdbus\-launch\fP exits, so
backticks or the $() construct can be used to read information from
\fIdbus-launch\fP.
\fIdbus\-launch\fP.
With no arguments, \fIdbus-launch\fP will launch a session bus
With no arguments, \fIdbus\-launch\fP will launch a session bus
instance and print the address and pid of that instance to standard
output.
You may specify a program to be run; in this case, \fIdbus-launch\fP
You may specify a program to be run; in this case, \fIdbus\-launch\fP
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.
If you launch a program, \fIdbus-launch\fP will not print the
If you launch a program, \fIdbus\-launch\fP will not print the
information about the new bus to standard output.
When \fIdbus-launch\fP 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 \fIdbus-launch\fP to emit shell code
When \fIdbus\-launch\fP 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 \fIdbus\-launch\fP to emit shell code
to set up the environment.
With the \-\-auto-syntax option, \fIdbus-launch\fP looks at the value
With the \-\-auto\-syntax option, \fIdbus\-launch\fP 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
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
\-\-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.
.PP
See http://www.freedesktop.org/software/dbus/ for more information
about D-Bus. See also the man page for \fIdbus-daemon\fP.
about D\-Bus. See also the man page for \fIdbus\-daemon\fP.
.PP
Here is an example of how to use \fIdbus-launch\fP with an
sh-compatible shell to start the per-session bus daemon:
Here is an example of how to use \fIdbus\-launch\fP with an
sh\-compatible shell to start the per\-session bus daemon:
.nf
## test for an existing bus daemon, just to be safe
if test -z "$DBUS_SESSION_BUS_ADDRESS" ; then
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"
eval `dbus\-launch \-\-sh\-syntax \-\-exit\-with\-session`
echo "D\-Bus per\-session daemon address is: $DBUS_SESSION_BUS_ADDRESS"
fi
.fi
You might run something like that in your login scripts.
.PP
Another way to use \fIdbus-launch\fP is to run your main session
Another way to use \fIdbus\-launch\fP is to run your main session
program, like so:
.nf
dbus-launch gnome-session
dbus\-launch gnome\-session
.fi
The above would likely be appropriate for ~/.xsession or ~/.Xclients.
@ -80,10 +80,10 @@ The above would likely be appropriate for ~/.xsession or ~/.Xclients.
.PP
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
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/
~/.dbus/session\-bus/
.PP
Whenever an autolaunch occurs, the application that had to
@ -114,70 +114,70 @@ 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
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.)
address variable contains a comma\-separated list of addresses to try.)
.PP
The --autolaunch option is considered an internal implementation
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.
.SH OPTIONS
The following options are supported:
.TP
.I "--auto-syntax"
Choose \-\-csh-syntax or \-\-sh-syntax based on the SHELL environment variable.
.I "\-\-auto\-syntax"
Choose \-\-csh\-syntax or \-\-sh\-syntax based on the SHELL environment variable.
.I "--binary-syntax"
Write to stdout a nul-terminated bus address, then the bus PID as a
.I "\-\-binary\-syntax"
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.
.TP
.I "--close-stderr"
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
.I "\-\-close\-stderr"
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.
.TP
.I "--config-file=FILENAME"
Pass \-\-config-file=FILENAME to the bus daemon, instead of passing it
the \-\-session argument. See the man page for dbus-daemon
.I "\-\-config\-file=FILENAME"
Pass \-\-config\-file=FILENAME to the bus daemon, instead of passing it
the \-\-session argument. See the man page for dbus\-daemon
.TP
.I "--csh-syntax"
.I "\-\-csh\-syntax"
Emit csh compatible code to set up environment variables.
.TP
.I "--exit-with-session"
.I "\-\-exit\-with\-session"
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.
.TP
.I "--autolaunch=MACHINEID"
This option implies that \fIdbus-launch\fP should scan for a
previously-started session and reuse the values found there. If no
.I "\-\-autolaunch=MACHINEID"
This option implies that \fIdbus\-launch\fP 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.
\-\-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.
.TP
.I "--sh-syntax"
Emit Bourne-shell compatible code to set up environment variables.
.I "\-\-sh\-syntax"
Emit Bourne\-shell compatible code to set up environment variables.
.TP
.I "--version"
Print the version of dbus-launch
.I "\-\-version"
Print the version of dbus\-launch
.SH AUTHOR
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/

50
doc/dbus-monitor.1
View file

@ -1,78 +1,78 @@
.\"
.\" dbus-monitor manual page.
.\" dbus\-monitor manual page.
.\" Copyright (C) 2003 Red Hat, Inc.
.\"
.TH dbus-monitor 1
.TH dbus\-monitor 1
.SH NAME
dbus-monitor \- debug probe to print message bus messages
dbus\-monitor \- debug probe to print message bus messages
.SH SYNOPSIS
.PP
.B dbus-monitor
.B dbus\-monitor
[\-\-system | \-\-session | \-\-address ADDRESS] [\-\-profile | \-\-monitor]
[watch expressions]
.SH DESCRIPTION
The \fIdbus-monitor\fP command is used to monitor messages going
through a D-Bus message bus. See
The \fIdbus\-monitor\fP command is used to monitor messages going
through a D\-Bus message bus. See
http://www.freedesktop.org/software/dbus/ for more information about
the big picture.
.PP
There are two well-known message buses: the systemwide message bus
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 \fIdbus-monitor\fP to
per\-user\-login\-session message bus (started each time a user logs in).
The \-\-system and \-\-session options direct \fIdbus\-monitor\fP to
monitor the system or session buses respectively. If neither is
specified, \fIdbus-monitor\fP monitors the session bus.
specified, \fIdbus\-monitor\fP monitors the session bus.
.PP
\fIdbus-monitor\fP has two different output modes, the 'classic'-style
\fIdbus\-monitor\fP 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
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,
\fIdbus-monitor\fP uses the monitoring output format.
\fIdbus\-monitor\fP uses the monitoring output format.
.PP
In order to get \fIdbus-monitor\fP to see the messages you are interested
In order to get \fIdbus\-monitor\fP 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 \fIdbus_bus_add_match\fP function.
.PP
The message bus configuration may keep \fIdbus-monitor\fP from seeing
all messages, especially if you run the monitor as a non-root user.
The message bus configuration may keep \fIdbus\-monitor\fP from seeing
all messages, especially if you run the monitor as a non\-root user.
.SH OPTIONS
.TP
.I "--system"
.I "\-\-system"
Monitor the system message bus.
.TP
.I "--session"
.I "\-\-session"
Monitor the session message bus. (This is the default.)
.TP
.I "--address ADDRESS"
.I "\-\-address ADDRESS"
Monitor an arbitrary message bus given at ADDRESS.
.TP
.I "--profile"
.I "\-\-profile"
Use the profiling output format.
.TP
.I "--monitor"
.I "\-\-monitor"
Use the monitoring output format. (This is the default.)
.SH EXAMPLE
Here is an example of using dbus-monitor to watch for the gnome typing
Here is an example of using dbus\-monitor to watch for the gnome typing
monitor to say things
.nf
dbus-monitor "type='signal',sender='org.gnome.TypingMonitor',interface='org.gnome.TypingMonitor'"
dbus\-monitor "type='signal',sender='org.gnome.TypingMonitor',interface='org.gnome.TypingMonitor'"
.fi
.SH AUTHOR
dbus-monitor was written by Philip Blundell.
dbus\-monitor was written by Philip Blundell.
The profiling output mode was added by Olli Salli.
.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/

46
doc/dbus-send.1
View file

@ -1,39 +1,39 @@
.\"
.\" dbus-send manual page.
.\" dbus\-send manual page.
.\" Copyright (C) 2003 Red Hat, Inc.
.\"
.TH dbus-send 1
.TH dbus\-send 1
.SH NAME
dbus-send \- Send a message to a message bus
dbus\-send \- Send a message to a message bus
.SH SYNOPSIS
.PP
.B dbus-send
[\-\-system | \-\-session] [\-\-dest=NAME] [\-\-print-reply]
.B dbus\-send
[\-\-system | \-\-session] [\-\-dest=NAME] [\-\-print\-reply]
[\-\-type=TYPE] <destination object path> <message name> [contents ...]
.SH DESCRIPTION
The \fIdbus-send\fP command is used to send a message to a D-Bus message
The \fIdbus\-send\fP command is used to send a message to a D\-Bus message
bus. See http://www.freedesktop.org/software/dbus/ for more
information about the big picture.
.PP
There are two well-known message buses: the systemwide message bus
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 \fIdbus-send\fP to send
per\-user\-login\-session message bus (started each time a user logs in).
The \-\-system and \-\-session options direct \fIdbus\-send\fP to send
messages to the system or session buses respectively. If neither is
specified, \fIdbus-send\fP sends to the session bus.
specified, \fIdbus\-send\fP sends to the session bus.
.PP
Nearly all uses of \fIdbus-send\fP must provide the \-\-dest argument
Nearly all uses of \fIdbus\-send\fP 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.
.PP
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
(message arguments). These are given as type\-specified values and
may include containers (arrays, dicts, and variants) as described below.
.nf
@ -46,21 +46,21 @@ may include containers (arrays, dicts, and variants) as described below.
<type> ::= string | int16 | uint 16 | int32 | uint32 | int64 | uint64 | double | byte | boolean | objpath
.fi
D-Bus supports more types than these, but \fIdbus-send\fP currently
does not. Also, \fIdbus-send\fP does not permit empty containers
D\-Bus supports more types than these, but \fIdbus\-send\fP currently
does not. Also, \fIdbus\-send\fP does not permit empty containers
or nested containers (e.g. arrays of variants).
.PP
Here is an example invocation:
.nf
dbus-send \-\-dest=org.freedesktop.ExampleName \\
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 \\
variant:int32:\-8 \\
objpath:/org/freedesktop/sample/object/name
.fi
@ -72,24 +72,24 @@ and the interface member are separate fields.
.SH OPTIONS
The following options are supported:
.TP
.I "--dest=NAME"
.I "\-\-dest=NAME"
Specify the name of the connection to receive the message.
.TP
.I "--print-reply"
.I "\-\-print\-reply"
Block for a reply to the message sent, and print any reply received.
.TP
.I "--system"
.I "\-\-system"
Send to the system message bus.
.TP
.I "--session"
.I "\-\-session"
Send to the session message bus. (This is the default.)
.TP
.I "--type=TYPE"
.I "\-\-type=TYPE"
Specify "method_call" or "signal" (defaults to "signal").
.SH AUTHOR
dbus-send was written by Philip Blundell.
dbus\-send was written by Philip Blundell.
.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/

42
doc/dbus-uuidgen.1
View file

@ -1,36 +1,36 @@
.\"
.\" dbus-uuidgen manual page.
.\" dbus\-uuidgen manual page.
.\" Copyright (C) 2006 Red Hat, Inc.
.\"
.TH dbus-uuidgen 1
.TH dbus\-uuidgen 1
.SH NAME
dbus-uuidgen \- Utility to generate UUIDs
dbus\-uuidgen \- Utility to generate UUIDs
.SH SYNOPSIS
.PP
.B dbus-uuidgen [\-\-version] [\-\-ensure[=FILENAME]] [\-\-get[=FILENAME]]
.B dbus\-uuidgen [\-\-version] [\-\-ensure[=FILENAME]] [\-\-get[=FILENAME]]
.SH DESCRIPTION
The \fIdbus-uuidgen\fP command generates or reads a universally unique ID.
The \fIdbus\-uuidgen\fP command generates or reads a universally unique ID.
.PP
Note that the D-Bus UUID has no relationship to RFC 4122 and does not generate
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").
.PP
See http://www.freedesktop.org/software/dbus/ for more information
about D-Bus.
about D\-Bus.
.PP
The primary usage of \fIdbus-uuidgen\fP is to run in the post-install
script of a D-Bus package like this:
The primary usage of \fIdbus\-uuidgen\fP is to run in the post\-install
script of a D\-Bus package like this:
.nf
dbus-uuidgen --ensure
dbus\-uuidgen \-\-ensure
.fi
.PP
This will ensure that /var/lib/dbus/machine-id exists and has the uuid in it.
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.
@ -43,15 +43,15 @@ sockets, local X displays, localhost.localdomain resolution, process
IDs, and so forth.
.PP
If you run \fIdbus-uuidgen\fP with no options it just prints a new uuid made
If you run \fIdbus\-uuidgen\fP with no options it just prints a new uuid made
up out of thin air.
.PP
If you run it with --get, it prints the machine UUID by default, or
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.
.PP
If you try to change an existing machine-id on a running system, it will
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.
@ -63,27 +63,27 @@ because there are two different kernels.
.SH OPTIONS
The following options are supported:
.TP
.I "--get[=FILENAME]"
If a filename is not given, defaults to localstatedir/lib/dbus/machine-id
.I "\-\-get[=FILENAME]"
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.
.TP
.I "--ensure[=FILENAME]"
If a filename is not given, defaults to localstatedir/lib/dbus/machine-id
.I "\-\-ensure[=FILENAME]"
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.
.TP
.I "--version"
Print the version of dbus-uuidgen
.I "\-\-version"
Print the version of dbus\-uuidgen
.SH AUTHOR
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/