From ae7c45968dd458326814db2218cf6a4b0ca9c7e1 Mon Sep 17 00:00:00 2001
From: baude <bbaude@redhat.com>
Date: Mon, 21 May 2018 09:17:02 -0500
Subject: set varlink timeout to 1 seconds

Add option to varlink for --timeout.  Input for this option is in milliseconds

Signed-off-by: baude <bbaude@redhat.com>

Closes: #814
Approved by: baude
---
 docs/podman-varlink.1.md | 33 +++++++++++++++++++++------------
 1 file changed, 21 insertions(+), 12 deletions(-)

(limited to 'docs/podman-varlink.1.md')

diff --git a/docs/podman-varlink.1.md b/docs/podman-varlink.1.md
index 9d4e0947b..7ed6c7d92 100644
--- a/docs/podman-varlink.1.md
+++ b/docs/podman-varlink.1.md
@@ -6,34 +6,43 @@
 podman\-varlink - Runs the varlink backend interface
 
 ## SYNOPSIS
-**podman varlink**
+**podman varlink** [OPTIONS]
 [**--help**|**-h**]
 VARLINK_URI
 
 ## DESCRIPTION
-Starts the varlink service that allows varlink clients to interact with podman.
-<!--
-More will go here as the docs and api firm up.
--->
+Starts the varlink service that allows varlink clients to interact with podman.  This should generally be done
+with systemd.  See _Configuration_ below.
 
-**podman [GLOBAL OPTIONS] varlink **
+**podman [GLOBAL OPTIONS] [OPTIONS] varlink VARLINK_URI**
 
 ## GLOBAL OPTIONS
 
 **--help, -h**
   Print usage statement
 
+## OPTIONS
+**--timeout, -t** The time until the varlink session expires in _milliseconds_. The default is 1
+second. A value of `0` means no timeout and the session will not expire.
+
 ## EXAMPLES
 
-  podman varlink unix:/run/podman/io.projectatomic.podman
-<!--
-    TODO: More examples with TCP can be added when that works
-    as well.
--->
+Run the podman varlink service manually and accept the default timeout.
+
+```
+$ podman varlink unix:/run/podman/io.projectatomic.podman
+```
+
+Run the podman varlink service manually with a 5 second timeout.
+
+```
+$ podman varlink --timeout 5000 unix:/run/podman/io.projectatomic.podman
+```
 
 ## CONFIGURATION
 
-Users of the podman varlink service should enable the  io.projectatomic.podman.socket and io.projectatomic.podman.service.
+Users of the podman varlink service should enable the _io.projectatomic.podman.socket_ and _io.projectatomic.podman.service_.
+This is the preferred method for running the varlink service.
 
 You can do this via systemctl
 
-- 
cgit v1.2.3-54-g00ecf