doc/dbus-launch.1.xml.in

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