man/systemd-bus-proxyd.xml

   1 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4 <!ENTITY % entities SYSTEM "custom-entities.ent" >
   5 %entities;
   6 ]>
   7
   8 <!--
   9   This file is part of systemd.
  10
  11   Copyright 2013 Zbigniew Jędrzejewski-Szmek
  12
  13   systemd is free software; you can redistribute it and/or modify it
  14   under the terms of the GNU Lesser General Public License as published by
  15   the Free Software Foundation; either version 2.1 of the License, or
  16   (at your option) any later version.
  17
  18   systemd is distributed in the hope that it will be useful, but
  19   WITHOUT ANY WARRANTY; without even the implied warranty of
  20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  21   Lesser General Public License for more details.
  22
  23   You should have received a copy of the GNU Lesser General Public License
  24   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  25 -->
  26
  27 <refentry id="systemd-bus-proxyd" conditional="ENABLE_KDBUS"
  28           xmlns:xi="http://www.w3.org/2001/XInclude">
  29
  30   <refentryinfo>
  31     <title>systemd-bus-proxyd</title>
  32     <productname>systemd</productname>
  33
  34     <authorgroup>
  35       <author>
  36         <contrib>Developer</contrib>
  37         <firstname>Lennart</firstname>
  38         <surname>Poettering</surname>
  39         <email>lennart@poettering.net</email>
  40       </author>
  41     </authorgroup>
  42   </refentryinfo>
  43
  44   <refmeta>
  45     <refentrytitle>systemd-bus-proxyd</refentrytitle>
  46     <manvolnum>8</manvolnum>
  47   </refmeta>
  48
  49   <refnamediv>
  50     <refname>systemd-bus-proxyd</refname>
  51     <refpurpose>Connect STDIO or a socket to a given bus address</refpurpose>
  52   </refnamediv>
  53
  54   <refsynopsisdiv>
  55     <cmdsynopsis>
  56       <command>&rootlibexecdir;/systemd-bus-proxyd</command>
  57       <arg choice="opt" rep="repeat">OPTIONS</arg>
  58       <arg choice="opt"><replaceable>PLACEHOLDER</replaceable></arg>
  59     </cmdsynopsis>
  60   </refsynopsisdiv>
  61
  62   <refsect1>
  63     <title>Description</title>
  64
  65     <para><command>systemd-bus-proxyd</command> will proxy D-Bus
  66     messages to and from a bus. The will be either the system bus or
  67     the bus specified with <option>--address</option> when that option
  68     is given. Messages will be proxied to/from standard input and
  69     output, or the socket received through socket activation.</para>
  70
  71     <para>This program can be used to connect a program using classic
  72     D-Bus to kdbus.</para>
  73   </refsect1>
  74
  75   <refsect1>
  76     <title>Options and Arguments</title>
  77
  78     <para>The following options are understood:</para>
  79
  80     <variablelist>
  81       <varlistentry>
  82         <term><option>--address=<replaceable>ADDRESS</replaceable><optional>:<replaceable>ADDRESS...</replaceable></optional></option></term>
  83
  84         <listitem>
  85           <para>Connect to the bus specified by
  86           <replaceable>ADDRESS</replaceable>. Multiple colon-separated
  87           addresses can be specified, in which case
  88           <command>systemd-bus-proxyd</command> will attempt to
  89           connect to them in turn.</para>
  90         </listitem>
  91       </varlistentry>
  92
  93       <xi:include href="standard-options.xml" xpointer="help" />
  94       <xi:include href="standard-options.xml" xpointer="version" />
  95     </variablelist>
  96
  97     <para><replaceable>PLACEHOLDER</replaceable>, if given, must be a string
  98     of <literal>x</literal> and will be used to display information about
  99     the process that <command>systemd-bus-proxyd</command> is forwarding
 100     messages for.</para>
 101   </refsect1>
 102
 103   <refsect1>
 104     <title>See Also</title>
 105
 106     <para>
 107       <citerefentry project='dbus'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 108       <ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>,
 109       <ulink url="https://code.google.com/p/d-bus/">kdbus</ulink>
 110     </para>
 111   </refsect1>
 112 </refentry>