summaryrefslogtreecommitdiff
path: root/docs/podman-system-prune.1.md
diff options
context:
space:
mode:
authorAshley Cui <ashleycui16@gmail.com>2019-05-31 15:21:47 -0400
committerAshley Cui <ashleycui16@gmail.com>2019-06-10 11:48:02 -0400
commit19e0928037e2d9c6fb0941e2ac40b8cea731e22d (patch)
tree1b5b10718e2c27c690ae789392fe1d46535a4401 /docs/podman-system-prune.1.md
parent7b0d6fcf0e3ce59f842273f670d742aaf597bf2f (diff)
downloadpodman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.tar.gz
podman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.tar.bz2
podman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.zip
standardize documentation formatting
Signed-off-by: Ashley Cui <ashleycui16@gmail.com>
Diffstat (limited to 'docs/podman-system-prune.1.md')
-rw-r--r--docs/podman-system-prune.1.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/podman-system-prune.1.md b/docs/podman-system-prune.1.md
index 6a284a110..e6297dc0b 100644
--- a/docs/podman-system-prune.1.md
+++ b/docs/podman-system-prune.1.md
@@ -1,14 +1,10 @@
-% podman-system-prune(1) podman
+% podman-system-prune(1)
## NAME
podman\-system\-prune - Remove all unused container, image and volume data
## SYNOPSIS
-**podman system prune**
-[**-all**|**--a**]
-[**-force**|**--f**]
-[**-help**|**--h**]
-[**-volumes**|**--v**]
+**podman system prune** [*options*]
## DESCRIPTION
**podman system prune** removes all unused containers (both dangling and unreferenced), pods and optionally, volumes from local storage.
@@ -18,14 +14,18 @@ With the `all` option, you can delete all unused images. Unused images are dang
By default, volumes are not removed to prevent important data from being deleted if there is currently no container using the volume. Use the --volumes flag when running the command to prune volumes as well.
## OPTIONS
-**--all, -a**
+**--all**, **-a**
Remove all unused images not just dangling ones.
-**--force, -f**
+**--force**, **-f**
Do not prompt for confirmation
+**--help**, **-h**
+
+Print usage statement
+
**--volumes**
Prune volumes not used by at least one container
@@ -33,5 +33,5 @@ Prune volumes not used by at least one container
## SEE ALSO
podman(1), podman-image-prune(1), podman-container-prune(1), podman-pod-prune(1), podman-volume-prune(1)
-# HISTORY
+## HISTORY
February 2019, Originally compiled by Dan Walsh (dwalsh at redhat dot com)