summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-container-cleanup.1.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/markdown/podman-container-cleanup.1.md')
-rw-r--r--docs/source/markdown/podman-container-cleanup.1.md46
1 files changed, 23 insertions, 23 deletions
diff --git a/docs/source/markdown/podman-container-cleanup.1.md b/docs/source/markdown/podman-container-cleanup.1.md
index 19d0b7818..f33b68a1c 100644
--- a/docs/source/markdown/podman-container-cleanup.1.md
+++ b/docs/source/markdown/podman-container-cleanup.1.md
@@ -4,51 +4,51 @@
podman\-container\-cleanup - Cleanup the container's network and mountpoints
## SYNOPSIS
-**podman container cleanup** [*options*] *container*
+**podman container cleanup** [*options*] *container* [*container* ...]
## DESCRIPTION
-**podman container cleanup** cleans up exited containers by removing all mountpoints and network configuration from the host. The container name or ID can be used. The cleanup command does not remove the containers. Running containers will not be cleaned up.
-Sometimes container's mount points and network stacks can remain if the podman command was killed or the container ran in daemon mode. This command is automatically executed when you run containers in daemon mode by the conmon process when the container exits.
+**podman container cleanup** cleans up exited *containers* by removing all mountpoints and network configuration from the host. The *container name* or *ID* can be used. The cleanup command does not remove the *containers*. Running *containers* will not be cleaned up.\
+Sometimes container mount points and network stacks can remain if the podman command was killed or the *container* ran in daemon mode. This command is automatically executed when you run *containers* in daemon mode by the `conmon process` when the *container* exits.
## OPTIONS
#### **--all**, **-a**
-Cleanup all containers.
+Cleanup all *containers*. The default is **false**.
-#### **--exec**=_session_
+#### **--exec**=*session*
-Clean up an exec session for a single container.
-Can only be specified if a single container is being cleaned up (conflicts with **--all** as such).
-If **--rm** is not specified, temporary files for the exec session will be cleaned up; if it is, the exec session will be removed from the container.
-Conflicts with **--rmi** as the container is not being cleaned up so the image cannot be removed.
+Clean up an exec session for a single *container*.
+Can only be specified if a single *container* is being cleaned up (conflicts with **--all** as such). If **--rm** is not specified, temporary files for the exec session will be cleaned up; if it is, the exec session will be removed from the *container*.\
+*IMPORTANT: Conflicts with **--rmi** as the container is not being cleaned up so the image cannot be removed.*
#### **--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)
+
+Instead of providing the *container ID* or *name*, 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. The default is **false**.\
+*IMPORTANT: This OPTION is not available with the remote Podman client.*
#### **--rm**
-After cleanup, remove the container entirely.
+After cleanup, remove the *container* entirely. The default is **false**.
#### **--rmi**
-After cleanup, remove the image entirely.
-
-## EXAMPLE
-
-`podman container cleanup mywebserver`
-
-`podman container cleanup mywebserver myflaskserver 860a4b23`
+After cleanup, remove the image entirely. The default is **false**.
-`podman container cleanup 860a4b23`
+## EXAMPLES
-`podman container cleanup -a`
+Cleanup the container "mywebserver".
+```
+$ podman container cleanup mywebserver
+```
-`podman container cleanup --latest`
+Cleanup the containers with the names "mywebserver", "myflaskserver", "860a4b23".
+```
+$ podman container cleanup mywebserver myflaskserver 860a4b23
+```
## SEE ALSO
-**podman**(1), **podman-container**(1), **conmon**(8).
+**[podman(1)](podman.1.md)**, **[podman-container(1)](podman-container.1.md)**, conmon(8)
## HISTORY
Jun 2018, Originally compiled by Dan Walsh <dwalsh@redhat.com>