mirror of
https://github.com/containers/podman.git
synced 2025-12-08 14:48:48 +08:00
beb71323b1
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>
40 lines
765 B
Markdown
40 lines
765 B
Markdown
% podman-healthcheck-run(1)
|
|
|
|
## NAME
|
|
podman\-healthcheck\-run - Run a container healthcheck
|
|
|
|
## SYNOPSIS
|
|
**podman healthcheck run** [*options*] *container*
|
|
|
|
## DESCRIPTION
|
|
|
|
Runs the healthcheck command defined in a running container manually. The resulting error codes are defined
|
|
as follows:
|
|
|
|
* 0 = healthcheck command succeeded
|
|
* 1 = healthcheck command failed
|
|
* 125 = an error has occurred
|
|
|
|
Possible errors that can occur during the healthcheck are:
|
|
* unable to find the container
|
|
* container has no defined healthcheck
|
|
* container is not running
|
|
|
|
## OPTIONS
|
|
**--help**
|
|
|
|
Print usage statement
|
|
|
|
|
|
## EXAMPLES
|
|
|
|
```
|
|
$ podman healtcheck run mywebapp
|
|
```
|
|
|
|
## SEE ALSO
|
|
podman-healthcheck(1)
|
|
|
|
## HISTORY
|
|
Feb 2019, Originally compiled by Brent Baude <bbaude@redhat.com>
|