Merge pull request #3076 from baude/healthcheckman

podman-run|create man updates

2 files changed, 74 insertions, 60 deletions

diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md
index 851f5cf3d..da5750209 100644
--- a/docs/podman-create.1.md
+++ b/docs/podman-create.1.md
@@ -244,26 +244,6 @@ inside of the container.
 
 Read in a line delimited file of environment variables
 
-**--http-proxy**=*true*|*false*
-
-By default proxy environment variables are passed into the container if set
-for the podman process.  This can be disabled by setting the `--http-proxy`
-option to `false`.  The environment variables passed in include `http_proxy`,
-`https_proxy`, `ftp_proxy`, `no_proxy`, and also the upper case versions of
-those.  This option is only needed when the host system must use a proxy but
-the container should not use any proxy.  Proxy environment variables specified
-for the container in any other way will override the values that would have
-been passed thru from the host.  (Other ways to specify the proxy for the
-container include passing the values with the `--env` flag, or hardcoding the
-proxy environment at container build time.)
-
-For example, to disable passing these environment variables from host to
-container:
-
-`--http-proxy=false`
-
-Defaults to `true`
-
 **--expose**=[]
 
 Expose a port, or a range of ports (e.g. --expose=3300-3310) to set up port redirection
@@ -281,20 +261,27 @@ Add additional groups to run as
 
 **--healthcheck**=""
 
-Set or alter a healthcheck for a container.  The value must be of the format of:
+Set or alter a healthcheck command for a container. The command is a command to be executed inside your
+container that determines your container health.  The command is required for other healthcheck options
+to be applied.  A value of `none` disables existing healthchecks.
+
+**--healthcheck-interval**=""
+
+Set an interval for the healthchecks (a value of `disable` results in no automatic timer setup) (default "30s")
 
- `[OPTIONS] CMD command`
+**--healthcheck-retries=**
 
- where options can be any of the follow:
- * --interval=DURATION (default: 30s)
- * --timeout=DURATION (default: 30s)
- * --start-period=DURATION (default: 0s)
- * --retries=N (default: 3)
+The number of retries allowed before a healthcheck is considered to be unhealthy.  The default value is `3`.
 
-Note: options are *not* required.
+**--healthcheck-start-period**=""
 
-The command is a command to be executed inside your container that determines your container health.  The
-command is required.
+The initialization time needed for a container to bootstrap. The value can be expressed in time format like
+`2m3s`.  The default value is `0s`
+
+**--healthcheck-timeout**=""
+
+The maximum time allowed to complete the healthcheck before an interval is considered failed.  Like start-period, the
+value can be expressed in a time format such as `1m22s`.  The default value is `30s`.
 
 **--hostname**=""
 
@@ -306,6 +293,26 @@ Sets the container host name that is available inside the container.
 
 Print usage statement
 
+**--http-proxy**=*true*|*false*
+
+By default proxy environment variables are passed into the container if set
+for the podman process.  This can be disabled by setting the `--http-proxy`
+option to `false`.  The environment variables passed in include `http_proxy`,
+`https_proxy`, `ftp_proxy`, `no_proxy`, and also the upper case versions of
+those.  This option is only needed when the host system must use a proxy but
+the container should not use any proxy.  Proxy environment variables specified
+for the container in any other way will override the values that would have
+been passed thru from the host.  (Other ways to specify the proxy for the
+container include passing the values with the `--env` flag, or hardcoding the
+proxy environment at container build time.)
+
+For example, to disable passing these environment variables from host to
+container:
+
+`--http-proxy=false`
+
+Defaults to `true`
+
 **--image-volume**, **builtin-volume**=*bind*|*tmpfs*|*ignore*
 
 Tells podman how to handle the builtin image volumes. The options are: 'bind', 'tmpfs', or 'ignore' (default 'bind').
diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md
index db90ce50e..00b1a70c6 100644
--- a/docs/podman-run.1.md
+++ b/docs/podman-run.1.md
@@ -251,26 +251,6 @@ inside of the container.
 
 Read in a line delimited file of environment variables
 
-**--http-proxy**=*true*|*false*
-
-By default proxy environment variables are passed into the container if set
-for the podman process.  This can be disabled by setting the `--http-proxy`
-option to `false`.  The environment variables passed in include `http_proxy`,
-`https_proxy`, `ftp_proxy`, `no_proxy`, and also the upper case versions of
-those.  This option is only needed when the host system must use a proxy but
-the container should not use any proxy.  Proxy environment variables specified
-for the container in any other way will override the values that would have
-been passed thru from the host.  (Other ways to specify the proxy for the
-container include passing the values with the `--env` flag, or hardcoding the
-proxy environment at container build time.)
-
-For example, to disable passing these environment variables from host to
-container:
-
-`--http-proxy=false`
-
-Defaults to `true`
-
 **--expose**=[]
 
 Expose a port, or a range of ports (e.g. --expose=3300-3310) to set up port redirection
@@ -289,20 +269,27 @@ Add additional groups to run as
 
 **--healthcheck**=""
 
-Set or alter a healthcheck for a container.  The value must be of the format of:
+Set or alter a healthcheck command for a container. The command is a command to be executed inside your
+container that determines your container health.  The command is required for other healthcheck options
+to be applied.  A value of `none` disables existing healthchecks.
+
+**--healthcheck-interval**=""
+
+Set an interval for the healthchecks (a value of `disable` results in no automatic timer setup) (default "30s")
 
- `[OPTIONS] CMD command`
+**--healthcheck-retries=**
 
- where options can be any of the follow:
- * --interval=DURATION (default: 30s)
- * --timeout=DURATION (default: 30s)
- * --start-period=DURATION (default: 0s)
- * --retries=N (default: 3)
+The number of retries allowed before a healthcheck is considered to be unhealthy.  The default value is `3`.
 
-Note: options are *not* required.
+**--healthcheck-start-period**=""
 
-The command is a command to be executed inside your container that determines your container health.  The
-command is required.
+The initialization time needed for a container to bootstrap. The value can be expressed in time format like
+`2m3s`.  The default value is `0s`
+
+**--healthcheck-timeout**=""
+
+The maximum time allowed to complete the healthcheck before an interval is considered failed.  Like start-period, the
+value can be expressed in a time format such as `1m22s`.  The default value is `30s`.
 
 **--hostname**=""
 
@@ -314,6 +301,26 @@ Sets the container host name that is available inside the container.
 
 Print usage statement
 
+**--http-proxy**=*true*|*false*
+
+By default proxy environment variables are passed into the container if set
+for the podman process.  This can be disabled by setting the `--http-proxy`
+option to `false`.  The environment variables passed in include `http_proxy`,
+`https_proxy`, `ftp_proxy`, `no_proxy`, and also the upper case versions of
+those.  This option is only needed when the host system must use a proxy but
+the container should not use any proxy.  Proxy environment variables specified
+for the container in any other way will override the values that would have
+been passed thru from the host.  (Other ways to specify the proxy for the
+container include passing the values with the `--env` flag, or hardcoding the
+proxy environment at container build time.)
+
+For example, to disable passing these environment variables from host to
+container:
+
+`--http-proxy=false`
+
+Defaults to `true`
+
 **--image-volume**, **builtin-volume**=*bind*|*tmpfs*|*ignore*
 
 Tells podman how to handle the builtin image volumes.