test-execute: Add tests for new PassEnvironment= directive

[thirdparty/systemd.git] / man / systemd-bus-proxyd.xml

<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2013 Zbigniew Jędrzejewski-Szmek

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="systemd-bus-proxyd"
          xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>systemd-bus-proxyd</title>
    <productname>systemd</productname>

    <authorgroup>
      <author>
        <contrib>Developer</contrib>
        <firstname>Lennart</firstname>
        <surname>Poettering</surname>
        <email>lennart@poettering.net</email>
      </author>
    </authorgroup>
  </refentryinfo>

  <refmeta>
    <refentrytitle>systemd-bus-proxyd</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-bus-proxyd</refname>
    <refpurpose>Connect STDIO or a socket to a given bus address</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>/usr/lib/systemd/systemd-bus-proxyd</command>
      <arg choice="opt" rep="repeat">OPTIONS</arg>
      <arg choice="opt"><replaceable>PLACEHOLDER</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><command>systemd-bus-proxyd</command> will proxy D-Bus
    messages to and from a bus. The will be either the system bus or
    the bus specified with <option>--address</option> when that option
    is given. Messages will be proxied to/from standard input and
    output, or the socket received through socket activation.</para>

    <para>This program can be used to connect a program using classic
    D-Bus to kdbus.</para>
  </refsect1>

  <refsect1>
    <title>Options and Arguments</title>

    <para>The following options are understood:</para>

    <variablelist>
      <varlistentry>
        <term><option>--address=<replaceable>ADDRESS</replaceable><optional>:<replaceable>ADDRESS...</replaceable></optional></option></term>

        <listitem>
          <para>Connect to the bus specified by
          <replaceable>ADDRESS</replaceable>. Multiple colon-separated
          addresses can be specified, in which case
          <command>systemd-bus-proxyd</command> will attempt to
          connect to them in turn.</para>
        </listitem>
      </varlistentry>

      <xi:include href="standard-options.xml" xpointer="help" />
      <xi:include href="standard-options.xml" xpointer="version" />
    </variablelist>

    <para><replaceable>PLACEHOLDER</replaceable>, if given, must be a string
    of <literal>x</literal> and will be used to display information about
    the process that <command>systemd-bus-proxyd</command> is forwarding
    messages for.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>

    <para>
      <citerefentry project='dbus'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>
    </para>
  </refsect1>
</refentry>