podman/docs/podman-wait.1.md at 3bd528e583182b4249f3e6bbd8497a8831d89950

mirror of https://github.com/containers/podman synced 2024-10-19 16:54:07 +00:00

Ed Santiago beb71323b1 man pages - consistency fixes

podman-generate and -play had the wrong NAMEs.

podman-restart and -volume-prune the wrong SYNOPSIS.

All the rest are varying degrees of minor:

  - missing a space between the NAME and description
  - multi-line SYNOPSIS that could be collapsed into one
  - use of UPPER CASE in synopsis instead of *asterisks*
  - improper use of **double asterisks** for options
  - varlink and version were transposed in podman-1
  - fixed inconsistencies between the description in
    the man page and that in the parent manpage. These
    are too numerous for me to fix all.

Added: script that could be used in CI to prevent future
such inconsistencies. It cannot be enabled yet because
there are still 35+ inconsistencies in need of cleaning.

This will be difficult to review on github. I suggest
pulling the PR and running 'git log -1 -p | cdif | less'

'cdif' is a handy tool for colorizing individual diffs between
lines:

   http://kaz-utashiro.github.io/cdif/

There are other such tools; use your favorite. Comparing
without visual highlights may be painful.

I also encourage you to run hack/man-page-checker and suggest
more fixes for the problems it's finding.

Signed-off-by: Ed Santiago <santiago@redhat.com>

2019-03-20 14:37:59 -06:00

1.1 KiB

Raw Blame History

% podman-wait "1"

NAME

podman-wait - Wait on one or more containers to stop and print their exit codes

SYNOPSIS

podman wait [options] container

DESCRIPTION

Waits on one or more containers to stop. The container can be referred to by its name or ID. In the case of multiple containers, podman will wait on each consecutively. After the container stops, the container's return code is printed.

OPTIONS

--help, -h

Print usage statement

--interval, i" Microseconds to wait before polling for completion

--latest, -l

Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods.

The latest option is not supported on the remote client.

EXAMPLES

$ podman wait mywebserver

$ podman wait --latest

$ podman wait 860a4b23

$ podman wait mywebserver myftpserver

HISTORY

September 2017, Originally compiled by Brent Baudebbaude@redhat.com

1.1 KiB Raw Blame History