Put dbus-run-session through doclifter and adjust to match other man pages

diff --git a/configure.ac b/configure.ac
index f351fde..008d0d5 100644 (file)
--- 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 (file)
--- 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 (file)
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 (file)
index 0000000..693c5e4
--- /dev/null
+++ b/doc/dbus-run-session.1.xml.in
@@ -0,0 +1,144 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+                   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<refentry id='dbusrunsession1'>
+<refmeta>
+<refentrytitle>dbus-run-session</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class="manual">User Commands</refmiscinfo>
+<refmiscinfo class="source">D-Bus</refmiscinfo>
+<refmiscinfo class="version">@DBUS_VERSION@</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>dbus-run-session</refname>
+<refpurpose>start a process as a new D-Bus session</refpurpose>
+</refnamediv>
+<!-- body begins here -->
+<refsynopsisdiv id='synopsis'>
+<cmdsynopsis>
+  <command>dbus-run-session</command>
+    <arg choice='opt'><arg choice='plain'>--config-file </arg><arg choice='plain'><replaceable>FILENAME</replaceable></arg></arg>
+    <arg choice='opt'><arg choice='plain'>--dbus-daemon </arg><arg choice='plain'><replaceable>BINARY</replaceable></arg></arg>
+    <arg choice='opt'>-- </arg>
+    <arg choice='plain'><replaceable>PROGRAM</replaceable></arg>
+    <arg choice='opt' rep='repeat'><replaceable>ARGUMENTS</replaceable></arg>
+</cmdsynopsis>
+<cmdsynopsis>
+  <command>dbus-run-session</command>    <arg choice='plain'>--help </arg>
+</cmdsynopsis>
+<cmdsynopsis>
+  <command>dbus-run-session</command>    <arg choice='plain'>--version </arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+<para><command>dbus-run-session</command>
+is used to start a session bus instance of
+<emphasis remap='B'>dbus-daemon</emphasis>
+from a shell script, and start a specified program in that session. The
+<emphasis remap='B'>dbus-daemon</emphasis>
+will run for as long as the program does, after which it will terminate.</para>
+
+<para>One use is to run a shell with its own
+<emphasis remap='B'>dbus-daemon</emphasis>
+in a text&hyphen;mode or SSH session, and have the
+<emphasis remap='B'>dbus-daemon</emphasis>
+terminate automatically on leaving the sub&hyphen;shell, like this:</para>
+
+<para>    dbus-run-session -- bash</para>
+
+<para>or to replace the login shell altogether, by combining <command>dbus-run-session</command>
+with the <emphasis remap='B'>exec</emphasis> builtin:</para>
+
+<para>    exec dbus-run-session -- bash</para>
+
+<para>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:</para>
+
+<para>    dbus-run-session -- make check</para>
+
+<para>or (in
+<citerefentry><refentrytitle>automake</refentrytitle><manvolnum>1</manvolnum></citerefentry>):</para>
+
+<literallayout remap='.nf'>
+    TESTS_ENVIRONMENT = MY_DEBUG=all dbus-run-session --
+
+</literallayout></refsect1>
+
+<refsect1 id='options'><title>OPTIONS</title>
+<variablelist remap='TP'>
+  <varlistentry>
+  <term><option>--config-file=</option><replaceable>FILENAME</replaceable>, <option>--config-file</option> <replaceable>FILENAME</replaceable></term>
+  <listitem>
+<para>Pass
+<option>--config-file=</option><replaceable>FILENAME</replaceable>
+to the bus daemon, instead of passing it the
+<option>--session</option>
+argument. See
+<citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><option>--dbus-daemon=</option><replaceable>BINARY</replaceable>, <option>--dbus-daemon</option> <replaceable>BINARY</replaceable></term>
+  <listitem>
+<para>Run <emphasis remap='I'>BINARY</emphasis> as <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>, instead of searching the <envar>PATH</envar>
+in the usual way for an executable called <emphasis remap='B'>dbus-daemon</emphasis>.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><option>--help</option></term>
+  <listitem>
+<para>Print usage information and exit.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><option>--version</option></term>
+  <listitem>
+<para>Print the version of dbus-run-session and exit.</para>
+  </listitem>
+  </varlistentry>
+</variablelist>
+</refsect1>
+
+<refsect1 id='exit_status'><title>EXIT STATUS</title>
+<para><command>dbus-run-session</command>
+exits with the exit status of
+<emphasis remap='I'>PROGRAM</emphasis>,
+0 if the
+<option>--help</option> or <option>--version</option>
+options were used, 127 on an error within
+<command>dbus-run-session</command>
+itself, or
+128+<emphasis remap='I'>n</emphasis>
+if the
+<emphasis remap='I'>PROGRAM</emphasis>
+was killed by signal
+<emphasis remap='I'>n</emphasis>.</para>
+</refsect1>
+
+<refsect1 id='environment'><title>ENVIRONMENT</title>
+<para><envar>PATH</envar>
+is searched to find
+<emphasis remap='I'>PROGRAM</emphasis>,
+and (if the --dbus-daemon option is not used or its argument does not
+contain a
+<emphasis remap='B'>/</emphasis> character) to find <emphasis remap='B'>dbus-daemon</emphasis>.</para>
+
+<para>The session bus' address is made available to
+<emphasis remap='I'>PROGRAM</emphasis>
+in the environment variable
+<emphasis remap='B'>DBUS_SESSION_BUS_ADDRESS</emphasis>.</para>
+</refsect1>
+
+<refsect1 id='bugs'><title>BUGS</title>
+<para>Please send bug reports to the D-Bus mailing list or bug tracker,
+see <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink></para>
+</refsect1>
+
+<refsect1 id='see_also'><title>SEE ALSO</title>
+<para><citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>dbus-launch</refentrytitle><manvolnum>1</manvolnum></citerefentry></para>
+</refsect1>
+</refentry>