diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/markdown/links/podman-image-diff.1 | 1 | ||||
| -rw-r--r-- | docs/source/markdown/podman-exec.1.md | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman-history.1.md | 5 | ||||
| -rw-r--r-- | docs/source/markdown/podman-image-diff.1.md | 46 | ||||
| -rw-r--r-- | docs/source/markdown/podman-image.1.md | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman-manifest-push.1.md | 18 | ||||
| -rw-r--r-- | docs/source/markdown/podman-network-inspect.1.md | 4 | ||||
| -rw-r--r-- | docs/source/markdown/podman-pull.1.md | 5 | ||||
| -rw-r--r-- | docs/source/markdown/podman-system-service.1.md | 6 | ||||
| -rw-r--r-- | docs/source/markdown/podman-varlink.1.md | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman-wait.1.md | 3 | ||||
| -rw-r--r-- | docs/source/markdown/podman.1.md | 6 |
12 files changed, 79 insertions, 21 deletions
diff --git a/docs/source/markdown/links/podman-image-diff.1 b/docs/source/markdown/links/podman-image-diff.1 deleted file mode 100644 index ac4881f98..000000000 --- a/docs/source/markdown/links/podman-image-diff.1 +++ /dev/null @@ -1 +0,0 @@ -.so man1/podman-diff.1 diff --git a/docs/source/markdown/podman-exec.1.md b/docs/source/markdown/podman-exec.1.md index b24a1f8aa..f44a3d3d9 100644 --- a/docs/source/markdown/podman-exec.1.md +++ b/docs/source/markdown/podman-exec.1.md @@ -13,7 +13,7 @@ podman\-exec - Execute a command in a running container ## OPTIONS -**--detach** +**--detach**, **-d** Start the exec session, but do not attach to it. The command will run in the background and the exec session will be automatically removed when it completes. The **podman exec** command will print the ID of the exec session and exit immediately after it starts. diff --git a/docs/source/markdown/podman-history.1.md b/docs/source/markdown/podman-history.1.md index 1a8f8906c..26b213af9 100644 --- a/docs/source/markdown/podman-history.1.md +++ b/docs/source/markdown/podman-history.1.md @@ -37,10 +37,13 @@ Display sizes and dates in human readable format (default *true*). Do not truncate the output (default *false*). +**--notruncate** + +Do not truncate the output + **--quiet**, **-q**=*true|false* Print the numeric IDs only (default *false*). - **--format**=*format* Alter the output for a format like 'json' or a Go template. diff --git a/docs/source/markdown/podman-image-diff.1.md b/docs/source/markdown/podman-image-diff.1.md new file mode 100644 index 000000000..1e7397cd8 --- /dev/null +++ b/docs/source/markdown/podman-image-diff.1.md @@ -0,0 +1,46 @@ +% podman-image-diff(1) + +## NAME +podman-image-diff - Inspect changes on an image's filesystem + +## SYNOPSIS +**podman image diff** [*options*] *name* + +## DESCRIPTION +Displays changes on a container or image's filesystem. The container or image will be compared to its parent layer + +## OPTIONS + +**--format** + +Alter the output into a different format. The only valid format for diff is `json`. + +## EXAMPLE + +``` +# podman diff redis:old redis:alpine +C /usr +C /usr/local +C /usr/local/bin +A /usr/local/bin/docker-entrypoint.sh +``` + +``` +# podman diff --format json redis:old redis:alpine +{ + "changed": [ + "/usr", + "/usr/local", + "/usr/local/bin" + ], + "added": [ + "/usr/local/bin/docker-entrypoint.sh" + ] +} +``` + +## SEE ALSO +podman(1) + +## HISTORY +August 2017, Originally compiled by Ryan Cole <rycole@redhat.com> diff --git a/docs/source/markdown/podman-image.1.md b/docs/source/markdown/podman-image.1.md index 1552098ac..dfff57b31 100644 --- a/docs/source/markdown/podman-image.1.md +++ b/docs/source/markdown/podman-image.1.md @@ -14,6 +14,7 @@ The image command allows you to manage images | Command | Man Page | Description | | -------- | ----------------------------------------------- | --------------------------------------------------------------------------- | | build | [podman-build(1)](podman-build.1.md) | Build a container using a Dockerfile. | +| diff | [podman-image-diff(1)](podman-image-diff.1.md) | Inspect changes on an image's filesystem. | | exists | [podman-image-exists(1)](podman-image-exists.1.md) | Check if an image exists in local storage. | | history | [podman-history(1)](podman-history.1.md) | Show the history of an image. | | import | [podman-import(1)](podman-import.1.md) | Import a tarball and save it as a filesystem image. | @@ -25,6 +26,7 @@ The image command allows you to manage images | push | [podman-push(1)](podman-push.1.md) | Push an image from local storage to elsewhere. | | rm | [podman-rmi(1)](podman-rmi.1.md) | Removes one or more locally stored images. | | save | [podman-save(1)](podman-save.1.md) | Save an image to docker-archive or oci. | +| search | [podman-search(1)](podman-search.1.md) | Search a registry for an image. | | sign | [podman-image-sign(1)](podman-image-sign.1.md) | Create a signature for an image. | | tag | [podman-tag(1)](podman-tag.1.md) | Add an additional name to a local image. | | untag | [podman-untag(1)](podman-untag.1.md) | Removes one or more names from a locally-stored image. | diff --git a/docs/source/markdown/podman-manifest-push.1.md b/docs/source/markdown/podman-manifest-push.1.md index 38d0c5904..ab3287a7c 100644 --- a/docs/source/markdown/podman-manifest-push.1.md +++ b/docs/source/markdown/podman-manifest-push.1.md @@ -19,7 +19,7 @@ The list image's ID and the digest of the image's manifest. Push the images mentioned in the manifest list or image index, in addition to the list or index itself. -**--authfile** *path* +**--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. (Not available for remote commands) @@ -27,22 +27,22 @@ If the authorization state is not found there, $HOME/.docker/config.json is chec Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE environment variable. `export REGISTRY_AUTH_FILE=path` -**--cert-dir** *path* +**--cert-dir**=*path* Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands) -**--creds** *creds* +**--creds**=*creds* The [username[:password]] to use to authenticate with the registry if required. If one or both values are not supplied, a command line prompt will appear and the value can be entered. The password is entered without echo. -**--digestfile** *Digestfile* +**--digestfile**=*Digestfile* After copying the image, write the digest of the resulting image to the file. -**--format, -f** +**--format**, **-f**=*format* Manifest list type (oci or v2s2) to use when pushing the list (default is oci). @@ -50,15 +50,19 @@ Manifest list type (oci or v2s2) to use when pushing the list (default is oci). Delete the manifest list or image index from local storage if pushing succeeds. +**--quiet**, **-q** + +When writing the manifest, suppress progress output + **--remove-signatures** Don't copy signatures when pushing images. -**--sign-by** *fingerprint* +**--sign-by**=*fingerprint* Sign the pushed images using the GPG key that matches the specified fingerprint. -**--tls-verify** *bool-value* +**--tls-verify** Require HTTPS and verify certificates when talking to container registries (defaults to true) (Not available for remote commands) diff --git a/docs/source/markdown/podman-network-inspect.1.md b/docs/source/markdown/podman-network-inspect.1.md index ca6875d18..86fa2552e 100644 --- a/docs/source/markdown/podman-network-inspect.1.md +++ b/docs/source/markdown/podman-network-inspect.1.md @@ -10,10 +10,6 @@ podman\-network\-inspect - Displays the raw CNI network configuration for one or Display the raw (JSON format) network configuration. This command is not available for rootless users. ## OPTIONS -**--quiet**, **-q** - -The `quiet` option will restrict the output to only the network names. - **--format**, **-f** Pretty-print networks to JSON or using a Go template. diff --git a/docs/source/markdown/podman-pull.1.md b/docs/source/markdown/podman-pull.1.md index aa558526a..5d941219a 100644 --- a/docs/source/markdown/podman-pull.1.md +++ b/docs/source/markdown/podman-pull.1.md @@ -73,7 +73,10 @@ The [username[:password]] to use to authenticate with the registry if required. If one or both values are not supplied, a command line prompt will appear and the value can be entered. The password is entered without echo. -**--override-arch**=ARCH +**--override-os**=*OS* +Use OS instead of the running OS for choosing images + +**--override-arch**=*ARCH* Override the machine's default architecture of the image to be pulled. For example, `arm`. diff --git a/docs/source/markdown/podman-system-service.1.md b/docs/source/markdown/podman-system-service.1.md index a2fefe4dd..48e595641 100644 --- a/docs/source/markdown/podman-system-service.1.md +++ b/docs/source/markdown/podman-system-service.1.md @@ -15,15 +15,11 @@ example *unix:/run/user/1000/podman/podman.sock*) ## OPTIONS -**--timeout**, **-t** +**--time**, **-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. diff --git a/docs/source/markdown/podman-varlink.1.md b/docs/source/markdown/podman-varlink.1.md index 0d2ab1668..0b04d5ba3 100644 --- a/docs/source/markdown/podman-varlink.1.md +++ b/docs/source/markdown/podman-varlink.1.md @@ -19,7 +19,7 @@ The varlink service should generally be done with systemd. See _Configuration_ Print usage statement -**--timeout**, **-t** +**--time**, **-t** The time until the varlink session expires in _milliseconds_. The default is 1 second. A value of `0` means no timeout and the session will not expire. diff --git a/docs/source/markdown/podman-wait.1.md b/docs/source/markdown/podman-wait.1.md index ce1c70a5f..886bbc55b 100644 --- a/docs/source/markdown/podman-wait.1.md +++ b/docs/source/markdown/podman-wait.1.md @@ -15,6 +15,9 @@ After the container stops, the container's return code is printed. ## OPTIONS +**--condition**=*state* +Condition to wait on (default "stopped") + **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 6bac0cc9d..02f23e6cc 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -58,6 +58,9 @@ Podman and libpod currently support an additional `precreate` state which is cal **WARNING**: the `precreate` hook lets you do powerful things, such as adding additional mounts to the runtime configuration. That power also makes it easy to break things. Before reporting libpod errors, try running your container with `precreate` hooks disabled to see if the problem is due to one of your hooks. +**--identity**=*path* +Path to SSH identity file + **--log-level**=*level* Log messages above specified level: debug, info, warn, error (default), fatal or panic (default: "error") @@ -70,6 +73,9 @@ When namespace is set, created containers and pods will join the given namespace **--network-cmd-path**=*path* Path to the command binary to use for setting up a network. It is currently only used for setting up a slirp4netns network. If "" is used then the binary is looked up using the $PATH environment variable. +**--remote**, **-r**=*url* +URL to access Podman service (default "unix:/run/user/3267/podman/podman.sock") + **--root**=*value* Storage root dir in which data, including images, is stored (default: "/var/lib/containers/storage" for UID 0, "$HOME/.local/share/containers/storage" for other users). |