aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-10-04 11:34:38 -0600
committerEd Santiago <santiago@redhat.com>2022-10-05 09:59:01 -0600
commit51c3578415477df87ce531c43d4eca3a3013a230 (patch)
treee4f0cc8894904b9e5f6a008fd2e650d56ea79f88 /docs/source/markdown
parentcc609e52bdb641a8c1b1d9c183cac12db142da61 (diff)
downloadpodman-51c3578415477df87ce531c43d4eca3a3013a230.tar.gz
podman-51c3578415477df87ce531c43d4eca3a3013a230.tar.bz2
podman-51c3578415477df87ce531c43d4eca3a3013a230.zip
Man pages: refactor common options: --time
Only in container/pod stop/rm/restart man pages; the others (volume-rm, network-rm, system-service) are too different to refactor. Mostly an easy one, no manual reconciliation needed apart from the pod-vs-container difference. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown')
-rw-r--r--docs/source/markdown/.gitignore1
-rw-r--r--docs/source/markdown/options/time.md3
-rw-r--r--docs/source/markdown/podman-pod-rm.1.md.in4
-rw-r--r--docs/source/markdown/podman-pod-stop.1.md.in4
-rw-r--r--docs/source/markdown/podman-restart.1.md.in (renamed from docs/source/markdown/podman-restart.1.md)4
-rw-r--r--docs/source/markdown/podman-rm.1.md.in4
-rw-r--r--docs/source/markdown/podman-stop.1.md.in4
7 files changed, 11 insertions, 13 deletions
diff --git a/docs/source/markdown/.gitignore b/docs/source/markdown/.gitignore
index f5c4c2e24..584e88e75 100644
--- a/docs/source/markdown/.gitignore
+++ b/docs/source/markdown/.gitignore
@@ -26,6 +26,7 @@ podman-pod-stats.1.md
podman-pod-stop.1.md
podman-pull.1.md
podman-push.1.md
+podman-restart.1.md
podman-rm.1.md
podman-run.1.md
podman-search.1.md
diff --git a/docs/source/markdown/options/time.md b/docs/source/markdown/options/time.md
new file mode 100644
index 000000000..85d571d18
--- /dev/null
+++ b/docs/source/markdown/options/time.md
@@ -0,0 +1,3 @@
+#### **--time**, **-t**=*seconds*
+
+Seconds to wait before forcibly stopping <<the container|running containers within the pod>>.
diff --git a/docs/source/markdown/podman-pod-rm.1.md.in b/docs/source/markdown/podman-pod-rm.1.md.in
index 5d708b65c..abfa97f5b 100644
--- a/docs/source/markdown/podman-pod-rm.1.md.in
+++ b/docs/source/markdown/podman-pod-rm.1.md.in
@@ -27,9 +27,9 @@ Instead of providing the pod name or ID, remove the last created pod. (This opti
@@option pod-id-file.pod
-#### **--time**, **-t**=*seconds*
+@@option time
-Seconds to wait before forcibly stopping running containers within the pod. The --force option must be specified to use the --time option.
+The --force option must be specified to use the --time option.
## EXAMPLE
diff --git a/docs/source/markdown/podman-pod-stop.1.md.in b/docs/source/markdown/podman-pod-stop.1.md.in
index 575a5fa30..e6ffa4f76 100644
--- a/docs/source/markdown/podman-pod-stop.1.md.in
+++ b/docs/source/markdown/podman-pod-stop.1.md.in
@@ -23,9 +23,7 @@ Instead of providing the pod name or ID, stop the last created pod. (This option
@@option pod-id-file.pod
-#### **--time**, **-t**=*seconds*
-
-Seconds to wait before forcibly stopping the containers in the pod.
+@@option time
## EXAMPLE
diff --git a/docs/source/markdown/podman-restart.1.md b/docs/source/markdown/podman-restart.1.md.in
index 513b9a1bf..71543ef6a 100644
--- a/docs/source/markdown/podman-restart.1.md
+++ b/docs/source/markdown/podman-restart.1.md.in
@@ -56,9 +56,7 @@ to run containers such as CRI-O, the last started container could be from either
Restart all containers that are already in the *running* state.
-#### **--time**, **-t**=*seconds*
-
-Seconds to wait before forcibly stopping the container.
+@@option time
## EXAMPLES
diff --git a/docs/source/markdown/podman-rm.1.md.in b/docs/source/markdown/podman-rm.1.md.in
index 6f4366ce9..b3bff4934 100644
--- a/docs/source/markdown/podman-rm.1.md.in
+++ b/docs/source/markdown/podman-rm.1.md.in
@@ -63,9 +63,9 @@ whose OCI runtime has become unavailable.
Instead of providing the container name or ID, use the last created container. If you use methods other than Podman
to run containers such as CRI-O, the last started container could be from either of those methods. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
-#### **--time**, **-t**=*seconds*
+@@option time
-Seconds to wait before forcibly stopping the container. The --force option must be specified to use the --time option.
+The --force option must be specified to use the --time option.
#### **--volumes**, **-v**
diff --git a/docs/source/markdown/podman-stop.1.md.in b/docs/source/markdown/podman-stop.1.md.in
index 7b32ca4b0..ec5fd79b6 100644
--- a/docs/source/markdown/podman-stop.1.md.in
+++ b/docs/source/markdown/podman-stop.1.md.in
@@ -54,9 +54,7 @@ Valid filters are listed below:
Instead of providing the container name or ID, use the last created container. If you use methods other than Podman
to run containers such as CRI-O, the last started container could be from either of those methods. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
-#### **--time**, **-t**=*seconds*
-
-Seconds to wait before forcibly stopping the container
+@@option time
## EXAMPLES