summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-08-22 20:31:09 -0400
committerGitHub <noreply@github.com>2022-08-22 20:31:09 -0400
commitd97f4dfbcc5af69c01afa2a76194486d178f63a6 (patch)
treec0b19fd15a728f0a9947971813b4bec3db831b66 /docs
parent51d4b88ce976708de88ce041a03d6d65dd4c8d0e (diff)
parent46f31361f88317d405d7f7b41c5d644328cd2e5b (diff)
downloadpodman-d97f4dfbcc5af69c01afa2a76194486d178f63a6.tar.gz
podman-d97f4dfbcc5af69c01afa2a76194486d178f63a6.tar.bz2
podman-d97f4dfbcc5af69c01afa2a76194486d178f63a6.zip
Merge pull request #15414 from edsantiago/docs_dedup_cidfile
Man pages: refactor common options: --cidfile
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/.gitignore5
-rw-r--r--docs/source/markdown/options/cidfile.read.md4
-rw-r--r--docs/source/markdown/options/cidfile.write.md3
-rw-r--r--docs/source/markdown/podman-create.1.md.in4
-rw-r--r--docs/source/markdown/podman-kill.1.md.in (renamed from docs/source/markdown/podman-kill.1.md)4
-rw-r--r--docs/source/markdown/podman-pause.1.md.in (renamed from docs/source/markdown/podman-pause.1.md)4
-rw-r--r--docs/source/markdown/podman-rm.1.md.in (renamed from docs/source/markdown/podman-rm.1.md)4
-rw-r--r--docs/source/markdown/podman-run.1.md.in4
-rw-r--r--docs/source/markdown/podman-stop.1.md.in (renamed from docs/source/markdown/podman-stop.1.md)4
-rw-r--r--docs/source/markdown/podman-unpause.1.md.in (renamed from docs/source/markdown/podman-unpause.1.md)4
10 files changed, 19 insertions, 21 deletions
diff --git a/docs/source/markdown/.gitignore b/docs/source/markdown/.gitignore
index 70f1c2bd7..5a30aab78 100644
--- a/docs/source/markdown/.gitignore
+++ b/docs/source/markdown/.gitignore
@@ -4,14 +4,19 @@ podman-container-clone.1.md
podman-container-runlabel.1.md
podman-create.1.md
podman-image-sign.1.md
+podman-kill.1.md
podman-kube-play.1.md
podman-login.1.md
podman-logout.1.md
podman-manifest-add.1.md
podman-manifest-push.1.md
+podman-pause.1.md
podman-pod-clone.1.md
podman-pod-create.1.md
podman-pull.1.md
podman-push.1.md
+podman-rm.1.md
podman-run.1.md
podman-search.1.md
+podman-stop.1.md
+podman-unpause.1.md
diff --git a/docs/source/markdown/options/cidfile.read.md b/docs/source/markdown/options/cidfile.read.md
new file mode 100644
index 000000000..414700fca
--- /dev/null
+++ b/docs/source/markdown/options/cidfile.read.md
@@ -0,0 +1,4 @@
+#### **--cidfile**=*file*
+
+Read container ID from the specified *file* and <<subcommand>> the container.
+Can be specified multiple times.
diff --git a/docs/source/markdown/options/cidfile.write.md b/docs/source/markdown/options/cidfile.write.md
new file mode 100644
index 000000000..b5e7435b2
--- /dev/null
+++ b/docs/source/markdown/options/cidfile.write.md
@@ -0,0 +1,3 @@
+#### **--cidfile**=*file*
+
+Write the container ID to *file*.
diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in
index 7ec4fc66f..2827964f7 100644
--- a/docs/source/markdown/podman-create.1.md.in
+++ b/docs/source/markdown/podman-create.1.md.in
@@ -105,9 +105,7 @@ Block IO relative device weight.
@@option chrootdirs
-#### **--cidfile**=*id*
-
-Write the container ID to the file
+@@option cidfile.write
@@option conmon-pidfile
diff --git a/docs/source/markdown/podman-kill.1.md b/docs/source/markdown/podman-kill.1.md.in
index a4f80ac81..2788cc694 100644
--- a/docs/source/markdown/podman-kill.1.md
+++ b/docs/source/markdown/podman-kill.1.md.in
@@ -16,9 +16,7 @@ The main process inside each container specified will be sent SIGKILL, or any si
Signal all running and paused containers.
-#### **--cidfile**
-
-Read container ID from the specified file and remove the container. Can be specified multiple times.
+@@option cidfile.read
#### **--latest**, **-l**
diff --git a/docs/source/markdown/podman-pause.1.md b/docs/source/markdown/podman-pause.1.md.in
index f374d96f3..af308f034 100644
--- a/docs/source/markdown/podman-pause.1.md
+++ b/docs/source/markdown/podman-pause.1.md.in
@@ -17,9 +17,7 @@ Pauses all the processes in one or more containers. You may use container IDs o
Pause all running containers.
-#### **--cidfile**
-
-Read container ID from the specified file and pause the container. Can be specified multiple times.
+@@option cidfile.read
#### **--filter**, **-f**=*filter*
diff --git a/docs/source/markdown/podman-rm.1.md b/docs/source/markdown/podman-rm.1.md.in
index 1dbd1d0c3..fa3031b29 100644
--- a/docs/source/markdown/podman-rm.1.md
+++ b/docs/source/markdown/podman-rm.1.md.in
@@ -18,9 +18,7 @@ Running or unusable containers will not be removed without the **-f** option.
Remove all containers. Can be used in conjunction with **-f** as well.
-#### **--cidfile**
-
-Read container ID from the specified file and remove the container. Can be specified multiple times.
+@@option cidfile.read
#### **--depend**
diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in
index d10520e35..cdfa9366a 100644
--- a/docs/source/markdown/podman-run.1.md.in
+++ b/docs/source/markdown/podman-run.1.md.in
@@ -120,9 +120,7 @@ each of **stdin**, **stdout**, and **stderr**.
@@option chrootdirs
-#### **--cidfile**=*file*
-
-Write the container ID to *file*.
+@@option cidfile.write
@@option conmon-pidfile
diff --git a/docs/source/markdown/podman-stop.1.md b/docs/source/markdown/podman-stop.1.md.in
index cfc49afa1..04fc9387f 100644
--- a/docs/source/markdown/podman-stop.1.md
+++ b/docs/source/markdown/podman-stop.1.md.in
@@ -21,9 +21,7 @@ container and also via command line when creating the container.
Stop all running containers. This does not include paused containers.
-#### **--cidfile**
-
-Read container ID from the specified file and remove the container. Can be specified multiple times.
+@@option cidfile.read
#### **--filter**, **-f**=*filter*
diff --git a/docs/source/markdown/podman-unpause.1.md b/docs/source/markdown/podman-unpause.1.md.in
index b94ace89e..7bd46e171 100644
--- a/docs/source/markdown/podman-unpause.1.md
+++ b/docs/source/markdown/podman-unpause.1.md.in
@@ -17,9 +17,7 @@ Unpauses the processes in one or more containers. You may use container IDs or
Unpause all paused containers.
-#### **--cidfile**
-
-Read container ID from the specified file and unpause the container. Can be specified multiple times.
+@@option cidfile.read
#### **--filter**, **-f**=*filter*