summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRobert P. J. Day <rpjday@crashcourse.ca>2019-03-31 04:51:46 -0400
committerRobert P. J. Day <rpjday@crashcourse.ca>2019-03-31 04:51:46 -0400
commit6ef64b90e4605e095809919256adf3b8d6093f6a (patch)
treee02edf3c59428210ada633ced331bf20af12130c /docs
parent833204d63bc01b52eed87b19911419169dfd97ad (diff)
downloadpodman-6ef64b90e4605e095809919256adf3b8d6093f6a.tar.gz
podman-6ef64b90e4605e095809919256adf3b8d6093f6a.tar.bz2
podman-6ef64b90e4605e095809919256adf3b8d6093f6a.zip
docs/podman*.md: fix numerous option typos and spacing errors
Cursory examination of man pages shows a number of typos: - missing hyphens - missing blank line - longer option should precede shorter option This is not an extensive fix, there's still a lot that could be cleaned up. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-container-checkpoint.1.md2
-rw-r--r--docs/podman-container-restore.1.md2
-rw-r--r--docs/podman-container-runlabel.1.md7
-rw-r--r--docs/podman-generate-kube.1.md5
-rw-r--r--docs/podman-pod-kill.1.md2
-rw-r--r--docs/podman-pod-pause.1.md2
-rw-r--r--docs/podman-pod-rm.1.md4
-rw-r--r--docs/podman-pod-stop.1.md2
-rw-r--r--docs/podman-pod-unpause.1.md2
-rw-r--r--docs/podman-port.1.md2
-rw-r--r--docs/podman-rm.1.md4
-rw-r--r--docs/podman-volume-inspect.1.md2
-rw-r--r--docs/podman-wait.1.md2
13 files changed, 20 insertions, 18 deletions
diff --git a/docs/podman-container-checkpoint.1.md b/docs/podman-container-checkpoint.1.md
index 666dbbb80..79dc12261 100644
--- a/docs/podman-container-checkpoint.1.md
+++ b/docs/podman-container-checkpoint.1.md
@@ -10,7 +10,7 @@ podman\-container\-checkpoint - Checkpoints one or more running containers
Checkpoints all the processes in one or more containers. You may use container IDs or names as input.
## OPTIONS
-**-k**, **--keep**
+**--keep**, **-k**
Keep all temporary log and statistics files created by CRIU during checkpointing. These files
are not deleted if checkpointing fails for further debugging. If checkpointing succeeds these
diff --git a/docs/podman-container-restore.1.md b/docs/podman-container-restore.1.md
index e47d585cc..e41f7c1d8 100644
--- a/docs/podman-container-restore.1.md
+++ b/docs/podman-container-restore.1.md
@@ -10,7 +10,7 @@ podman\-container\-restore - Restores one or more running containers
Restores a container from a checkpoint. You may use container IDs or names as input.
## OPTIONS
-**-k**, **--keep**
+**--keep**, **-k**
Keep all temporary log and statistics files created by CRIU during
checkpointing as well as restoring. These files are not deleted if restoring
diff --git a/docs/podman-container-runlabel.1.md b/docs/podman-container-runlabel.1.md
index 7fa9805e6..39d798804 100644
--- a/docs/podman-container-runlabel.1.md
+++ b/docs/podman-container-runlabel.1.md
@@ -76,11 +76,12 @@ The [username[:password]] to use to authenticate with the registry if required.
If one or both values are not supplied, a command line prompt will appear and the
value can be entered. The password is entered without echo.
-**-h** **--help**
+**--help** **-h**
Print usage statement
-**-n** **--name**=""
- Use this name for creating content for the container. NAME will default to the IMAGENAME if it is not specified.
+**--name** **-n**=""
+
+Use this name for creating content for the container. NAME will default to the IMAGENAME if it is not specified.
**--quiet, -q**
diff --git a/docs/podman-generate-kube.1.md b/docs/podman-generate-kube.1.md
index b6fa78606..99029be90 100644
--- a/docs/podman-generate-kube.1.md
+++ b/docs/podman-generate-kube.1.md
@@ -5,7 +5,7 @@
podman-generate-kube - Generate Kubernetes YAML
# SYNOPSIS
-**podman generate kube** [*-s*][*--service*] *container* | *pod*
+**podman generate kube** [*-s*|*--service*] *container* | *pod*
# DESCRIPTION
**podman generate kube** will generate Kubernetes Pod YAML (v1 specification) from a podman container or pod. Whether
@@ -20,7 +20,8 @@ Note that the generated Kubernetes YAML file can be used to re-run the deploymen
# OPTIONS:
-**s** **--service**
+**--service** **-s**
+
Generate a Kubernetes service object in addition to the Pods.
## Examples ##
diff --git a/docs/podman-pod-kill.1.md b/docs/podman-pod-kill.1.md
index 2a863d3d9..d617acd66 100644
--- a/docs/podman-pod-kill.1.md
+++ b/docs/podman-pod-kill.1.md
@@ -21,7 +21,7 @@ to run pods such as CRI-O, the last started pod could be from either of those me
The latest option is not supported on the remote client.
-**--signal, s**
+**--signal, -s**
Signal to send to the containers in the pod. For more information on Linux signals, refer to *man signal(7)*.
diff --git a/docs/podman-pod-pause.1.md b/docs/podman-pod-pause.1.md
index 418a9ee2a..0ed63a7f8 100644
--- a/docs/podman-pod-pause.1.md
+++ b/docs/podman-pod-pause.1.md
@@ -11,7 +11,7 @@ Pauses all the running processes in the containers of one or more pods. You may
## OPTIONS
-**--all, a**
+**--all, -a**
Pause all pods.
diff --git a/docs/podman-pod-rm.1.md b/docs/podman-pod-rm.1.md
index aa26a1bbb..7cd7c26bc 100644
--- a/docs/podman-pod-rm.1.md
+++ b/docs/podman-pod-rm.1.md
@@ -11,7 +11,7 @@ podman\-pod\-rm - Remove one or more pods
## OPTIONS
-**--all, a**
+**--all, -a**
Remove all pods. Can be used in conjunction with \-f as well.
@@ -21,7 +21,7 @@ Instead of providing the pod name or ID, remove the last created pod.
The latest option is not supported on the remote client.
-**--force, f**
+**--force, -f**
Stop running containers and delete all stopped containers before removal of pod.
diff --git a/docs/podman-pod-stop.1.md b/docs/podman-pod-stop.1.md
index 338e04d67..787c672bd 100644
--- a/docs/podman-pod-stop.1.md
+++ b/docs/podman-pod-stop.1.md
@@ -21,7 +21,7 @@ Instead of providing the pod name or ID, stop the last created pod.
The latest option is not supported on the remote client.
-**--timeout, --time, t**
+**--timeout, --time, -t**
Timeout to wait before forcibly stopping the containers in the pod.
diff --git a/docs/podman-pod-unpause.1.md b/docs/podman-pod-unpause.1.md
index 1004e09f9..8930fde32 100644
--- a/docs/podman-pod-unpause.1.md
+++ b/docs/podman-pod-unpause.1.md
@@ -11,7 +11,7 @@ Unpauses all the paused processes in the containers of one or more pods. You ma
## OPTIONS
-**--all, a**
+**--all, -a**
Unpause all pods.
diff --git a/docs/podman-port.1.md b/docs/podman-port.1.md
index 020a25d32..5adfae5f3 100644
--- a/docs/podman-port.1.md
+++ b/docs/podman-port.1.md
@@ -11,7 +11,7 @@ List port mappings for the *container* or lookup the public-facing port that is
## OPTIONS
-**--all, a**
+**--all, -a**
List all known port mappings for running containers. When using this option, you cannot pass any container names
or private ports/protocols as filters.
diff --git a/docs/podman-rm.1.md b/docs/podman-rm.1.md
index dc1729188..8010a45e8 100644
--- a/docs/podman-rm.1.md
+++ b/docs/podman-rm.1.md
@@ -13,11 +13,11 @@ podman\-container\-rm (podman\-rm) - Remove one or more containers
## OPTIONS
-**--all, a**
+**--all, -a**
Remove all containers. Can be used in conjunction with -f as well.
-**--force, f**
+**--force, -f**
Force the removal of running and paused containers. Forcing a containers removal also
removes containers from container storage even if the container is not known to podman.
diff --git a/docs/podman-volume-inspect.1.md b/docs/podman-volume-inspect.1.md
index c22c80bb7..88cc3cf3e 100644
--- a/docs/podman-volume-inspect.1.md
+++ b/docs/podman-volume-inspect.1.md
@@ -15,7 +15,7 @@ existing volumes, use the **--all** flag.
## OPTIONS
-**-a**, **--all**=""
+**-a**, **--all**
Inspect all volumes.
diff --git a/docs/podman-wait.1.md b/docs/podman-wait.1.md
index 2d145527b..ed5e11ac7 100644
--- a/docs/podman-wait.1.md
+++ b/docs/podman-wait.1.md
@@ -17,7 +17,7 @@ After the container stops, the container's return code is printed.
Print usage statement
-**--interval, i**"
+**--interval, -i**"
Microseconds to wait before polling for completion
**--latest, -l**