github.com/containers/libpod@v1.9.4-0.20220419124438-4284fd425507/docs/source/markdown/podman-varlink.1.md (about)

     1  % podman-varlink(1)
     2  
     3  ## NAME
     4  podman\-varlink - Runs the varlink backend interface
     5  
     6  ## SYNOPSIS
     7  **podman varlink** [*options*] *uri*
     8  
     9  ## DESCRIPTION
    10  Starts the varlink service listening on *uri* that allows varlink clients to interact with podman.  If no *uri* is provided, a default
    11  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
    12  users will have a default *uri* of `$XDG_RUNTIME_DIR/podman/io.podman`.  For example, `unix:/run/user/1000/podman/io.podman`
    13  The varlink service should generally be done with systemd.  See _Configuration_ below.
    14  
    15  
    16  ## OPTIONS
    17  
    18  **--help**, **-h**
    19  
    20    Print usage statement
    21  
    22  **--timeout**, **-t**
    23  
    24  The time until the varlink session expires in _milliseconds_. The default is 1
    25  second. A value of `0` means no timeout and the session will not expire.
    26  
    27  ## EXAMPLES
    28  
    29  Run the podman varlink service accepting all default options.
    30  
    31  ```
    32  $ podman varlink
    33  ```
    34  
    35  
    36  Run the podman varlink service with an alternate URI and accept the default timeout.
    37  
    38  ```
    39  $ podman varlink unix:/tmp/io.podman
    40  ```
    41  
    42  Run the podman varlink service manually with a 5 second timeout.
    43  
    44  ```
    45  $ podman varlink --timeout 5000
    46  ```
    47  
    48  ## CONFIGURATION
    49  
    50  Users of the podman varlink service should enable the _io.podman.socket_ and _io.podman.service_.
    51  This is the preferred method for running the varlink service.
    52  
    53  You can do this via systemctl.
    54  
    55  ```
    56  $ systemctl enable --now io.podman.socket
    57  ```
    58  
    59  ## SEE ALSO
    60  podman(1), systemctl(1)
    61  
    62  ## HISTORY
    63  April 2018, Originally compiled by Brent Baude<bbaude@redhat.com>