X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fdbus-launch.1.xml.in;h=31dd6eac81f2c090a9040ac790e66ecb98161808;hb=7d9239c9c78cb6d0b9c282376fcf3cda1de23209;hp=c6ae0f146f3028ff516a9a60639b4fff50ac7956;hpb=80402f224561bbba513a2806101400b7bcf52164;p=platform%2Fupstream%2Fdbus.git diff --git a/doc/dbus-launch.1.xml.in b/doc/dbus-launch.1.xml.in index c6ae0f1..31dd6ea 100644 --- a/doc/dbus-launch.1.xml.in +++ b/doc/dbus-launch.1.xml.in @@ -1,7 +1,6 @@ - - dbus-launch --version + dbus-launch + --version + --help --sh-syntax --csh-syntax --auto-syntax + --binary-syntax + --close-stderr --exit-with-session --autolaunch=MACHINEID --config-file=FILENAME @@ -36,7 +39,7 @@ DESCRIPTION -The dbus-launch command is used to start a session bus +The dbus-launch command is used to start a session bus instance of dbus-daemon from a shell script. It would normally be called from a user's login scripts. Unlike the daemon itself, dbus-launch exits, so @@ -57,7 +60,7 @@ examples. information about the new bus to standard output. When dbus-launch 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 dbus-launch to emit shell code @@ -103,8 +106,10 @@ run by your X session, such as or ~/.Xclients. -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: +To start a D-Bus session within a text\(hymode session, + do not use dbus-launch. + Instead, see dbus-run-session1. + ## test for an existing bus daemon, just to be safe @@ -122,14 +127,14 @@ terminated automatically on logout. AUTOMATIC LAUNCHING 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/ 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. @@ -137,7 +142,7 @@ on the app and what it tries to do. 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. @@ -174,8 +179,12 @@ no real reason to use it outside of the libdbus implementation anyhow. Choose --csh-syntax or --sh-syntax based on the SHELL environment variable. - -Write to stdout a nul-terminated bus address, then the bus PID as a + + + + + +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. @@ -195,7 +204,7 @@ your application. -Pass --config-file=FILENAME to the bus daemon, instead of passing it +Pass --config-file=FILENAME to the bus daemon, instead of passing it the --session argument. See the man page for dbus-daemon @@ -210,7 +219,7 @@ the --session argument. See the man page for dbus-daemon -If this option is provided, a persistent "babysitter" process will be +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. @@ -243,6 +252,13 @@ use it manually. It may change in the future. + + + +Print the help info of dbus-launch + + + @@ -270,4 +286,3 @@ own right. see http://www.freedesktop.org/software/dbus/ -