podman/docs/podman-varlink.1.md
Valentin Rothberg 1c0cd0796a docs: consistent format for example
All bash examples are now placed in a code section (```).  The PS1
prompt is set to `$`.

Signed-off-by: Valentin Rothberg <vrothberg@suse.com>

Closes: #1375
Approved by: rhatdan
2018-08-30 16:51:56 +00:00

1.2 KiB

% 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. This should generally be done with systemd. See Configuration below.

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

Run the podman varlink service manually and accept the default timeout.

$ podman varlink unix:/run/podman/io.podman

Run the podman varlink service manually with a 5 second timeout.

$ podman varlink --timeout 5000 unix:/run/podman/io.podman

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 Baudebbaude@redhat.com