<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
-<!-- lifted from troff+man by doclifter -->
<refentry id='dbuslaunch1'>
<!-- dbus\-launch manual page.
<!-- body begins here -->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
- <command>dbus-launch</command> <arg choice='opt'>--version </arg>
+ <command>dbus-launch</command>
+ <arg choice='opt'>--version </arg>
+ <arg choice='opt'>--help </arg>
<arg choice='opt'>--sh-syntax </arg>
<arg choice='opt'>--csh-syntax </arg>
<arg choice='opt'>--auto-syntax </arg>
+ <arg choice='opt'>--binary-syntax </arg>
+ <arg choice='opt'>--close-stderr </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>
<refsect1 id='description'><title>DESCRIPTION</title>
-<para>The <command>dbus-launch</command> command is used to start a session bus
+<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
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
+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
or
<filename>~/.Xclients</filename>.</para>
-<para>To start a D-Bus session within a text-mode session, you can run
-dbus-launch in the background. For instance, in a sh-compatible shell:</para>
+<para>To start a D-Bus session within a text\(hymode session,
+ do not use <emphasis remap='B'>dbus-launch</emphasis>.
+ Instead, see <citerefentry><refentrytitle>dbus-run-session</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
+</para>
<literallayout remap='.nf'>
## test for an existing bus daemon, just to be safe
<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
+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
+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
+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>
<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
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--binary-syntax</option></term>
+ <listitem>
+<para>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>
<varlistentry>
<term><option>--config-file=FILENAME</option></term>
<listitem>
-<para>Pass --config-file=FILENAME to the bus daemon, instead of passing it
+<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>
<term><option>--exit-with-session</option></term>
<listitem>
-<para>If this option is provided, a persistent "babysitter" process will be
+<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>--help</option></term>
+ <listitem>
+<para>Print the help info of dbus-launch</para>
+
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
see <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink></para>
</refsect1>
</refentry>
-
projects / platform / upstream / dbus.git / blobdiff