From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Sun, 17 Sep 2017 19:05:20 +0000 (+0200)
Subject: man: describe user@host:machine syntax
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=6a4df817d5f44e9421bab68d5b4efe87218cfc46;p=elogind.git

man: describe user@host:machine syntax

Fixes #6734.
---

diff --git a/man/sd_bus_default.xml b/man/sd_bus_default.xml
index 7e853d6fe..ccb3b1204 100644
--- a/man/sd_bus_default.xml
+++ b/man/sd_bus_default.xml
@@ -165,13 +165,17 @@
     not set, a suitable default for the default system D-Bus instance
     will be used.</para>
 
-    <para><function>sd_bus_open_system_remote()</function> connects to
-    the system bus on the specified <parameter>host</parameter> using
-    <citerefentry
-    project='die-net'><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry>. <parameter>host</parameter>
-    consists of an optional user name followed by the
-    <literal>@</literal> symbol, and the hostname.
-    </para>
+    <para><function>sd_bus_open_system_remote()</function> connects to the system bus on
+    the specified host using
+    <citerefentry project='die-net'><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
+    <parameter>host</parameter> consists of an optional user name followed by the
+    <literal>@</literal> symbol, and the hostname, optionally followed by a
+    <literal>:</literal> and a machine name. If the machine name is given, a connection
+    is created to the system bus in the specified container on the remote machine, and
+    otherwise a connection to the system bus on the specified host is created.</para>
+
+    <para>Note that entering a container is a privileged operation, and will likely only
+    work for the root user on the remote machine.</para>
 
     <para><function>sd_bus_open_system_machine()</function> connects
     to the system bus in the specified <parameter>machine</parameter>,