summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2019-02-05 10:41:55 -0800
committerDaniel J Walsh <dwalsh@redhat.com>2019-02-05 10:41:55 -0800
commit74d984e0560b2cb421287395b025687e3aabe118 (patch)
tree97de4a88cb4c201b3a69b15767aa79c55c3a9b6e /docs
parent650e242aa90fcb3f161da6e97921c606d3083215 (diff)
downloadpodman-74d984e0560b2cb421287395b025687e3aabe118.tar.gz
podman-74d984e0560b2cb421287395b025687e3aabe118.tar.bz2
podman-74d984e0560b2cb421287395b025687e3aabe118.zip
Add podman system prune and info commands
We are missing the equivalence of the docker system commands This patch set adds `podman system prune` and `podman system info` Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/links/podman-system-info.11
-rw-r--r--docs/podman-info.1.md4
-rw-r--r--docs/podman-system-prune.1.md37
-rw-r--r--docs/podman-system.1.md20
-rw-r--r--docs/podman.1.md1
5 files changed, 61 insertions, 2 deletions
diff --git a/docs/links/podman-system-info.1 b/docs/links/podman-system-info.1
new file mode 100644
index 000000000..809a71b8b
--- /dev/null
+++ b/docs/links/podman-system-info.1
@@ -0,0 +1 @@
+.so man1/podman-info.1
diff --git a/docs/podman-info.1.md b/docs/podman-info.1.md
index d3a0658c9..a6579ec1f 100644
--- a/docs/podman-info.1.md
+++ b/docs/podman-info.1.md
@@ -1,9 +1,9 @@
-% podman-version(1)
+% podman-info(1)
## NAME
+podman\-system\-info - Display system information
podman\-info - Display system information
-
## SYNOPSIS
**podman info** [*options*]
diff --git a/docs/podman-system-prune.1.md b/docs/podman-system-prune.1.md
new file mode 100644
index 000000000..1cdafb774
--- /dev/null
+++ b/docs/podman-system-prune.1.md
@@ -0,0 +1,37 @@
+% podman-system-prune(1) podman
+
+## NAME
+podman\-system\-prune - Remove all unused container, image and volume data
+
+## SYNOPSIS
+**podman system prune**
+[**-all**|**--a**]
+[**-force**|**--f**]
+[**-help**|**--h**]
+[**-volumes**|**--v**]
+
+## DESCRIPTION
+**podman system prune** removes all unused containers, (both dangling and unreferenced) from local storage and optionally, volumes.
+
+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.
+
+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**
+
+Remove all unused images not just dangling ones.
+
+**--force, -f**
+
+Do not prompt for confirmation
+
+**--volumes**
+
+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)
+
+# HISTORY
+February 2019, Originally compiled by Dan Walsh (dwalsh at redhat dot com)
diff --git a/docs/podman-system.1.md b/docs/podman-system.1.md
new file mode 100644
index 000000000..1b4bccdb9
--- /dev/null
+++ b/docs/podman-system.1.md
@@ -0,0 +1,20 @@
+% podman-system(1)
+
+## NAME
+podman\-system - Manage podman
+
+## SYNOPSIS
+**podman system** *subcommand*
+
+## DESCRIPTION
+The system command allows you to manage the podman systems
+
+## COMMANDS
+
+| Command | Man Page | Description |
+| ------- | --------------------------------------------------- | ---------------------------------------------------------------------------- |
+| info | [podman-system-info(1)](podman-info.1.md) | Displays Podman related system information. |
+| prune | [podman-system-prune(1)](podman-system-prune.1.md) | Remove all unused data |
+
+## SEE ALSO
+podman
diff --git a/docs/podman.1.md b/docs/podman.1.md
index 6200a07f0..51ef00383 100644
--- a/docs/podman.1.md
+++ b/docs/podman.1.md
@@ -162,6 +162,7 @@ the exit codes follow the `chroot` standard, see below:
| [podman-start(1)](podman-start.1.md) | Starts one or more containers. |
| [podman-stats(1)](podman-stats.1.md) | Display a live stream of one or more container's resource usage statistics. |
| [podman-stop(1)](podman-stop.1.md) | Stop one or more running containers. |
+| [podman-system(1)](podman-system.1.md) | Manage podman. |
| [podman-tag(1)](podman-tag.1.md) | Add an additional name to a local image. |
| [podman-top(1)](podman-top.1.md) | Display the running processes of a container. |
| [podman-umount(1)](podman-umount.1.md) | Unmount a working container's root filesystem. |