doc/dbus-launch.1.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
   4 <!-- lifted from troff+man by doclifter -->
   5 <refentry id='dbuslaunch1'>
   6
   7 <!--  dbus&bsol;-launch manual page.
   8  Copyright (C) 2003 Red Hat, Inc. -->
   9
  10 <refmeta>
  11 <refentrytitle>dbus-launch</refentrytitle>
  12 <manvolnum>1</manvolnum>
  13 </refmeta>
  14 <refnamediv>
  15 <refname>dbus-launch</refname>
  16 <refpurpose>Utility to start a message bus from a shell script</refpurpose>
  17 </refnamediv>
  18 <!-- body begins here -->
  19 <refsynopsisdiv id='synopsis'>
  20 <cmdsynopsis>
  21   <command>dbus-launch</command>    <arg choice='opt'>--version </arg>
  22     <arg choice='opt'>--sh-syntax </arg>
  23     <arg choice='opt'>--csh-syntax </arg>
  24     <arg choice='opt'>--auto-syntax </arg>
  25     <arg choice='opt'>--exit-with-session </arg>
  26     <arg choice='opt'>--autolaunch=<replaceable>MACHINEID</replaceable></arg>
  27     <arg choice='opt'>--config-file=<replaceable>FILENAME</replaceable></arg>
  28     <arg choice='opt'><replaceable>PROGRAM</replaceable></arg>
  29     <arg choice='opt' rep='repeat'><replaceable>ARGS</replaceable></arg>
  30     <sbr/>
  31 </cmdsynopsis>
  32 </refsynopsisdiv>
  33
  34
  35 <refsect1 id='description'><title>DESCRIPTION</title>
  36 <para>The <command>dbus-launch</command> command is used to start a session bus
  37 instance of <emphasis remap='I'>dbus-daemon</emphasis> from a shell script.
  38 It would normally be called from a user's login
  39 scripts. Unlike the daemon itself, <command>dbus-launch</command> exits, so
  40 backticks or the $() construct can be used to read information from
  41 <command>dbus-launch</command>.</para>
  42
  43 <para>With no arguments, <command>dbus-launch</command> will launch a session bus
  44 instance and print the address and PID of that instance to standard
  45 output.</para>
  46
  47 <para>You may specify a program to be run; in this case, <command>dbus-launch</command>
  48 will launch a session bus instance, set the appropriate environment
  49 variables so the specified program can find the bus, and then execute the
  50 specified program, with the specified arguments.  See below for
  51 examples.</para>
  52
  53 <para>If you launch a program, <command>dbus-launch</command> will not print the
  54 information about the new bus to standard output.</para>
  55
  56 <para>When <command>dbus-launch</command> prints bus information to standard output, by
  57 default it is in a simple key-value pairs format. However, you may
  58 request several alternate syntaxes using the --sh-syntax, --csh-syntax,
  59 --binary-syntax, or
  60 --auto-syntax options. Several of these cause <command>dbus-launch</command> to emit shell code
  61 to set up the environment.</para>
  62
  63 <para>With the --auto-syntax option, <command>dbus-launch</command> looks at the value
  64 of the SHELL environment variable to determine which shell syntax
  65 should be used.  If SHELL ends in "csh", then csh-compatible code is
  66 emitted; otherwise Bourne shell code is emitted.  Instead of passing
  67 --auto-syntax, you may explicitly specify a particular one by using
  68 --sh-syntax for Bourne syntax, or --csh-syntax for csh syntax.
  69 In scripts, it's more robust to avoid --auto-syntax and you hopefully
  70 know which shell your script is written in.</para>
  71
  72
  73 <para>See <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink> for more information
  74 about D-Bus. See also the man page for <emphasis remap='I'>dbus-daemon</emphasis>.</para>
  75
  76 </refsect1>
  77
  78 <refsect1 id='examples'><title>EXAMPLES</title>
  79 <para>Distributions running
  80 <command>dbus-launch</command>
  81 as part of a standard X session should run
  82 <emphasis remap='B'>dbus-launch --exit-with-session</emphasis>
  83 after the X server has started and become available, as a wrapper around
  84 the "main" X client (typically a session manager or window manager), as in
  85 these examples:</para>
  86
  87   <blockquote remap='RS'>
  88 <para><emphasis remap='B'>dbus-launch --exit-with-session gnome-session</emphasis></para>
  89
  90 <para><emphasis remap='B'>dbus-launch --exit-with-session openbox</emphasis></para>
  91
  92 <para><emphasis remap='B'>dbus-launch --exit-with-session ~/.xsession</emphasis>
  93   </para></blockquote> <!-- remap='RE' -->
  94
  95 <para>If your distribution does not do this, you can achieve similar results
  96 by running your session or window manager in the same way in a script
  97 run by your X session, such as
  98 <filename>~/.xsession</filename>,
  99 <filename>~/.xinitrc</filename>
 100 or
 101 <filename>~/.Xclients</filename>.</para>
 102
 103 <para>To start a D-Bus session within a text-mode session, you can run
 104 dbus-launch in the background. For instance, in a sh-compatible shell:</para>
 105
 106 <literallayout remap='.nf'>
 107   ## test for an existing bus daemon, just to be safe
 108   if test -z "$DBUS_SESSION_BUS_ADDRESS" ; then
 109       ## if not found, launch a new one
 110       eval `dbus-launch --sh-syntax`
 111       echo "D-Bus per-session daemon address is: $DBUS_SESSION_BUS_ADDRESS"
 112   fi
 113 </literallayout> <!-- .fi -->
 114 <para>Note that in this case, dbus-launch will exit, and dbus-daemon will not be
 115 terminated automatically on logout.</para>
 116
 117 </refsect1>
 118
 119 <refsect1 id='automatic_launching'><title>AUTOMATIC LAUNCHING</title>
 120 <para>If DBUS_SESSION_BUS_ADDRESS is not set for a process that tries to use
 121 D-Bus, by default the process will attempt to invoke dbus-launch with
 122 the --autolaunch option to start up a new session bus or find the
 123 existing bus address on the X display or in a file in
 124 ~/.dbus/session-bus/</para>
 125
 126
 127 <para>Whenever an autolaunch occurs, the application that had to
 128 start a new bus will be in its own little world; it can effectively
 129 end up starting a whole new session if it tries to use a lot of
 130 bus services. This can be suboptimal or even totally broken, depending
 131 on the app and what it tries to do.</para>
 132
 133
 134 <para>There are two common reasons for autolaunch. One is ssh to a remote
 135 machine. The ideal fix for that would be forwarding of
 136 DBUS_SESSION_BUS_ADDRESS in the same way that DISPLAY is forwarded.
 137 In the meantime, you can edit the session.conf config file to
 138 have your session bus listen on TCP, and manually set
 139 DBUS_SESSION_BUS_ADDRESS, if you like.</para>
 140
 141
 142 <para>The second common reason for autolaunch is an su to another user, and
 143 display of X applications running as the second user on the display
 144 belonging to the first user. Perhaps the ideal fix in this case
 145 would be to allow the second user to connect to the session bus of the
 146 first user, just as they can connect to the first user's display.
 147 However, a mechanism for that has not been coded.</para>
 148
 149
 150 <para>You can always avoid autolaunch by manually setting
 151 DBUS_SESSION_BUS_ADDRESS. Autolaunch happens because the default
 152 address if none is set is "autolaunch:", so if any other address is
 153 set there will be no autolaunch. You can however include autolaunch in
 154 an explicit session bus address as a fallback, for example
 155 DBUS_SESSION_BUS_ADDRESS="something:,autolaunch:" - in that case if
 156 the first address doesn't work, processes will autolaunch. (The bus
 157 address variable contains a comma-separated list of addresses to try.)</para>
 158
 159
 160 <para>The --autolaunch option is considered an internal implementation
 161 detail of libdbus, and in fact there are plans to change it. There's
 162 no real reason to use it outside of the libdbus implementation anyhow.</para>
 163
 164 </refsect1>
 165
 166 <refsect1 id='options'><title>OPTIONS</title>
 167 <para>The following options are supported:</para>
 168 <variablelist remap='TP'>
 169   <varlistentry>
 170   <term><option>--auto-syntax</option></term>
 171   <listitem>
 172 <para>Choose --csh-syntax or --sh-syntax based on the SHELL environment variable.</para>
 173
 174 <para><option>--binary-syntax</option>
 175 Write to stdout a nul-terminated bus address, then the bus PID as a
 176 binary integer of size sizeof(pid_t), then the bus X window ID as a
 177 binary integer of size sizeof(long). Integers are in the machine's
 178 byte order, not network byte order or any other canonical byte order.</para>
 179
 180   </listitem>
 181   </varlistentry>
 182   <varlistentry>
 183   <term><option>--close-stderr</option></term>
 184   <listitem>
 185 <para>Close the standard error output stream before starting the D-Bus
 186 daemon. This is useful if you want to capture dbus-launch error
 187 messages but you don't want dbus-daemon to keep the stream open to
 188 your application.</para>
 189
 190   </listitem>
 191   </varlistentry>
 192   <varlistentry>
 193   <term><option>--config-file=FILENAME</option></term>
 194   <listitem>
 195 <para>Pass --config-file=FILENAME to the bus daemon, instead of passing it
 196 the --session argument. See the man page for dbus-daemon</para>
 197
 198   </listitem>
 199   </varlistentry>
 200   <varlistentry>
 201   <term><option>--csh-syntax</option></term>
 202   <listitem>
 203 <para>Emit csh compatible code to set up environment variables.</para>
 204
 205   </listitem>
 206   </varlistentry>
 207   <varlistentry>
 208   <term><option>--exit-with-session</option></term>
 209   <listitem>
 210 <para>If this option is provided, a persistent "babysitter" process will be
 211 created that watches stdin for HUP and tries to connect to the X
 212 server. If this process gets a HUP on stdin or loses its X connection,
 213 it kills the message bus daemon.</para>
 214
 215   </listitem>
 216   </varlistentry>
 217   <varlistentry>
 218   <term><option>--autolaunch=MACHINEID</option></term>
 219   <listitem>
 220 <para>This option implies that <command>dbus-launch</command> should scan for a
 221 previously-started session and reuse the values found there. If no
 222 session is found, it will start a new session. The
 223 --exit-with-session option is implied if --autolaunch is given.
 224 This option is for the exclusive use of libdbus, you do not want to
 225 use it manually. It may change in the future.</para>
 226
 227   </listitem>
 228   </varlistentry>
 229   <varlistentry>
 230   <term><option>--sh-syntax</option></term>
 231   <listitem>
 232 <para>Emit Bourne-shell compatible code to set up environment variables.</para>
 233
 234   </listitem>
 235   </varlistentry>
 236   <varlistentry>
 237   <term><option>--version</option></term>
 238   <listitem>
 239 <para>Print the version of dbus-launch</para>
 240
 241   </listitem>
 242   </varlistentry>
 243 </variablelist>
 244 </refsect1>
 245
 246 <refsect1 id='notes'><title>NOTES</title>
 247 <para>If you run
 248 <emphasis remap='B'>dbus-launch myapp</emphasis>
 249 (with any other options), dbus-daemon will
 250 <emphasis remap='I'>not</emphasis>
 251 exit when
 252 <emphasis remap='B'>myapp</emphasis>
 253 terminates: this is because
 254 <emphasis remap='B'>myapp</emphasis>
 255 is assumed to be part of a larger session, rather than a session in its
 256 own right.</para>
 257
 258 </refsect1>
 259
 260 <refsect1 id='author'><title>AUTHOR</title>
 261 <para>See <ulink url='http://www.freedesktop.org/software/dbus/doc/AUTHORS'>http://www.freedesktop.org/software/dbus/doc/AUTHORS</ulink></para>
 262
 263 </refsect1>
 264
 265 <refsect1 id='bugs'><title>BUGS</title>
 266 <para>Please send bug reports to the D-Bus mailing list or bug tracker,
 267 see <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink></para>
 268 </refsect1>
 269 </refentry>
 270