summaryrefslogtreecommitdiff
path: root/docs/podman-pod.1.md
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2019-02-27 12:51:08 -0500
committerDaniel J Walsh <dwalsh@redhat.com>2019-02-27 16:37:40 -0500
commitb4b7b298fcd444c04283093bde2ef4dff760f9ce (patch)
treed186be5fbddf981e0b9fb1f00fd85cf919fc8fd4 /docs/podman-pod.1.md
parentf1f26f444228381224581609a327f13158740923 (diff)
downloadpodman-b4b7b298fcd444c04283093bde2ef4dff760f9ce.tar.gz
podman-b4b7b298fcd444c04283093bde2ef4dff760f9ce.tar.bz2
podman-b4b7b298fcd444c04283093bde2ef4dff760f9ce.zip
Clean up man pages to match commands
Also add podman-commands.sh to compare man pages to commands. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Diffstat (limited to 'docs/podman-pod.1.md')
-rw-r--r--docs/podman-pod.1.md28
1 files changed, 18 insertions, 10 deletions
diff --git a/docs/podman-pod.1.md b/docs/podman-pod.1.md
index 621348c03..8f8403a40 100644
--- a/docs/podman-pod.1.md
+++ b/docs/podman-pod.1.md
@@ -11,16 +11,24 @@ 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-kill(1)](podman-pod-kill.1.md) | Kill the main process of each container in pod. |
-| [podman-pod-pause(1)](podman-pod-pause.1.md) | Pause one or more pods. |
-| [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. |
-| [podman-pod-start(1)](podman-pod-start.1.md) | Start one or more pods. |
-| [podman-pod-stop(1)](podman-pod-stop.1.md) | Stop one or more pods. |
-| [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. |
+| 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 mode 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)
## HISTORY
July 2018, Originally compiled by Peter Hunt <pehunt@redhat.com>