Files
podman/docs/source/markdown/podman-healthcheck-run.1.md
Paul Holzinger bc48211924 Fix long option format on docs.podman.io
Escape the two dashes, otherwise they are combined into one long dash.
I tested that this change is safe and still renders correctly on github
and with the man pages.

This commit also contains a small change to make it build locally.
Assuming you have the dependencies installed you can do:
```
cd docs
make html
```
Preview the html files in docs/build/html with
`python -m http.server 8000 --directory build/html`.

Fixes containers/podman.io#373

Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
2021-03-29 14:38:25 +02:00

40 lines
761 B
Markdown

% podman-healthcheck-run(1)
## NAME
podman\-healthcheck\-run - Run a container healthcheck
## SYNOPSIS
**podman healthcheck run** *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 healthcheck run mywebapp
```
## SEE ALSO
podman-healthcheck(1)
## HISTORY
Feb 2019, Originally compiled by Brent Baude <bbaude@redhat.com>