man/systemd-bus-proxyd.xml

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