diff options
| author | Simon McVittie <smcv@debian.org> | 2013-06-12 19:52:04 +0100 |
|---|---|---|
| committer | Simon McVittie <smcv@debian.org> | 2013-06-12 19:52:04 +0100 |
| commit | 20c1496fee4c06a5f268585ba67bd3a6f105fa78 (patch) | |
| tree | 6a2ba4410fffb4a2241237398aa940ac7ae28881 /doc | |
| parent | 05b847b89bcf23c7805e1519cdd16a2aeb16d14b (diff) | |
| parent | 46d73712ab0750f995f0ec89f4d28b09dbba8c29 (diff) | |
| download | dbus-20c1496fee4c06a5f268585ba67bd3a6f105fa78.tar.gz | |
Imported Upstream version 1.7.4upstream/1.7.4
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 3 | ||||
| -rw-r--r-- | doc/Makefile.in | 142 | ||||
| -rw-r--r-- | doc/dbus-launch.1.xml.in | 6 | ||||
| -rw-r--r-- | doc/dbus-run-session.1.xml.in | 144 | ||||
| -rw-r--r-- | doc/dbus-send.1.xml.in | 10 |
5 files changed, 243 insertions, 62 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 35725696..aa5c7e1f 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) @@ -15,6 +16,7 @@ man1_MANS = \ dbus-daemon.1 \ dbus-launch.1 \ dbus-monitor.1 \ + dbus-run-session.1 \ dbus-send.1 \ dbus-uuidgen.1 endif @@ -24,6 +26,7 @@ MAN_HTML_FILES = \ dbus-daemon.1.html \ dbus-launch.1.html \ dbus-monitor.1.html \ + dbus-run-session.1.html \ dbus-send.1.html \ dbus-uuidgen.1.html diff --git a/doc/Makefile.in b/doc/Makefile.in index 7ffc29dc..a0c16c40 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -1,9 +1,8 @@ -# Makefile.in generated by automake 1.11.6 from Makefile.am. +# Makefile.in generated by automake 1.13.3 from Makefile.am. # @configure_input@ -# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software -# Foundation, Inc. +# Copyright (C) 1994-2013 Free Software Foundation, Inc. + # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. @@ -16,23 +15,51 @@ @SET_MAKE@ VPATH = @srcdir@ -am__make_dryrun = \ - { \ - am__dry=no; \ +am__is_gnu_make = test -n '$(MAKEFILE_LIST)' && test -n '$(MAKELEVEL)' +am__make_running_with_option = \ + case $${target_option-} in \ + ?) ;; \ + *) echo "am__make_running_with_option: internal error: invalid" \ + "target option '$${target_option-}' specified" >&2; \ + exit 1;; \ + esac; \ + has_opt=no; \ + sane_makeflags=$$MAKEFLAGS; \ + if $(am__is_gnu_make); then \ + sane_makeflags=$$MFLAGS; \ + else \ case $$MAKEFLAGS in \ *\\[\ \ ]*) \ - echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \ - | grep '^AM OK$$' >/dev/null || am__dry=yes;; \ - *) \ - for am__flg in $$MAKEFLAGS; do \ - case $$am__flg in \ - *=*|--*) ;; \ - *n*) am__dry=yes; break;; \ - esac; \ - done;; \ + bs=\\; \ + sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ + | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ esac; \ - test $$am__dry = yes; \ - } + fi; \ + skip_next=no; \ + strip_trailopt () \ + { \ + flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ + }; \ + for flg in $$sane_makeflags; do \ + test $$skip_next = yes && { skip_next=no; continue; }; \ + case $$flg in \ + *=*|--*) continue;; \ + -*I) strip_trailopt 'I'; skip_next=yes;; \ + -*I?*) strip_trailopt 'I';; \ + -*O) strip_trailopt 'O'; skip_next=yes;; \ + -*O?*) strip_trailopt 'O';; \ + -*l) strip_trailopt 'l'; skip_next=yes;; \ + -*l?*) strip_trailopt 'l';; \ + -[dEDm]) skip_next=yes;; \ + -[JT]) skip_next=yes;; \ + esac; \ + case $$flg in \ + *$$target_option*) has_opt=yes; break;; \ + esac; \ + done; \ + test $$has_opt = yes +am__make_dryrun = (target_option=n; $(am__make_running_with_option)) +am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) pkgdatadir = $(datadir)/@PACKAGE@ pkgincludedir = $(includedir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ @@ -54,11 +81,13 @@ host_triplet = @host@ @DBUS_XML_DOCS_ENABLED_TRUE@am__append_1 = $(XMLTO_HTML) @DBUS_DOXYGEN_DOCS_ENABLED_TRUE@@DBUS_HAVE_XSLTPROC_TRUE@am__append_2 = dbus.devhelp subdir = doc -DIST_COMMON = $(dist_doc_DATA) $(dist_html_DATA) $(srcdir)/Makefile.am \ - $(srcdir)/Makefile.in $(srcdir)/dbus-cleanup-sockets.1.xml.in \ +DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/Makefile.am \ + $(srcdir)/dbus-cleanup-sockets.1.xml.in \ $(srcdir)/dbus-daemon.1.xml.in $(srcdir)/dbus-launch.1.xml.in \ - $(srcdir)/dbus-monitor.1.xml.in $(srcdir)/dbus-send.1.xml.in \ - $(srcdir)/dbus-uuidgen.1.xml.in TODO + $(srcdir)/dbus-monitor.1.xml.in \ + $(srcdir)/dbus-run-session.1.xml.in \ + $(srcdir)/dbus-send.1.xml.in $(srcdir)/dbus-uuidgen.1.xml.in \ + $(dist_doc_DATA) $(dist_html_DATA) TODO ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 am__aclocal_m4_deps = $(top_srcdir)/m4/as-ac-expand.m4 \ $(top_srcdir)/m4/compiler.m4 $(top_srcdir)/m4/libtool.m4 \ @@ -72,15 +101,21 @@ am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ mkinstalldirs = $(install_sh) -d CONFIG_HEADER = $(top_builddir)/config.h CONFIG_CLEAN_FILES = dbus-cleanup-sockets.1.xml dbus-daemon.1.xml \ - dbus-launch.1.xml dbus-monitor.1.xml dbus-send.1.xml \ - dbus-uuidgen.1.xml + dbus-launch.1.xml dbus-monitor.1.xml dbus-run-session.1.xml \ + dbus-send.1.xml dbus-uuidgen.1.xml CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : AM_V_GEN = $(am__v_GEN_@AM_V@) am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) -am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = AM_V_at = $(am__v_at_@AM_V@) am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) am__v_at_0 = @ +am__v_at_1 = SOURCES = DIST_SOURCES = am__can_run_installinfo = \ @@ -121,6 +156,7 @@ am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(docdir)" \ NROFF = nroff MANS = $(man1_MANS) DATA = $(dist_doc_DATA) $(dist_html_DATA) $(html_DATA) +am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ ADT_LIBS = @ADT_LIBS@ @@ -212,8 +248,6 @@ LIBDBUS_LIBS = @LIBDBUS_LIBS@ LIBOBJS = @LIBOBJS@ LIBS = @LIBS@ LIBTOOL = @LIBTOOL@ -LIBXML_CFLAGS = @LIBXML_CFLAGS@ -LIBXML_LIBS = @LIBXML_LIBS@ LIPO = @LIPO@ LN_S = @LN_S@ LTLIBOBJS = @LTLIBOBJS@ @@ -337,6 +371,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) @@ -346,6 +381,7 @@ MAN_XML_FILES = \ @DBUS_XML_DOCS_ENABLED_TRUE@ dbus-daemon.1 \ @DBUS_XML_DOCS_ENABLED_TRUE@ dbus-launch.1 \ @DBUS_XML_DOCS_ENABLED_TRUE@ dbus-monitor.1 \ +@DBUS_XML_DOCS_ENABLED_TRUE@ dbus-run-session.1 \ @DBUS_XML_DOCS_ENABLED_TRUE@ dbus-send.1 \ @DBUS_XML_DOCS_ENABLED_TRUE@ dbus-uuidgen.1 @@ -354,6 +390,7 @@ MAN_HTML_FILES = \ dbus-daemon.1.html \ dbus-launch.1.html \ dbus-monitor.1.html \ + dbus-run-session.1.html \ dbus-send.1.html \ dbus-uuidgen.1.html @@ -455,6 +492,8 @@ dbus-launch.1.xml: $(top_builddir)/config.status $(srcdir)/dbus-launch.1.xml.in cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ dbus-monitor.1.xml: $(top_builddir)/config.status $(srcdir)/dbus-monitor.1.xml.in cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ +dbus-run-session.1.xml: $(top_builddir)/config.status $(srcdir)/dbus-run-session.1.xml.in + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ dbus-send.1.xml: $(top_builddir)/config.status $(srcdir)/dbus-send.1.xml.in cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ dbus-uuidgen.1.xml: $(top_builddir)/config.status $(srcdir)/dbus-uuidgen.1.xml.in @@ -569,27 +608,14 @@ uninstall-htmlDATA: @list='$(html_DATA)'; test -n "$(htmldir)" || list=; \ files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \ dir='$(DESTDIR)$(htmldir)'; $(am__uninstall_files_from_dir) -tags: TAGS -TAGS: +tags TAGS: + +ctags CTAGS: -ctags: CTAGS -CTAGS: +cscope cscopelist: distdir: $(DISTFILES) - @list='$(MANS)'; if test -n "$$list"; then \ - list=`for p in $$list; do \ - if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ - if test -f "$$d$$p"; then echo "$$d$$p"; else :; fi; done`; \ - if test -n "$$list" && \ - grep 'ab help2man is required to generate this page' $$list >/dev/null; then \ - echo "error: found man pages containing the \`missing help2man' replacement text:" >&2; \ - grep -l 'ab help2man is required to generate this page' $$list | sed 's/^/ /' >&2; \ - echo " to fix them, install help2man, remove and regenerate the man pages;" >&2; \ - echo " typically \`make maintainer-clean' will remove them" >&2; \ - exit 1; \ - else :; fi; \ - else :; fi @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ list='$(DISTFILES)'; \ @@ -733,20 +759,20 @@ uninstall-man: uninstall-man1 .MAKE: install-am install-strip .PHONY: all all-am all-local check check-am clean clean-generic \ - clean-libtool clean-local distclean distclean-generic \ - distclean-libtool distdir dvi dvi-am html html-am info info-am \ - install install-am install-data install-data-am \ - install-data-local install-dist_docDATA install-dist_htmlDATA \ - install-dvi install-dvi-am install-exec install-exec-am \ - install-html install-html-am install-htmlDATA install-info \ - install-info-am install-man install-man1 install-pdf \ - install-pdf-am install-ps install-ps-am install-strip \ - installcheck installcheck-am installdirs maintainer-clean \ - maintainer-clean-generic mostlyclean mostlyclean-generic \ - mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ - uninstall-dist_docDATA uninstall-dist_htmlDATA \ - uninstall-htmlDATA uninstall-local uninstall-man \ - uninstall-man1 + clean-libtool clean-local cscopelist-am ctags-am distclean \ + distclean-generic distclean-libtool distdir dvi dvi-am html \ + html-am info info-am install install-am install-data \ + install-data-am install-data-local install-dist_docDATA \ + install-dist_htmlDATA install-dvi install-dvi-am install-exec \ + install-exec-am install-html install-html-am install-htmlDATA \ + install-info install-info-am install-man install-man1 \ + install-pdf install-pdf-am install-ps install-ps-am \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-generic mostlyclean \ + mostlyclean-generic mostlyclean-libtool pdf pdf-am ps ps-am \ + tags-am uninstall uninstall-am uninstall-dist_docDATA \ + uninstall-dist_htmlDATA uninstall-htmlDATA uninstall-local \ + uninstall-man uninstall-man1 @DBUS_XML_DOCS_ENABLED_TRUE@%.html: %.xml diff --git a/doc/dbus-launch.1.xml.in b/doc/dbus-launch.1.xml.in index fde439da..727495b7 100644 --- a/doc/dbus-launch.1.xml.in +++ b/doc/dbus-launch.1.xml.in @@ -102,8 +102,10 @@ run by your X session, such as or <filename>~/.Xclients</filename>.</para> -<para>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:</para> +<para>To start a D-Bus session within a text\(hymode session, + do not use <emphasis remap='B'>dbus-launch</emphasis>. + Instead, see <citerefentry><refentrytitle>dbus-run-session</refentrytitle><manvolnum>1</manvolnum></citerefentry>. +</para> <literallayout remap='.nf'> ## test for an existing bus daemon, just to be safe diff --git a/doc/dbus-run-session.1.xml.in b/doc/dbus-run-session.1.xml.in new file mode 100644 index 00000000..693c5e4e --- /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‐mode or SSH session, and have the +<emphasis remap='B'>dbus-daemon</emphasis> +terminate automatically on leaving the sub‐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> diff --git a/doc/dbus-send.1.xml.in b/doc/dbus-send.1.xml.in index 78f1374b..67b6dfd2 100644 --- a/doc/dbus-send.1.xml.in +++ b/doc/dbus-send.1.xml.in @@ -21,7 +21,7 @@ <refsynopsisdiv id='synopsis'> <cmdsynopsis> <command>dbus-send</command> - <group choice='opt'><arg choice='plain'>--system </arg><arg choice='plain'>--session </arg></group> + <group choice='opt'><arg choice='plain'>--system </arg><arg choice='plain'>--session </arg><arg choice='plain'>--address=<replaceable>ADDRESS</replaceable></arg></group> <arg choice='opt'>--dest=<replaceable>NAME</replaceable></arg> <arg choice='opt'><arg choice='plain'>--print-reply </arg><arg choice='opt'><replaceable>=literal</replaceable></arg></arg> <arg choice='opt'>--reply-timeout=<replaceable>MSEC</replaceable></arg> @@ -106,7 +106,7 @@ and the interface member are separate fields.</para> <term><option>--print-reply</option></term> <listitem> <para>Block for a reply to the message sent, and print any reply received -in a human-readable form.</para> +in a human-readable form. It also means the message type (<option>--type=</option>) is <emphasis remap='B'>method_call</emphasis>.</para> </listitem> </varlistentry> <varlistentry> @@ -137,6 +137,12 @@ The default is implementation‐defined, typically 25 seconds.</para> </listitem> </varlistentry> <varlistentry> + <term><option>--address=</option><replaceable>ADDRESS</replaceable></term> + <listitem> +<para>Send to <replaceable>ADDRESS</replaceable>.</para> + </listitem> + </varlistentry> + <varlistentry> <term><option>--type=</option><replaceable>TYPE</replaceable></term> <listitem> <para>Specify <emphasis remap='B'>method_call</emphasis> or <emphasis remap='B'>signal</emphasis> (defaults to "<emphasis remap='B'>signal</emphasis>").</para> |
