63a3b8a093
The rest of this document claims that the argument is called '--time', not '--timeout', and that the value is expressed in seconds. As currently written, the example (which ostensibly runs the API service for 5 seconds) uses the '--timeout' spelling (which actually does work, as an undocumented alias) and passes a value of '5000', which is more than an hour. Fix both. [NO TESTS NEEDED] as this is a simple documentation change. Signed-off-by: Will Thompson <wjt@endlessos.org>
1.7 KiB
% podman-service(1)
NAME
podman-system-service - Run an API service
SYNOPSIS
podman system service [options]
DESCRIPTION
The podman system service command creates a listening service that will answer API calls for Podman. You may optionally provide an endpoint for the API in URI form. For example, unix://tmp/foobar.sock or tcp:localhost:8080. If no endpoint is provided, defaults will be used. The default endpoint for a rootful service is unix:/run/podman/podman.sock and rootless is unix:/$XDG_RUNTIME_DIR/podman/podman.sock (for example unix:/run/user/1000/podman/podman.sock)
The REST API provided by podman system service is split into two parts: a compatibility layer offering support for the Docker v1.40 API, and a Podman-native Libpod layer. Documentation for the latter is available at https://docs.podman.io/en/latest/_static/api.html. Both APIs are versioned, but the server will not reject requests with an unsupported version set.
Note: The default systemd unit files (system and user) change the log-level option to info from error. This change provides additional information on each API call.
OPTIONS
--time, -t
The time until the session expires in seconds. The default is 5
seconds. A value of 0 means no timeout, therefore the session will not expire.
--help, -h
Print usage statement.
EXAMPLES
Run an API listening for 5 seconds using the default socket.
podman system service --time 5
SEE ALSO
podman(1), podman-system-service(1), podman-system-connection(1)
HISTORY
January 2020, Originally compiled by Brent Baude <bbaude@redhat.com>
November 2020, Updated by Jhon Honce (jhonce at redhat dot com)