From 38199f4c28712912ea857bf9938dc8ea3798ca61 Mon Sep 17 00:00:00 2001
From: baude <bbaude@redhat.com>
Date: Mon, 29 Apr 2019 10:30:12 -0500
Subject: add varlink bridge

allow the user to define a remote host and remote username for their
remote podman sessions.  this is then feed to the varlink "bridge" as
the ssh credentials and endpoint.

Signed-off-by: baude <bbaude@redhat.com>
---
 docs/podman-varlink.1.md | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

(limited to 'docs')

diff --git a/docs/podman-varlink.1.md b/docs/podman-varlink.1.md
index 7eeb3dd66..0501d853f 100644
--- a/docs/podman-varlink.1.md
+++ b/docs/podman-varlink.1.md
@@ -7,8 +7,10 @@ podman\-varlink - Runs the varlink backend interface
 **podman varlink** [*options*] *uri*
 
 ## DESCRIPTION
-Starts the varlink service listening on *uri* that allows varlink clients to interact with podman.  This should generally be done
-with systemd.  See _Configuration_ below.
+Starts the varlink service listening on *uri* that allows varlink clients to interact with podman.  If no *uri* is provided, a default
+URI will be used depending on the user calling the varlink service.  The default for the root user is `unix:/run/podman/io.podman`. Regular
+users will have a default *uri* of `$XDG_RUNTIME_DIR/podman/io.podman`.  For example, `unix:/run/user/1000/podman/io.podman`
+The varlink service should generally be done with systemd.  See _Configuration_ below.
 
 ## GLOBAL OPTIONS
 
@@ -23,16 +25,23 @@ second. A value of `0` means no timeout and the session will not expire.
 
 ## EXAMPLES
 
-Run the podman varlink service manually and accept the default timeout.
+Run the podman varlink service accepting all default options.
 
 ```
-$ podman varlink unix:/run/podman/io.podman
+$ podman varlink
+```
+
+
+Run the podman varlink service with an alternate URI and accept the default timeout.
+
+```
+$ podman varlink unix:/tmp/io.podman
 ```
 
 Run the podman varlink service manually with a 5 second timeout.
 
 ```
-$ podman varlink --timeout 5000 unix:/run/podman/io.podman
+$ podman varlink --timeout 5000
 ```
 
 ## CONFIGURATION
-- 
cgit v1.2.3-54-g00ecf