From 59acbc4854ac7edb463a8b0c6e9b5844e16e1e47 Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Wed, 5 Jun 2013 17:55:03 +0100 Subject: [PATCH] Put dbus-run-session through doclifter and adjust to match other man pages --- configure.ac | 1 + doc/Makefile.am | 1 + doc/dbus-run-session.1 | 100 ----------------------------- doc/dbus-run-session.1.xml.in | 144 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 146 insertions(+), 100 deletions(-) delete mode 100644 doc/dbus-run-session.1 create mode 100644 doc/dbus-run-session.1.xml.in diff --git a/configure.ac b/configure.ac index f351fde..008d0d5 100644 --- a/configure.ac +++ b/configure.ac @@ -1830,6 +1830,7 @@ doc/dbus-cleanup-sockets.1.xml doc/dbus-daemon.1.xml doc/dbus-launch.1.xml doc/dbus-monitor.1.xml +doc/dbus-run-session.1.xml doc/dbus-send.1.xml doc/dbus-uuidgen.1.xml dbus-1.pc diff --git a/doc/Makefile.am b/doc/Makefile.am index 0c6b6fd..aa5c7e1 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -5,6 +5,7 @@ MAN_XML_FILES = \ dbus-daemon.1.xml \ dbus-launch.1.xml \ dbus-monitor.1.xml \ + dbus-run-session.1.xml \ dbus-send.1.xml \ dbus-uuidgen.1.xml \ $(NULL) diff --git a/doc/dbus-run-session.1 b/doc/dbus-run-session.1 deleted file mode 100644 index 8b270eb..0000000 --- a/doc/dbus-run-session.1 +++ /dev/null @@ -1,100 +0,0 @@ -.TH dbus\-run\-session 1 -.SH NAME -dbus\-run\-session \- start a process as a new D-Bus session -.SH SYNOPSIS -.B dbus\-run\-session -.RB [ \-\-config\-file -.IR FILENAME ] -.RB [ \-\-dbus\-daemon -.IR BINARY ] -.RB [ \-\- ] -.IR PROGRAM " [" ARGUMENTS ...] -.P -.B dbus\-run\-session \-\-help -.P -.B dbus\-run\-session \-\-version -.SH DESCRIPTION -.B dbus\-run\-session -is used to start a session bus instance of -.B dbus\-daemon -from a shell script, and start a specified program in that session. The -.B dbus\-daemon -will run for as long as the program does, after which it will terminate. -.P -One use is to run a shell with its own -.B dbus\-daemon -in a text\(hymode or SSH session, and have the -.B dbus\-daemon -terminate automatically on leaving the sub\(hyshell, like this: -.P - dbus\-run\-session \-\- bash -.P -or to replace the login shell altogether, by combining \fBdbus\-run\-session\fR -with the \fBexec\fR builtin: -.P - exec dbus\-run\-session \-\- bash -.P -Another use is to run regression tests and similar things in an isolated -D-Bus session, to avoid either interfering with the "real" D-Bus session -or relying on there already being a D-Bus session active, for instance: -.P - dbus\-run\-session \-\- make check -.P -or (in -.BR automake (1)): -.P -.nf - TESTS_ENVIRONMENT = MY_DEBUG=all dbus\-run\-session \-\- -.fi -.P -.SH OPTIONS -.TP -\fB\-\-config\-file=\fIFILENAME\fR, \fB\-\-config\-file\fR \fIFILENAME\fR -Pass -.BI \-\-config-file= FILENAME -to the bus daemon, instead of passing it the -.B \-\-session -argument. See -.BR dbus-daemon (1). -.TP -\fB\-\-dbus\-daemon=\fIBINARY\fR, \fB\-\-dbus\-daemon\fR \fIBINARY\fR -Run \fIBINARY\fR as \fBdbus\-daemon\fR(1), instead of searching the \fBPATH\fR -in the usual way for an executable called \fBdbus\-daemon\fR. -.TP -.B \-\-help -Print usage information and exit. -.TP -.B \-\-version -Print the version of dbus\-run\-session and exit. -.SH EXIT STATUS -.B dbus\-run\-session -exits with the exit status of -.IR PROGRAM , -0 if the -.BR \-\-help " or " \-\-version -options were used, 127 on an error within -.B dbus\-run\-session -itself, or -.RI 128+ n -if the -.I PROGRAM -was killed by signal -.IR n . -.SH ENVIRONMENT -.B PATH -is searched to find -.IR PROGRAM , -and (if the \-\-dbus\-daemon option is not used or its argument does not -contain a -.BR / " character) to find " dbus\-daemon . -.P -The session bus' address is made available to -.I PROGRAM -in the environment variable -.BR DBUS_SESSION_BUS_ADDRESS . -.SH BUGS -Please send bug reports to the D\-Bus mailing list or bug tracker, -see http://www.freedesktop.org/software/dbus/ -.SH SEE ALSO -.BR dbus\-daemon (1), -.BR dbus\-launch (1) diff --git a/doc/dbus-run-session.1.xml.in b/doc/dbus-run-session.1.xml.in new file mode 100644 index 0000000..693c5e4 --- /dev/null +++ b/doc/dbus-run-session.1.xml.in @@ -0,0 +1,144 @@ + + + + +dbus-run-session +1 +User Commands +D-Bus +@DBUS_VERSION@ + + +dbus-run-session +start a process as a new D-Bus session + + + + + dbus-run-session + --config-file FILENAME + --dbus-daemon BINARY + -- + PROGRAM + ARGUMENTS + + + dbus-run-session --help + + + dbus-run-session --version + + + + +DESCRIPTION +dbus-run-session +is used to start a session bus instance of +dbus-daemon +from a shell script, and start a specified program in that session. The +dbus-daemon +will run for as long as the program does, after which it will terminate. + +One use is to run a shell with its own +dbus-daemon +in a text‐mode or SSH session, and have the +dbus-daemon +terminate automatically on leaving the sub‐shell, like this: + + dbus-run-session -- bash + +or to replace the login shell altogether, by combining dbus-run-session +with the exec builtin: + + exec dbus-run-session -- bash + +Another use is to run regression tests and similar things in an isolated +D-Bus session, to avoid either interfering with the "real" D-Bus session +or relying on there already being a D-Bus session active, for instance: + + dbus-run-session -- make check + +or (in +automake1): + + + TESTS_ENVIRONMENT = MY_DEBUG=all dbus-run-session -- + + + +OPTIONS + + + FILENAME, FILENAME + +Pass +FILENAME +to the bus daemon, instead of passing it the + +argument. See +dbus-daemon1. + + + + BINARY, BINARY + +Run BINARY as dbus-daemon1, instead of searching the PATH +in the usual way for an executable called dbus-daemon. + + + + + +Print usage information and exit. + + + + + +Print the version of dbus-run-session and exit. + + + + + +EXIT STATUS +dbus-run-session +exits with the exit status of +PROGRAM, +0 if the + or +options were used, 127 on an error within +dbus-run-session +itself, or +128+n +if the +PROGRAM +was killed by signal +n. + + +ENVIRONMENT +PATH +is searched to find +PROGRAM, +and (if the --dbus-daemon option is not used or its argument does not +contain a +/ character) to find dbus-daemon. + +The session bus' address is made available to +PROGRAM +in the environment variable +DBUS_SESSION_BUS_ADDRESS. + + +BUGS +Please send bug reports to the D-Bus mailing list or bug tracker, +see http://www.freedesktop.org/software/dbus/ + + +SEE ALSO +dbus-daemon1, +dbus-launch1 + + -- 2.7.4