summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPeter Hunt <pehunt@redhat.com>2019-03-15 17:41:03 -0400
committerPeter Hunt <pehunt@redhat.com>2019-04-16 11:23:18 -0400
commit0b34b4a59cf090a47a2a13cc4814954c497b3d49 (patch)
tree22e5185775ae83766d6911dd6b3d6b8376a976e1 /docs
parenta2e9626d92dedb182a500c3a0f04dcc0499a6d54 (diff)
downloadpodman-0b34b4a59cf090a47a2a13cc4814954c497b3d49.tar.gz
podman-0b34b4a59cf090a47a2a13cc4814954c497b3d49.tar.bz2
podman-0b34b4a59cf090a47a2a13cc4814954c497b3d49.zip
Add podman pod prune
podman system prune would leave pods be, and not prune them if they were stopped. Fix this by adding a `podman pod prune` command that prunes stopped pods similarly to containers. Signed-off-by: Peter Hunt <pehunt@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-container-prune.1.md2
-rw-r--r--docs/podman-pod-prune.1.md29
-rw-r--r--docs/podman-pod.1.md31
-rw-r--r--docs/podman-system-prune.1.md4
4 files changed, 48 insertions, 18 deletions
diff --git a/docs/podman-container-prune.1.md b/docs/podman-container-prune.1.md
index 194dd3dae..6fd741a3d 100644
--- a/docs/podman-container-prune.1.md
+++ b/docs/podman-container-prune.1.md
@@ -1,4 +1,4 @@
-% PODMAN(1) Podman Man Pages
+% podman-container-prune (1)
% Brent Baude
% December 2018
# NAME
diff --git a/docs/podman-pod-prune.1.md b/docs/podman-pod-prune.1.md
new file mode 100644
index 000000000..121198de7
--- /dev/null
+++ b/docs/podman-pod-prune.1.md
@@ -0,0 +1,29 @@
+% % podman-pod-prune (1)
+% Peter Hunt
+% April 2019
+# NAME
+podman-pod-prune - Remove all stopped pods
+
+# SYNOPSIS
+**podman pod prune** [*-h*|*--help*]
+
+# DESCRIPTION
+**podman pod prune** removes all stopped pods from local storage.
+
+## Examples ##
+
+Remove all stopped pods from local storage
+```
+$ sudo podman pod prune
+22b8813332948064b6566370088c5e0230eeaf15a58b1c5646859fd9fc364fe7
+2afb26869fe5beab979c234afb75c7506063cd4655b1a73557c9d583ff1aebe9
+49161ad2a722cf18722f0e17199a9e840703a17d1158cdeda502b6d54080f674
+5ca429f37fb83a9f54eea89e3a9102b7780a6e6ae5f132db0672da551d862c4a
+6bb06573787efb8b0675bc88ebf8361f1a56d3ac7922d1a6436d8f59ffd955f1
+```
+
+## SEE ALSO
+podman-pod(1), podman-pod-ps(1), podman-pod-rm(1)
+
+# HISTORY
+April 2019, Originally compiled by Peter Hunt (pehunt at redhat dot com)
diff --git a/docs/podman-pod.1.md b/docs/podman-pod.1.md
index 1846d0411..d11614358 100644
--- a/docs/podman-pod.1.md
+++ b/docs/podman-pod.1.md
@@ -11,21 +11,22 @@ podman pod is a set of subcommands that manage pods, or groups of containers.
## SUBCOMMANDS
-| Command | Man Page | Description |
-| ------- | ------------------------------------------------- | ------------------------------------------------------------------------------ |
-| create | [podman-pod-create(1)](podman-pod-create.1.md) | Create a new pod. |
-| exists | [podman-pod-exists(1)](podman-pod-exists.1.md) | Check if a pod exists in local storage. |
-| inspect | [podman-pod-inspect(1)](podman-pod-inspect.1.md) | Displays information describing a pod. |
-| kill | [podman-pod-kill(1)](podman-pod-kill.1.md) | Kill the main process of each container in pod. |
-| pause | [podman-pod-pause(1)](podman-pod-pause.1.md) | Pause one or more pods. |
-| ps | [podman-pod-ps(1)](podman-pod-ps.1.md) | Prints out information about pods. |
-| restart | [podman-pod-restart(1)](podman-pod-restart.1.md) | Restart one or more pods. |
-| rm | [podman-pod-rm(1)](podman-pod-rm.1.md) | Remove one or more pods. |
-| start | [podman-pod-start(1)](podman-pod-start.1.md) | Start one or more pods. |
-| stats | [podman-pod-stats(1)](podman-pod-stats.1.md) | Display live stream resource usage stats for containers in one or more pods. |
-| stop | [podman-pod-stop(1)](podman-pod-stop.1.md) | Stop one or more pods. |
-| top | [podman-pod-top(1)](podman-pod-top.1.md) | Display the running processes of containers in a pod. |
-| unpause | [podman-pod-unpause(1)](podman-pod-unpause.1.md) | Unpause one or more pods. |
+| Command | Man Page | Description |
+| ------- | -------------------------------------------------------- | ------------------------------------------------------------------------------ |
+| create | [podman-pod-create(1)](podman-pod-create.1.md) | Create a new pod. |
+| exists | [podman-pod-exists(1)](podman-pod-exists.1.md) | Check if a pod exists in local storage. |
+| inspect | [podman-pod-inspect(1)](podman-pod-inspect.1.md) | Displays information describing a pod. |
+| kill | [podman-pod-kill(1)](podman-pod-kill.1.md) | Kill the main process of each container in pod. |
+| pause | [podman-pod-pause(1)](podman-pod-pause.1.md) | Pause one or more pods. |
+| prune | [podman-container-prune(1)](podman-container-prune.1.md) | Remove all stopped containers from local storage. |
+| ps | [podman-pod-ps(1)](podman-pod-ps.1.md) | Prints out information about pods. |
+| restart | [podman-pod-restart(1)](podman-pod-restart.1.md) | Restart one or more pods. |
+| rm | [podman-pod-rm(1)](podman-pod-rm.1.md) | Remove one or more pods. |
+| start | [podman-pod-start(1)](podman-pod-start.1.md) | Start one or more pods. |
+| stats | [podman-pod-stats(1)](podman-pod-stats.1.md) | Display live stream resource usage stats for containers in one or more pods. |
+| stop | [podman-pod-stop(1)](podman-pod-stop.1.md) | Stop one or more pods. |
+| top | [podman-pod-top(1)](podman-pod-top.1.md) | Display the running processes of containers in a pod. |
+| unpause | [podman-pod-unpause(1)](podman-pod-unpause.1.md) | Unpause one or more pods. |
## SEE ALSO
podman(1)
diff --git a/docs/podman-system-prune.1.md b/docs/podman-system-prune.1.md
index 1cdafb774..6a284a110 100644
--- a/docs/podman-system-prune.1.md
+++ b/docs/podman-system-prune.1.md
@@ -11,7 +11,7 @@ podman\-system\-prune - Remove all unused container, image and volume data
[**-volumes**|**--v**]
## DESCRIPTION
-**podman system prune** removes all unused containers, (both dangling and unreferenced) from local storage and optionally, volumes.
+**podman system prune** removes all unused containers (both dangling and unreferenced), pods and optionally, volumes from local storage.
With the `all` option, you can delete all unused images. Unused images are dangling images as well as any image that does not have any containers based on it.
@@ -31,7 +31,7 @@ Do not prompt for confirmation
Prune volumes not used by at least one container
## SEE ALSO
-podman(1), podman-image-prune(1), podman-container-prune(1), podman-volume-prune(1)
+podman(1), podman-image-prune(1), podman-container-prune(1), podman-pod-prune(1), podman-volume-prune(1)
# HISTORY
February 2019, Originally compiled by Dan Walsh (dwalsh at redhat dot com)