diff options
| author | baude <bbaude@redhat.com> | 2019-10-24 14:54:57 -0500 |
|---|---|---|
| committer | baude <bbaude@redhat.com> | 2019-10-31 12:31:39 -0500 |
| commit | 52b92023edeba3a5e2c466d92d742e54b14a85cb (patch) | |
| tree | 44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/podman-varlink.1.md | |
| parent | 5af166ff513265b17aee92a9ce3a1522090d7dec (diff) | |
| download | podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2 podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip | |
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man
pages now exist in docs/source/man and the sphinx make files exists in
docs.
Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/podman-varlink.1.md')
| -rw-r--r-- | docs/podman-varlink.1.md | 63 |
1 files changed, 0 insertions, 63 deletions
diff --git a/docs/podman-varlink.1.md b/docs/podman-varlink.1.md deleted file mode 100644 index 0d2ab1668..000000000 --- a/docs/podman-varlink.1.md +++ /dev/null @@ -1,63 +0,0 @@ -% podman-varlink(1) - -## NAME -podman\-varlink - Runs the varlink backend interface - -## SYNOPSIS -**podman varlink** [*options*] *uri* - -## DESCRIPTION -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. - - -## OPTIONS - -**--help**, **-h** - - Print usage statement - -**--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 - -Run the podman varlink service accepting all default options. - -``` -$ 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 -``` - -## CONFIGURATION - -Users of the podman varlink service should enable the _io.podman.socket_ and _io.podman.service_. -This is the preferred method for running the varlink service. - -You can do this via systemctl. - -``` -$ systemctl enable --now io.podman.socket -``` - -## SEE ALSO -podman(1), systemctl(1) - -## HISTORY -April 2018, Originally compiled by Brent Baude<bbaude@redhat.com> |