summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-container-prune.1.md
diff options
context:
space:
mode:
authorAlexander Richter <67486332+Procyhon@users.noreply.github.com>2021-06-14 20:05:26 +0200
committerAlexander Richter <67486332+Procyhon@users.noreply.github.com>2021-06-16 17:44:11 +0200
commite344a5899f7e02aea27b830bf58d8ca0bad40490 (patch)
tree9328202a016fddb07aca48d396d4f71460444d2e /docs/source/markdown/podman-container-prune.1.md
parente549ca5078b60defca91c724305cac8929b8ff0f (diff)
downloadpodman-e344a5899f7e02aea27b830bf58d8ca0bad40490.tar.gz
podman-e344a5899f7e02aea27b830bf58d8ca0bad40490.tar.bz2
podman-e344a5899f7e02aea27b830bf58d8ca0bad40490.zip
[CI:DOCS] UPDATE manpages with MANPAGE_SYNTAX
MANPAGE_SYNTAX was edited. The following manpages have been adapted to the MANPAGE_SYNTAX: - podman-container-prune - podman-container-restore The following manpages have had little changes: - podman-attach - podman-auto-update - podman-commit - podman-completion - podman-container-checkpoint - podman-container-cleanup - podman-container-exists Signed-off-by: Alexander Richter <67486332+Procyhon@users.noreply.github.com>
Diffstat (limited to 'docs/source/markdown/podman-container-prune.1.md')
-rw-r--r--docs/source/markdown/podman-container-prune.1.md34
1 files changed, 18 insertions, 16 deletions
diff --git a/docs/source/markdown/podman-container-prune.1.md b/docs/source/markdown/podman-container-prune.1.md
index b199f9ebb..06014897f 100644
--- a/docs/source/markdown/podman-container-prune.1.md
+++ b/docs/source/markdown/podman-container-prune.1.md
@@ -1,7 +1,7 @@
% podman-container-prune(1)
## NAME
-podman-container-prune - Remove all stopped containers from local storage
+podman\-container\-prune - Remove all stopped containers from local storage
## SYNOPSIS
**podman container prune** [*options*]
@@ -10,35 +10,37 @@ podman-container-prune - Remove all stopped containers from local storage
**podman container prune** removes all stopped containers from local storage.
## OPTIONS
-
#### **--filter**=*filters*
Provide filter values.
-The --filter flag format is of “key=value”. If there is more than one filter, then pass multiple flags (e.g., --filter "foo=bar" --filter "bif=baz")
+The *filters* argument format is of `key=value`. If there is more than one *filter*, then pass multiple OPTIONS: **--filter** *foo=bar* **--filter** *bif=baz*.
Supported filters:
-- `until` (_timestamp_) - only remove containers and images created before given timestamp
-- `label` (label=_key_, label=_key=value_, label!=_key_, or label!=_key=value_) - only remove containers and images, with (or without, in case label!=... is used) the specified labels.
+| Filter | Description |
+| :----------------: | --------------------------------------------------------------------------- |
+| *until* | Only remove containers and images created before given timestamp. |
+| *label* | Only remove containers and images, with (or without, in case label!=[...] is used) the specified labels. |
-The until filter can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the machine’s time.
+The `until` *filter* can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the machine’s time.
-The label filter accepts two formats. One is the label=... (label=_key_ or label=_key=value_), which removes containers with the specified labels. The other format is the label!=... (label!=_key_ or label!=_key=value_), which removes containers without the specified labels.
+The `label` *filter* accepts two formats. One is the `label`=*key*, `label`=*key*=*value*, which removes containers with the specified labels. The other format is the `label!`=*key*, or `label!`=*key*=*value*, which removes containers without the specified labels.
#### **--force**, **-f**
-Do not provide an interactive prompt for container removal.
+Do not provide an interactive prompt for container removal.\
+The default is **false**.
**-h**, **--help**
-Print usage statement
+Print usage statement.\
+The default is **false**.
## EXAMPLES
-
Remove all stopped containers from local storage
```
-$ sudo podman container prune
+$ podman container prune
WARNING! This will remove all stopped containers.
Are you sure you want to continue? [y/N] y
878392adf2e6c5c9bb1fc19b69d37d2e98c8abf9d539c0bce4b15b46bbcce471
@@ -51,7 +53,7 @@ fff1c5b6c3631746055ec40598ce8ecaa4b82aef122f9e3a85b03b55c0d06c23
Remove all stopped containers from local storage without confirmation.
```
-$ sudo podman container prune -f
+$ podman container prune -f
878392adf2e6c5c9bb1fc19b69d37d2e98c8abf9d539c0bce4b15b46bbcce471
37664467fbe3618bf9479c34393ac29c02696675addf1750f9e346581636cde7
ed0c6468b8e1cb641b4621d1fe30cb477e1fefc5c0bceb66feaf2f7cb50e5962
@@ -63,15 +65,15 @@ fff1c5b6c3631746055ec40598ce8ecaa4b82aef122f9e3a85b03b55c0d06c23
Remove all stopped containers from local storage created within last 10 minutes
```
-$ sudo podman container prune --filter until="10m"
+$ podman container prune --filter until="10m"
WARNING! This will remove all stopped containers.
Are you sure you want to continue? [y/N] y
3d366295e33d8cc612c4d873199bacadd55088d90d17dcafaa9a2d317ad50b4e
```
## SEE ALSO
-podman(1), podman-ps
+**[podman(1)](podman.1.md)**, **[podman-ps](podman-ps.1.md)**
## HISTORY
-December 2018, Originally compiled by Brent Baude (bbaude at redhat dot com)
-December 2020, converted filter information from docs.docker.com documentation by Dan Walsh (dwalsh at redhat dot com)
+December 2018, Originally compiled by Brent Baude <bbaude@redhat.com>\
+December 2020, converted filter information from docs.docker.com documentation by Dan Walsh <dwalsh@redhat.com>