2003-05-03 Havoc Pennington <hp@pobox.com>
[platform/upstream/dbus.git] / tools / dbus-launch.1
1 .\" 
2 .\" dbus-launch manual page.
3 .\" Copyright (C) 2003 Red Hat, Inc.
4 .\"
5 .TH dbus-launch 1
6 .SH NAME
7 dbus-launch \- Utility to start a message bus from a shell script
8 .SH SYNOPSIS
9 .PP
10 .B dbus-launch [\-\-version] [\-\-exit-with-session]
11
12 .SH DESCRIPTION
13
14 The \fIdbus-launch\fP command is used to start \fIdbus-daemon-1\fP
15 from a shell script. It would normally be called from a user's login
16 scripts. Unlike the daemon itself, \fIdbus-launch\fP exits, so
17 backticks or the $() construct can be used to read information from
18 \fIdbus-launch\fP. \fIdbus-launch\fP prints information about the
19 launched daemon in KEY=VALUE format.
20
21 .PP
22 See http://www.freedesktop.org/software/dbus/ for more information
23 about D-BUS. See also the man page for \fIdbus-daemon-1\fP.
24
25 .PP
26 Here is an example of how to use \fIdbus-launch\fP with an 
27 sh-compatible shell:
28 .nf
29
30   VARIABLES=`dbus-launch`
31   eval $VARIABLES
32   echo "D-BUS per-session daemon address is: $DBUS_SESSION_BUS_ADDRESS"
33
34 .fi
35
36 .SH OPTIONS
37 The following options are supported:
38 .TP
39 .I "--exit-with-session"
40 If this option is provided, a persistent "babysitter" process will be 
41 created that watches stdin for HUP and tries to connect to the X
42 server. If this process gets a HUP on stdin or loses its X connection,
43 it kills the message bus daemon.
44
45 .TP
46 .I "--version"
47 Print the version of dbus-launch
48
49 .SH AUTHOR
50 See http://www.freedesktop.org/software/dbus/doc/AUTHORS
51
52 .SH BUGS
53 Please send bug reports to the D-BUS mailing list or bug tracker,
54 see http://www.freedesktop.org/software/dbus/