1<?xml version='1.0'?> <!--*-nxml-*-->
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
5
6<refentry id="systemd-stdio-bridge"
7  xmlns:xi="http://www.w3.org/2001/XInclude">
8
9  <refentryinfo>
10    <title>systemd-stdio-bridge</title>
11    <productname>systemd</productname>
12  </refentryinfo>
13
14  <refmeta>
15    <refentrytitle>systemd-stdio-bridge</refentrytitle>
16    <manvolnum>1</manvolnum>
17  </refmeta>
18
19  <refnamediv>
20    <refname>systemd-stdio-bridge</refname>
21    <refpurpose>D-Bus proxy</refpurpose>
22  </refnamediv>
23
24  <refsynopsisdiv>
25    <cmdsynopsis>
26      <command>systemd-stdio-bridge</command>
27      <arg choice="opt" rep="repeat">OPTIONS</arg>
28    </cmdsynopsis>
29  </refsynopsisdiv>
30
31  <refsect1>
32    <title>Description</title>
33
34    <para><command>systemd-stdio-bridge</command> implements a proxy between STDIN/STDOUT and a D-Bus bus. It
35    expects to receive an open connection via STDIN/STDOUT when started, and will create a new connection to
36    the specified bus. It will then forward messages between the two connections. This program is suitable
37    for socket activation: the first connection may be a pipe or a socket and must be passed as either
38    standard input, or as an open file descriptor according to the protocol described in
39    <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>. The
40    second connection will be made by default to the local system bus, but this can be influenced by the
41    <option>--user</option>, <option>--system</option>, <option>--machine=</option>, and
42    <option>--bus-path=</option> options described below.</para>
43
44    <para><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry> uses
45    <command>systemd-stdio-bridge</command> to forward D-Bus connections over
46    <citerefentry project='die-net'><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
47    or to connect to the bus of a different user, see
48    <citerefentry><refentrytitle>sd_bus_set_address</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
49    </para>
50  </refsect1>
51
52  <refsect1>
53    <title>Options</title>
54
55    <para>The following options are understood:</para>
56
57    <variablelist>
58      <xi:include href="user-system-options.xml" xpointer="user" />
59      <xi:include href="user-system-options.xml" xpointer="system" />
60      <xi:include href="user-system-options.xml" xpointer="machine" />
61
62      <varlistentry>
63          <term><option>-p <replaceable>PATH</replaceable></option></term>
64          <term><option>--bus-path=<replaceable>PATH</replaceable></option></term>
65
66          <listitem><para>Path to the bus address. Default: <literal>unix:path=/run/dbus/system_bus_socket</literal>
67          </para></listitem>
68      </varlistentry>
69
70      <xi:include href="standard-options.xml" xpointer="help" />
71      <xi:include href="standard-options.xml" xpointer="version" />
72    </variablelist>
73  </refsect1>
74
75  <refsect1>
76    <title>Exit status</title>
77
78    <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
79  </refsect1>
80
81  <refsect1>
82    <title>See Also</title>
83    <para>
84      <citerefentry project='dbus'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
85      <citerefentry project='dbus'><refentrytitle>dbus-broker</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
86      <ulink url="https://www.freedesktop.org/wiki/Software/dbus">D-Bus</ulink>,
87      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
88    </para>
89  </refsect1>
90
91</refentry>
92