From 52b92023edeba3a5e2c466d92d742e54b14a85cb Mon Sep 17 00:00:00 2001 From: baude Date: Thu, 24 Oct 2019 14:54:57 -0500 Subject: Restructure documentation dir Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude --- docs/source/man/podman-healthcheck-run.1.md | 39 +++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/source/man/podman-healthcheck-run.1.md (limited to 'docs/source/man/podman-healthcheck-run.1.md') diff --git a/docs/source/man/podman-healthcheck-run.1.md b/docs/source/man/podman-healthcheck-run.1.md new file mode 100644 index 000000000..21f2d9b20 --- /dev/null +++ b/docs/source/man/podman-healthcheck-run.1.md @@ -0,0 +1,39 @@ +% 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 healthcheck run mywebapp +``` + +## SEE ALSO +podman-healthcheck(1) + +## HISTORY +Feb 2019, Originally compiled by Brent Baude -- cgit v1.2.3-54-g00ecf