Files
podman/docs/source/markdown/podman-system-service.1.md
Paul Holzinger 52a8694705 Add anchors for flag names on docs.podman.io
Change the docs markdown so that flag names will be h4 headers.
Sphinx will automatically add anchors to headers. Add css to
make sure the flag names are not to big compared to the text.

The man pages also still renders fine but it looks a bit different.

Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
2020-11-10 15:27:08 +01:00

1.5 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 rootfull 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.

OPTIONS

--time, -t

The time until the session expires in seconds. The default is 5 seconds. A value of 0 means no timeout and 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 --timeout 5000

SEE ALSO

podman(1), podman-system-service(1), podman-system-connection(1)

HISTORY

January 2020, Originally compiled by Brent Baudebbaude@redhat.com