From 41b735af053b85aeacc65e45d068246cad789cd7 Mon Sep 17 00:00:00 2001 From: Matthew Heon Date: Thu, 6 Feb 2020 13:19:50 -0500 Subject: Move podman-service to podman-system-service Fixes #5108 Signed-off-by: Matthew Heon --- docs/source/markdown/podman-service.1.md | 47 ------------------------- docs/source/markdown/podman-system-service.1.md | 47 +++++++++++++++++++++++++ docs/source/markdown/podman-system.1.md | 2 ++ docs/source/markdown/podman.1.md | 1 - 4 files changed, 49 insertions(+), 48 deletions(-) delete mode 100644 docs/source/markdown/podman-service.1.md create mode 100644 docs/source/markdown/podman-system-service.1.md (limited to 'docs') diff --git a/docs/source/markdown/podman-service.1.md b/docs/source/markdown/podman-service.1.md deleted file mode 100644 index 5c55e20d3..000000000 --- a/docs/source/markdown/podman-service.1.md +++ /dev/null @@ -1,47 +0,0 @@ -% podman-service(1) - -## NAME -podman\-service - Run an API service - -## SYNOPSIS -**podman service** [*options*] - -## DESCRIPTION -The **podman 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*) - -## OPTIONS - -**--timeout**, **-t** - -The time until the session expires in _milliseconds_. The default is 1 -second. A value of `0` means no timeout and the session will not expire. - -**--varlink** - -Use the varlink protocol instead of the REST-based protocol. This option will be deprecated in the future. - -**--help**, **-h** - -Print usage statement. - -## EXAMPLES - -Run an API listening for 5 seconds using the default socket. -``` -podman service --timeout 5000 -``` - -Run the podman varlink service with an alternate URI and accept the default timeout. -``` -$ podman service --varlink unix:/tmp/io.podman -``` - -## SEE ALSO -podman(1), podman-varlink(1) - -## HISTORY -January 2020, Originally compiled by Brent Baude diff --git a/docs/source/markdown/podman-system-service.1.md b/docs/source/markdown/podman-system-service.1.md new file mode 100644 index 000000000..a71ce9dc0 --- /dev/null +++ b/docs/source/markdown/podman-system-service.1.md @@ -0,0 +1,47 @@ +% 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*) + +## OPTIONS + +**--timeout**, **-t** + +The time until the session expires in _milliseconds_. The default is 1 +second. A value of `0` means no timeout and the session will not expire. + +**--varlink** + +Use the varlink protocol instead of the REST-based protocol. This option will be deprecated in the future. + +**--help**, **-h** + +Print usage statement. + +## EXAMPLES + +Run an API listening for 5 seconds using the default socket. +``` +podman service --timeout 5000 +``` + +Run the podman varlink service with an alternate URI and accept the default timeout. +``` +$ podman service --varlink unix:/tmp/io.podman +``` + +## SEE ALSO +podman(1), podman-varlink(1) + +## HISTORY +January 2020, Originally compiled by Brent Baude diff --git a/docs/source/markdown/podman-system.1.md b/docs/source/markdown/podman-system.1.md index 1af97290d..5f163c6f0 100644 --- a/docs/source/markdown/podman-system.1.md +++ b/docs/source/markdown/podman-system.1.md @@ -19,6 +19,8 @@ The system command allows you to manage the podman systems | prune | [podman-system-prune(1)](podman-system-prune.1.md) | Remove all unused container, image and volume data. | | renumber | [podman-system-renumber(1)](podman-system-renumber.1.md)| Migrate lock numbers to handle a change in maximum number of locks. | | reset | [podman-system-reset(1)](podman-system-reset.1.md) | Reset storage back to initial state. | +| service | [podman-service(1)](podman-system-service.1.md) | Run an API service | + ## SEE ALSO podman(1) diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index af0e55925..853b5ecec 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -191,7 +191,6 @@ the exit codes follow the `chroot` standard, see below: | [podman-rmi(1)](podman-rmi.1.md) | Removes one or more locally stored images. | | [podman-run(1)](podman-run.1.md) | Run a command in a new container. | | [podman-save(1)](podman-save.1.md) | Save an image to a container archive. | -| [podman-service(1)](podman-service.1.md) | Run an API service | | [podman-search(1)](podman-search.1.md) | Search a registry for an image. | | [podman-start(1)](podman-start.1.md) | Start one or more containers. | | [podman-stats(1)](podman-stats.1.md) | Display a live stream of one or more container's resource usage statistics. | -- cgit v1.2.3-54-g00ecf