mirror of
https://github.com/containers/podman.git
synced 2025-06-03 12:17:13 +08:00
8d5da78b0e
Went through the docs and fixed the alignment so they all match up and look readable when doing 'man podman [command]" Signed-off-by: umohnani8 <umohnani@redhat.com> Closes: #943 Approved by: rhatdan
56 lines
1.3 KiB
Markdown
56 lines
1.3 KiB
Markdown
% podman-varlink "1"
|
|
|
|
## NAME
|
|
podman\-varlink - Runs the varlink backend interface
|
|
|
|
## SYNOPSIS
|
|
**podman varlink** [OPTIONS]
|
|
[**--help**|**-h**]
|
|
VARLINK_URI
|
|
|
|
## DESCRIPTION
|
|
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] [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
|
|
|
|
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_.
|
|
This is the preferred method for running the varlink service.
|
|
|
|
You can do this via systemctl
|
|
|
|
systemctl enable --now io.projectatomic.podman.socket
|
|
|
|
## SEE ALSO
|
|
podman(1), systemctl(1)
|
|
|
|
## HISTORY
|
|
April 2018, Originally compiled by Brent Baude<bbaude@redhat.com>
|