summaryrefslogtreecommitdiff
path: root/docs/podman-pod.1.md
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2018-07-13 13:57:04 -0400
committerGitHub <noreply@github.com>2018-07-13 13:57:04 -0400
commit827359c8e6b116b839a95460cc1775a11f84b682 (patch)
tree2c75493ec56ff9f882c766c56f128d933b0dab8b /docs/podman-pod.1.md
parent35b7a875fd9747a6f322e12f358aeacea778eae5 (diff)
parenta04a8d1dd4d375ebe5084bac760dc82f88cfc77f (diff)
downloadpodman-827359c8e6b116b839a95460cc1775a11f84b682.tar.gz
podman-827359c8e6b116b839a95460cc1775a11f84b682.tar.bz2
podman-827359c8e6b116b839a95460cc1775a11f84b682.zip
Merge pull request #1065 from haircommander/pod-start-create-rm
Podman pod create/rm/ps commands with man pages and tests
Diffstat (limited to 'docs/podman-pod.1.md')
-rw-r--r--docs/podman-pod.1.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/podman-pod.1.md b/docs/podman-pod.1.md
new file mode 100644
index 000000000..511a5841f
--- /dev/null
+++ b/docs/podman-pod.1.md
@@ -0,0 +1,21 @@
+% podman-pod "1"
+
+## NAME
+podman\-pod - Simple management tool for groups of containers, called pods.
+
+## SYNOPSIS
+**podman pod** *subcommand*
+
+# DESCRIPTION
+podman pod is a set of subcommands that manage pods, or groups of containers.
+
+## SUBCOMMANDS
+
+| Subcommand | Description |
+| ------------------------------------------------- | ------------------------------------------------------------------------------ |
+| [podman-pod-create(1)](podman-pod-create.1.md) | Create a new pod. |
+| [podman-pod-ps(1)](podman-pod-ps.1.md) | Prints out information about pods. |
+| [podman-pod-rm(1)](podman-pod-rm.1.md) | Remove one or more pods. |
+
+## HISTORY
+July 2018, Originally compiled by Peter Hunt <pehunt@redhat.com>