diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/Reference.rst | 2 | ||||
| -rw-r--r-- | docs/source/_static/api.html | 24 | ||||
| -rw-r--r-- | docs/source/markdown/podman-rmi.1.md | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman-service.1.md | 47 | ||||
| -rw-r--r-- | docs/source/markdown/podman-tag.1.md | 12 | ||||
| -rw-r--r-- | docs/source/markdown/podman.1.md | 1 |
6 files changed, 82 insertions, 6 deletions
diff --git a/docs/source/Reference.rst b/docs/source/Reference.rst index 9a771c87f..c6a131bc7 100644 --- a/docs/source/Reference.rst +++ b/docs/source/Reference.rst @@ -1,2 +1,4 @@ Reference ========= + +Check out our new in-development `API documentation <_static/api.html>`_ diff --git a/docs/source/_static/api.html b/docs/source/_static/api.html new file mode 100644 index 000000000..08f55b620 --- /dev/null +++ b/docs/source/_static/api.html @@ -0,0 +1,24 @@ +<!DOCTYPE html> +<html> + <head> + <title>ReDoc</title> + <!-- needed for adaptive design --> + <meta charset="utf-8"/> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet"> + + <!-- + ReDoc doesn't change outer page styles + --> + <style> + body { + margin: 0; + padding: 0; + } + </style> + </head> + <body> + <redoc spec-url='https://storage.googleapis.com/libpod-master-releases/swagger-latest-master.yaml'></redoc> + <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script> + </body> +</html> diff --git a/docs/source/markdown/podman-rmi.1.md b/docs/source/markdown/podman-rmi.1.md index d911ee6cb..3c46bc32c 100644 --- a/docs/source/markdown/podman-rmi.1.md +++ b/docs/source/markdown/podman-rmi.1.md @@ -29,7 +29,7 @@ podman rmi c0ed59d05ff7 Remove an image and its associated containers. ``` podman rmi --force imageID -```` +``` Remove multiple images by their shortened IDs. ``` diff --git a/docs/source/markdown/podman-service.1.md b/docs/source/markdown/podman-service.1.md new file mode 100644 index 000000000..5c55e20d3 --- /dev/null +++ b/docs/source/markdown/podman-service.1.md @@ -0,0 +1,47 @@ +% 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<bbaude@redhat.com> diff --git a/docs/source/markdown/podman-tag.1.md b/docs/source/markdown/podman-tag.1.md index 291d95228..064ea401d 100644 --- a/docs/source/markdown/podman-tag.1.md +++ b/docs/source/markdown/podman-tag.1.md @@ -4,14 +4,15 @@ podman\-tag - Add an additional name to a local image ## SYNOPSIS -**podman tag** *image*[:*tag*] *target-name*[:*tag*] [*options*] +**podman tag** *image*[:*tag*] [*target-name*[:*tag*]...] [*options*] -**podman image tag** *image*[:*tag*] *target-name*[:*tag*] [*options*] +**podman image tag** *image*[:*tag*] [*target-name*[:*tag*]...] [*options*] ## DESCRIPTION -Assigns a new alias to an image. An alias refers to the entire image name, including the optional -*tag* after the `:`. If you do not provide *tag*, podman will default to `latest` for both -the *image* and the *target-name*. +Assigns a new image name to an existing image. A full name refers to the entire +image name, including the optional *tag* after the `:`. If there is no *tag* +provided, then podman will default to `latest` for both the *image* and the +*target-name*. ## OPTIONS @@ -32,4 +33,5 @@ $ podman tag httpd myregistryhost:5000/fedora/httpd:v2 podman(1) ## HISTORY +December 2019, Update description to refer to 'name' instead of 'alias' by Sascha Grunert <sgrunert@suse.com> July 2017, Originally compiled by Ryan Cole <rycole@redhat.com> diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 0c9ec3d1c..6e0eff045 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -191,6 +191,7 @@ 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. | |