Man pages: refactor common options: --cidfile

There are two meanings: one writes a cidfile, the other reads.
Split into two .md files.

This can be reviewed with hack/markdown-preprocess-review .
The main differences you'll see are all in cidfile.read:

  1) I use the <<subcommand>> feature. This works nicely for
     kill, pause/unpause, and stop. It works less nicely for
     rm, because the man page will show "...and rm the container"
     (a human might prefer to see "REMOVE the container"). Given
     the benefit of this cleanup, I think this is a fine tradeoff.

  2) I choose to include the "multiple times" text even on man pages
     where it wasn't present before. I tested to make sure it works.

  3) The #### line I choose is IMHO the best one.

Minor differences:

  * I believe the "remove the container" text in podman-kill
    and podman-stop is a copy/paste error. This PR fixes it.

  * The only differences between the cidfile.write texts is
    the #### line (my version is best) and a final period.

Signed-off-by: Ed Santiago <santiago@redhat.com>
This commit is contained in:
Ed Santiago 2022-08-22 10:18:36 -06:00
parent aefd0aed39
commit 46f31361f8
10 changed files with 19 additions and 21 deletions

View File

@ -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

View File

@ -0,0 +1,4 @@
#### **--cidfile**=*file*
Read container ID from the specified *file* and <<subcommand>> the container.
Can be specified multiple times.

View File

@ -0,0 +1,3 @@
#### **--cidfile**=*file*
Write the container ID to *file*.

View File

@ -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

View File

@ -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**

View File

@ -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*

View File

@ -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**

View File

@ -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

View File

@ -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*

View File

@ -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*