From 46f31361f88317d405d7f7b41c5d644328cd2e5b Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Mon, 22 Aug 2022 10:18:36 -0600 Subject: 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 <> 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 --- docs/source/markdown/.gitignore | 5 + docs/source/markdown/options/cidfile.read.md | 4 + docs/source/markdown/options/cidfile.write.md | 3 + docs/source/markdown/podman-create.1.md.in | 4 +- docs/source/markdown/podman-kill.1.md | 70 -------------- docs/source/markdown/podman-kill.1.md.in | 68 ++++++++++++++ docs/source/markdown/podman-pause.1.md | 85 ----------------- docs/source/markdown/podman-pause.1.md.in | 83 ++++++++++++++++ docs/source/markdown/podman-rm.1.md | 130 -------------------------- docs/source/markdown/podman-rm.1.md.in | 128 +++++++++++++++++++++++++ docs/source/markdown/podman-run.1.md.in | 4 +- docs/source/markdown/podman-stop.1.md | 89 ------------------ docs/source/markdown/podman-stop.1.md.in | 87 +++++++++++++++++ docs/source/markdown/podman-unpause.1.md | 85 ----------------- docs/source/markdown/podman-unpause.1.md.in | 83 ++++++++++++++++ 15 files changed, 463 insertions(+), 465 deletions(-) create mode 100644 docs/source/markdown/options/cidfile.read.md create mode 100644 docs/source/markdown/options/cidfile.write.md delete mode 100644 docs/source/markdown/podman-kill.1.md create mode 100644 docs/source/markdown/podman-kill.1.md.in delete mode 100644 docs/source/markdown/podman-pause.1.md create mode 100644 docs/source/markdown/podman-pause.1.md.in delete mode 100644 docs/source/markdown/podman-rm.1.md create mode 100644 docs/source/markdown/podman-rm.1.md.in delete mode 100644 docs/source/markdown/podman-stop.1.md create mode 100644 docs/source/markdown/podman-stop.1.md.in delete mode 100644 docs/source/markdown/podman-unpause.1.md create mode 100644 docs/source/markdown/podman-unpause.1.md.in 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 <> 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 deleted file mode 100644 index a4f80ac81..000000000 --- a/docs/source/markdown/podman-kill.1.md +++ /dev/null @@ -1,70 +0,0 @@ -% podman-kill(1) - -## NAME -podman\-kill - Kill the main process in one or more containers - -## SYNOPSIS -**podman kill** [*options*] [*container* ...] - -**podman container kill** [*options*] [*container* ...] - -## DESCRIPTION -The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal. - -## OPTIONS -#### **--all**, **-a** - -Signal all running and paused containers. - -#### **--cidfile** - -Read container ID from the specified file and remove the container. Can be specified multiple times. - -#### **--latest**, **-l** - -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) - -#### **--signal**, **-s** - -Signal to send to the container. For more information on Linux signals, refer to *man signal(7)*. - - -## EXAMPLE - -Kill container with a given name -``` -podman kill mywebserver -``` - -Kill container with a given ID -``` -podman kill 860a4b23 -``` - -Terminate container by sending `TERM` signal -``` -podman kill --signal TERM 860a4b23 -``` - -Kill the latest container created by Podman -``` -podman kill --latest -``` - -Terminate all containers by sending `KILL` signal -``` -podman kill --signal KILL -a -``` - -Kill container using ID specified in a given files -``` -podman kill --cidfile /home/user/cidfile-1 -podman kill --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2 -``` - -## SEE ALSO -**[podman(1)](podman.1.md)**, **[podman-stop(1)](podman-stop.1.md)** - -## HISTORY -September 2017, Originally compiled by Brent Baude diff --git a/docs/source/markdown/podman-kill.1.md.in b/docs/source/markdown/podman-kill.1.md.in new file mode 100644 index 000000000..2788cc694 --- /dev/null +++ b/docs/source/markdown/podman-kill.1.md.in @@ -0,0 +1,68 @@ +% podman-kill(1) + +## NAME +podman\-kill - Kill the main process in one or more containers + +## SYNOPSIS +**podman kill** [*options*] [*container* ...] + +**podman container kill** [*options*] [*container* ...] + +## DESCRIPTION +The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal. + +## OPTIONS +#### **--all**, **-a** + +Signal all running and paused containers. + +@@option cidfile.read + +#### **--latest**, **-l** + +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) + +#### **--signal**, **-s** + +Signal to send to the container. For more information on Linux signals, refer to *man signal(7)*. + + +## EXAMPLE + +Kill container with a given name +``` +podman kill mywebserver +``` + +Kill container with a given ID +``` +podman kill 860a4b23 +``` + +Terminate container by sending `TERM` signal +``` +podman kill --signal TERM 860a4b23 +``` + +Kill the latest container created by Podman +``` +podman kill --latest +``` + +Terminate all containers by sending `KILL` signal +``` +podman kill --signal KILL -a +``` + +Kill container using ID specified in a given files +``` +podman kill --cidfile /home/user/cidfile-1 +podman kill --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2 +``` + +## SEE ALSO +**[podman(1)](podman.1.md)**, **[podman-stop(1)](podman-stop.1.md)** + +## HISTORY +September 2017, Originally compiled by Brent Baude diff --git a/docs/source/markdown/podman-pause.1.md b/docs/source/markdown/podman-pause.1.md deleted file mode 100644 index f374d96f3..000000000 --- a/docs/source/markdown/podman-pause.1.md +++ /dev/null @@ -1,85 +0,0 @@ -% podman-pause(1) - -## NAME -podman\-pause - Pause one or more containers - -## SYNOPSIS -**podman pause** [*options*] [*container*...] - -**podman container pause** [*options*] [*container*...] - -## DESCRIPTION -Pauses all the processes in one or more containers. You may use container IDs or names as input. - -## OPTIONS - -#### **--all**, **-a** - -Pause all running containers. - -#### **--cidfile** - -Read container ID from the specified file and pause the container. Can be specified multiple times. - -#### **--filter**, **-f**=*filter* - -Filter what containers pause. -Multiple filters can be given with multiple uses of the --filter flag. -Filters with the same key work inclusive with the only exception being -`label` which is exclusive. Filters with different keys always work exclusive. - -Valid filters are listed below: - -| **Filter** | **Description** | -| --------------- | -------------------------------------------------------------------------------- | -| id | [ID] Container's ID (accepts regex) | -| name | [Name] Container's name (accepts regex) | -| label | [Key] or [Key=Value] Label assigned to a container | -| exited | [Int] Container's exit code | -| status | [Status] Container's status: 'created', 'exited', 'paused', 'running', 'unknown' | -| ancestor | [ImageName] Image or descendant used to create container | -| before | [ID] or [Name] Containers created before this container | -| since | [ID] or [Name] Containers created since this container | -| volume | [VolumeName] or [MountpointDestination] Volume mounted in container | -| health | [Status] healthy or unhealthy | -| pod | [Pod] name or full or partial ID of pod | -| network | [Network] name or full ID of network | - -#### **--latest**, **-l** - -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) - -## EXAMPLE - -Pause container named 'mywebserver' -``` -podman pause mywebserver -``` - -Pause container by partial container ID. -``` -podman pause 860a4b23 -``` - -Pause all **running** containers. -``` -podman pause --all -``` - -Pause container using ID specified in a given files. -``` -podman pause --cidfile /home/user/cidfile-1 -podman pause --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2 -``` - -Pause the latest container created by Podman. -``` -podman pause --latest -``` - -## SEE ALSO -**[podman(1)](podman.1.md)**, **[podman-unpause(1)](podman-unpause.1.md)** - -## HISTORY -September 2017, Originally compiled by Dan Walsh diff --git a/docs/source/markdown/podman-pause.1.md.in b/docs/source/markdown/podman-pause.1.md.in new file mode 100644 index 000000000..af308f034 --- /dev/null +++ b/docs/source/markdown/podman-pause.1.md.in @@ -0,0 +1,83 @@ +% podman-pause(1) + +## NAME +podman\-pause - Pause one or more containers + +## SYNOPSIS +**podman pause** [*options*] [*container*...] + +**podman container pause** [*options*] [*container*...] + +## DESCRIPTION +Pauses all the processes in one or more containers. You may use container IDs or names as input. + +## OPTIONS + +#### **--all**, **-a** + +Pause all running containers. + +@@option cidfile.read + +#### **--filter**, **-f**=*filter* + +Filter what containers pause. +Multiple filters can be given with multiple uses of the --filter flag. +Filters with the same key work inclusive with the only exception being +`label` which is exclusive. Filters with different keys always work exclusive. + +Valid filters are listed below: + +| **Filter** | **Description** | +| --------------- | -------------------------------------------------------------------------------- | +| id | [ID] Container's ID (accepts regex) | +| name | [Name] Container's name (accepts regex) | +| label | [Key] or [Key=Value] Label assigned to a container | +| exited | [Int] Container's exit code | +| status | [Status] Container's status: 'created', 'exited', 'paused', 'running', 'unknown' | +| ancestor | [ImageName] Image or descendant used to create container | +| before | [ID] or [Name] Containers created before this container | +| since | [ID] or [Name] Containers created since this container | +| volume | [VolumeName] or [MountpointDestination] Volume mounted in container | +| health | [Status] healthy or unhealthy | +| pod | [Pod] name or full or partial ID of pod | +| network | [Network] name or full ID of network | + +#### **--latest**, **-l** + +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) + +## EXAMPLE + +Pause container named 'mywebserver' +``` +podman pause mywebserver +``` + +Pause container by partial container ID. +``` +podman pause 860a4b23 +``` + +Pause all **running** containers. +``` +podman pause --all +``` + +Pause container using ID specified in a given files. +``` +podman pause --cidfile /home/user/cidfile-1 +podman pause --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2 +``` + +Pause the latest container created by Podman. +``` +podman pause --latest +``` + +## SEE ALSO +**[podman(1)](podman.1.md)**, **[podman-unpause(1)](podman-unpause.1.md)** + +## HISTORY +September 2017, Originally compiled by Dan Walsh diff --git a/docs/source/markdown/podman-rm.1.md b/docs/source/markdown/podman-rm.1.md deleted file mode 100644 index 1dbd1d0c3..000000000 --- a/docs/source/markdown/podman-rm.1.md +++ /dev/null @@ -1,130 +0,0 @@ -% podman-rm(1) - -## NAME -podman\-rm - Remove one or more containers - -## SYNOPSIS -**podman rm** [*options*] *container* - -**podman container rm** [*options*] *container* - -## DESCRIPTION -**podman rm** will remove one or more containers from the host. The container name or ID can be used. This does not remove images. -Running or unusable containers will not be removed without the **-f** option. - -## OPTIONS - -#### **--all**, **-a** - -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. - -#### **--depend** - -Remove selected container and recursively remove all containers that depend on it. - -#### **--filter**=*filter* - -Filter what containers remove. -Multiple filters can be given with multiple uses of the --filter flag. -Filters with the same key work inclusive with the only exception being -`label` which is exclusive. Filters with different keys always work exclusive. - -Valid filters are listed below: - -| **Filter** | **Description** | -| --------------- | -------------------------------------------------------------------------------- | -| id | [ID] Container's ID (accepts regex) | -| name | [Name] Container's name (accepts regex) | -| label | [Key] or [Key=Value] Label assigned to a container | -| exited | [Int] Container's exit code | -| status | [Status] Container's status: 'created', 'exited', 'paused', 'running', 'unknown' | -| ancestor | [ImageName] Image or descendant used to create container | -| before | [ID] or [Name] Containers created before this container | -| since | [ID] or [Name] Containers created since this container | -| volume | [VolumeName] or [MountpointDestination] Volume mounted in container | -| health | [Status] healthy or unhealthy | -| pod | [Pod] name or full or partial ID of pod | -| network | [Network] name or full ID of network | - -#### **--force**, **-f** - -Force the removal of running and paused containers. Forcing a container removal also -removes containers from container storage even if the container is not known to podman. -Containers could have been created by a different container engine. -In addition, forcing can be used to remove unusable containers, e.g. containers -whose OCI runtime has become unavailable. - -#### **--ignore**, **-i** - -Ignore errors when specified containers are not in the container store. A user -might have decided to manually remove a container which would lead to a failure -during the ExecStop directive of a systemd service referencing that container. - -#### **--latest**, **-l** - -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. The --force option must be specified to use the --time option. - -#### **--volumes**, **-v** - -Remove anonymous volumes associated with the container. This does not include named volumes -created with **podman volume create**, or the **--volume** option of **podman run** and **podman create**. - -## EXAMPLE -Remove a container by its name *mywebserver* -``` -$ podman rm mywebserver -``` - -Remove a *mywebserver* container and all of the containers that depend on it -``` -$ podman rm --depend mywebserver -``` - -Remove several containers by name and container id. -``` -$ podman rm mywebserver myflaskserver 860a4b23 -``` - -Remove several containers reading their IDs from files. -``` -$ podman rm --cidfile ./cidfile-1 --cidfile /home/user/cidfile-2 -``` - -Forcibly remove a container by container ID. -``` -$ podman rm -f 860a4b23 -``` - -Remove all containers regardless of its run state. -``` -$ podman rm -f -a -``` - -Forcibly remove the latest container created. -``` -$ podman rm -f --latest -``` - -## Exit Status - **0** All specified containers removed - - **1** One of the specified containers did not exist, and no other failures - - **2** One of the specified containers is paused or running - - **125** The command fails for any other reason - -## SEE ALSO -**[podman(1)](podman.1.md)**, **[crio(8)](https://github.com/cri-o/cri-o/blob/main/docs/crio.8.md)** - -## HISTORY -August 2017, Originally compiled by Ryan Cole diff --git a/docs/source/markdown/podman-rm.1.md.in b/docs/source/markdown/podman-rm.1.md.in new file mode 100644 index 000000000..fa3031b29 --- /dev/null +++ b/docs/source/markdown/podman-rm.1.md.in @@ -0,0 +1,128 @@ +% podman-rm(1) + +## NAME +podman\-rm - Remove one or more containers + +## SYNOPSIS +**podman rm** [*options*] *container* + +**podman container rm** [*options*] *container* + +## DESCRIPTION +**podman rm** will remove one or more containers from the host. The container name or ID can be used. This does not remove images. +Running or unusable containers will not be removed without the **-f** option. + +## OPTIONS + +#### **--all**, **-a** + +Remove all containers. Can be used in conjunction with **-f** as well. + +@@option cidfile.read + +#### **--depend** + +Remove selected container and recursively remove all containers that depend on it. + +#### **--filter**=*filter* + +Filter what containers remove. +Multiple filters can be given with multiple uses of the --filter flag. +Filters with the same key work inclusive with the only exception being +`label` which is exclusive. Filters with different keys always work exclusive. + +Valid filters are listed below: + +| **Filter** | **Description** | +| --------------- | -------------------------------------------------------------------------------- | +| id | [ID] Container's ID (accepts regex) | +| name | [Name] Container's name (accepts regex) | +| label | [Key] or [Key=Value] Label assigned to a container | +| exited | [Int] Container's exit code | +| status | [Status] Container's status: 'created', 'exited', 'paused', 'running', 'unknown' | +| ancestor | [ImageName] Image or descendant used to create container | +| before | [ID] or [Name] Containers created before this container | +| since | [ID] or [Name] Containers created since this container | +| volume | [VolumeName] or [MountpointDestination] Volume mounted in container | +| health | [Status] healthy or unhealthy | +| pod | [Pod] name or full or partial ID of pod | +| network | [Network] name or full ID of network | + +#### **--force**, **-f** + +Force the removal of running and paused containers. Forcing a container removal also +removes containers from container storage even if the container is not known to podman. +Containers could have been created by a different container engine. +In addition, forcing can be used to remove unusable containers, e.g. containers +whose OCI runtime has become unavailable. + +#### **--ignore**, **-i** + +Ignore errors when specified containers are not in the container store. A user +might have decided to manually remove a container which would lead to a failure +during the ExecStop directive of a systemd service referencing that container. + +#### **--latest**, **-l** + +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. The --force option must be specified to use the --time option. + +#### **--volumes**, **-v** + +Remove anonymous volumes associated with the container. This does not include named volumes +created with **podman volume create**, or the **--volume** option of **podman run** and **podman create**. + +## EXAMPLE +Remove a container by its name *mywebserver* +``` +$ podman rm mywebserver +``` + +Remove a *mywebserver* container and all of the containers that depend on it +``` +$ podman rm --depend mywebserver +``` + +Remove several containers by name and container id. +``` +$ podman rm mywebserver myflaskserver 860a4b23 +``` + +Remove several containers reading their IDs from files. +``` +$ podman rm --cidfile ./cidfile-1 --cidfile /home/user/cidfile-2 +``` + +Forcibly remove a container by container ID. +``` +$ podman rm -f 860a4b23 +``` + +Remove all containers regardless of its run state. +``` +$ podman rm -f -a +``` + +Forcibly remove the latest container created. +``` +$ podman rm -f --latest +``` + +## Exit Status + **0** All specified containers removed + + **1** One of the specified containers did not exist, and no other failures + + **2** One of the specified containers is paused or running + + **125** The command fails for any other reason + +## SEE ALSO +**[podman(1)](podman.1.md)**, **[crio(8)](https://github.com/cri-o/cri-o/blob/main/docs/crio.8.md)** + +## HISTORY +August 2017, Originally compiled by Ryan Cole 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 deleted file mode 100644 index cfc49afa1..000000000 --- a/docs/source/markdown/podman-stop.1.md +++ /dev/null @@ -1,89 +0,0 @@ -% podman-stop(1) - -## NAME -podman\-stop - Stop one or more running containers - -## SYNOPSIS -**podman stop** [*options*] *container* ... - -**podman container stop** [*options*] *container* ... - -## DESCRIPTION -Stops one or more containers. You may use container IDs or names as input. The **--time** switch -allows you to specify the number of seconds to wait before forcibly stopping the container after the stop command -is issued to the container. The default is 10 seconds. By default, containers are stopped with SIGTERM -and then SIGKILL after the timeout. The SIGTERM default can be overridden by the image used to create the -container and also via command line when creating the container. - -## OPTIONS - -#### **--all**, **-a** - -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. - -#### **--filter**, **-f**=*filter* - -Filter what containers are going to be stopped. -Multiple filters can be given with multiple uses of the --filter flag. -Filters with the same key work inclusive with the only exception being -`label` which is exclusive. Filters with different keys always work exclusive. - -Valid filters are listed below: - -| **Filter** | **Description** | -| --------------- | -------------------------------------------------------------------------------- | -| id | [ID] Container's ID (accepts regex) | -| name | [Name] Container's name (accepts regex) | -| label | [Key] or [Key=Value] Label assigned to a container | -| exited | [Int] Container's exit code | -| status | [Status] Container's status: 'created', 'exited', 'paused', 'running', 'unknown' | -| ancestor | [ImageName] Image or descendant used to create container | -| before | [ID] or [Name] Containers created before this container | -| since | [ID] or [Name] Containers created since this container | -| volume | [VolumeName] or [MountpointDestination] Volume mounted in container | -| health | [Status] healthy or unhealthy | -| pod | [Pod] name or full or partial ID of pod | -| network | [Network] name or full ID of network | - -#### **--ignore**, **-i** - -Ignore errors when specified containers are not in the container store. A user -might have decided to manually remove a container which would lead to a failure -during the ExecStop directive of a systemd service referencing that container. - -#### **--latest**, **-l** - -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 - -## EXAMPLES - -$ podman stop mywebserver - -$ podman stop 860a4b235279 - -$ podman stop mywebserver 860a4b235279 - -$ podman stop --cidfile /home/user/cidfile-1 - -$ podman stop --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2 - -$ podman stop --time 2 860a4b235279 - -$ podman stop -a - -$ podman stop --latest - -## SEE ALSO -**[podman(1)](podman.1.md)**, **[podman-rm(1)](podman-rm.1.md)** - -## HISTORY -September 2018, Originally compiled by Brent Baude diff --git a/docs/source/markdown/podman-stop.1.md.in b/docs/source/markdown/podman-stop.1.md.in new file mode 100644 index 000000000..04fc9387f --- /dev/null +++ b/docs/source/markdown/podman-stop.1.md.in @@ -0,0 +1,87 @@ +% podman-stop(1) + +## NAME +podman\-stop - Stop one or more running containers + +## SYNOPSIS +**podman stop** [*options*] *container* ... + +**podman container stop** [*options*] *container* ... + +## DESCRIPTION +Stops one or more containers. You may use container IDs or names as input. The **--time** switch +allows you to specify the number of seconds to wait before forcibly stopping the container after the stop command +is issued to the container. The default is 10 seconds. By default, containers are stopped with SIGTERM +and then SIGKILL after the timeout. The SIGTERM default can be overridden by the image used to create the +container and also via command line when creating the container. + +## OPTIONS + +#### **--all**, **-a** + +Stop all running containers. This does not include paused containers. + +@@option cidfile.read + +#### **--filter**, **-f**=*filter* + +Filter what containers are going to be stopped. +Multiple filters can be given with multiple uses of the --filter flag. +Filters with the same key work inclusive with the only exception being +`label` which is exclusive. Filters with different keys always work exclusive. + +Valid filters are listed below: + +| **Filter** | **Description** | +| --------------- | -------------------------------------------------------------------------------- | +| id | [ID] Container's ID (accepts regex) | +| name | [Name] Container's name (accepts regex) | +| label | [Key] or [Key=Value] Label assigned to a container | +| exited | [Int] Container's exit code | +| status | [Status] Container's status: 'created', 'exited', 'paused', 'running', 'unknown' | +| ancestor | [ImageName] Image or descendant used to create container | +| before | [ID] or [Name] Containers created before this container | +| since | [ID] or [Name] Containers created since this container | +| volume | [VolumeName] or [MountpointDestination] Volume mounted in container | +| health | [Status] healthy or unhealthy | +| pod | [Pod] name or full or partial ID of pod | +| network | [Network] name or full ID of network | + +#### **--ignore**, **-i** + +Ignore errors when specified containers are not in the container store. A user +might have decided to manually remove a container which would lead to a failure +during the ExecStop directive of a systemd service referencing that container. + +#### **--latest**, **-l** + +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 + +## EXAMPLES + +$ podman stop mywebserver + +$ podman stop 860a4b235279 + +$ podman stop mywebserver 860a4b235279 + +$ podman stop --cidfile /home/user/cidfile-1 + +$ podman stop --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2 + +$ podman stop --time 2 860a4b235279 + +$ podman stop -a + +$ podman stop --latest + +## SEE ALSO +**[podman(1)](podman.1.md)**, **[podman-rm(1)](podman-rm.1.md)** + +## HISTORY +September 2018, Originally compiled by Brent Baude diff --git a/docs/source/markdown/podman-unpause.1.md b/docs/source/markdown/podman-unpause.1.md deleted file mode 100644 index b94ace89e..000000000 --- a/docs/source/markdown/podman-unpause.1.md +++ /dev/null @@ -1,85 +0,0 @@ -% podman-unpause(1) - -## NAME -podman\-unpause - Unpause one or more containers - -## SYNOPSIS -**podman unpause** [*options*]|[*container* ...] - -**podman container unpause** [*options*]|[*container* ...] - -## DESCRIPTION -Unpauses the processes in one or more containers. You may use container IDs or names as input. - -## OPTIONS - -#### **--all**, **-a** - -Unpause all paused containers. - -#### **--cidfile** - -Read container ID from the specified file and unpause the container. Can be specified multiple times. - -#### **--filter**, **-f**=*filter* - -Filter what containers unpause. -Multiple filters can be given with multiple uses of the --filter flag. -Filters with the same key work inclusive with the only exception being -`label` which is exclusive. Filters with different keys always work exclusive. - -Valid filters are listed below: - -| **Filter** | **Description** | -| --------------- | -------------------------------------------------------------------------------- | -| id | [ID] Container's ID (accepts regex) | -| name | [Name] Container's name (accepts regex) | -| label | [Key] or [Key=Value] Label assigned to a container | -| exited | [Int] Container's exit code | -| status | [Status] Container's status: 'created', 'exited', 'paused', 'running', 'unknown' | -| ancestor | [ImageName] Image or descendant used to create container | -| before | [ID] or [Name] Containers created before this container | -| since | [ID] or [Name] Containers created since this container | -| volume | [VolumeName] or [MountpointDestination] Volume mounted in container | -| health | [Status] healthy or unhealthy | -| pod | [Pod] name or full or partial ID of pod | -| network | [Network] name or full ID of network | - -#### **--latest**, **-l** - -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) - -## EXAMPLE - -Unpause container called 'mywebserver' -``` -podman unpause mywebserver -``` - -Unpause container by a partial container ID. -``` -podman unpause 860a4b23 -``` - -Unpause all **paused** containers. -``` -podman unpause --all -``` - -Unpause container using ID specified in a given files. -``` -podman unpause --cidfile /home/user/cidfile-1 -podman unpause --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2 -``` - -Unpause the latest container created by Podman. -``` -podman unpause --latest -``` - -## SEE ALSO -**[podman(1)](podman.1.md)**, **[podman-pause(1)](podman-pause.1.md)** - -## HISTORY -September 2017, Originally compiled by Dan Walsh diff --git a/docs/source/markdown/podman-unpause.1.md.in b/docs/source/markdown/podman-unpause.1.md.in new file mode 100644 index 000000000..7bd46e171 --- /dev/null +++ b/docs/source/markdown/podman-unpause.1.md.in @@ -0,0 +1,83 @@ +% podman-unpause(1) + +## NAME +podman\-unpause - Unpause one or more containers + +## SYNOPSIS +**podman unpause** [*options*]|[*container* ...] + +**podman container unpause** [*options*]|[*container* ...] + +## DESCRIPTION +Unpauses the processes in one or more containers. You may use container IDs or names as input. + +## OPTIONS + +#### **--all**, **-a** + +Unpause all paused containers. + +@@option cidfile.read + +#### **--filter**, **-f**=*filter* + +Filter what containers unpause. +Multiple filters can be given with multiple uses of the --filter flag. +Filters with the same key work inclusive with the only exception being +`label` which is exclusive. Filters with different keys always work exclusive. + +Valid filters are listed below: + +| **Filter** | **Description** | +| --------------- | -------------------------------------------------------------------------------- | +| id | [ID] Container's ID (accepts regex) | +| name | [Name] Container's name (accepts regex) | +| label | [Key] or [Key=Value] Label assigned to a container | +| exited | [Int] Container's exit code | +| status | [Status] Container's status: 'created', 'exited', 'paused', 'running', 'unknown' | +| ancestor | [ImageName] Image or descendant used to create container | +| before | [ID] or [Name] Containers created before this container | +| since | [ID] or [Name] Containers created since this container | +| volume | [VolumeName] or [MountpointDestination] Volume mounted in container | +| health | [Status] healthy or unhealthy | +| pod | [Pod] name or full or partial ID of pod | +| network | [Network] name or full ID of network | + +#### **--latest**, **-l** + +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) + +## EXAMPLE + +Unpause container called 'mywebserver' +``` +podman unpause mywebserver +``` + +Unpause container by a partial container ID. +``` +podman unpause 860a4b23 +``` + +Unpause all **paused** containers. +``` +podman unpause --all +``` + +Unpause container using ID specified in a given files. +``` +podman unpause --cidfile /home/user/cidfile-1 +podman unpause --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2 +``` + +Unpause the latest container created by Podman. +``` +podman unpause --latest +``` + +## SEE ALSO +**[podman(1)](podman.1.md)**, **[podman-pause(1)](podman-pause.1.md)** + +## HISTORY +September 2017, Originally compiled by Dan Walsh -- cgit v1.2.3-54-g00ecf