diff options
author | baude <bbaude@redhat.com> | 2019-10-24 14:54:57 -0500 |
---|---|---|
committer | baude <bbaude@redhat.com> | 2019-10-31 12:31:39 -0500 |
commit | 52b92023edeba3a5e2c466d92d742e54b14a85cb (patch) | |
tree | 44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/pod.rst | |
parent | 5af166ff513265b17aee92a9ce3a1522090d7dec (diff) | |
download | podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2 podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip |
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man
pages now exist in docs/source/man and the sphinx make files exists in
docs.
Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/pod.rst')
-rw-r--r-- | docs/source/pod.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/source/pod.rst b/docs/source/pod.rst new file mode 100644 index 000000000..94ed9604a --- /dev/null +++ b/docs/source/pod.rst @@ -0,0 +1,30 @@ +Pod +=== + +:doc:`create <man/podman-pod-create.1>` Create a new empty pod + +:doc:`exists <man/podman-pod-exists.1>` Check if a pod exists in local storage + +:doc:`inspect <man/podman-pod-inspect.1>` Displays a pod configuration + +:doc:`kill <man/podman-pod-kill.1>` Send the specified signal or SIGKILL to containers in pod + +:doc:`pause <man/podman-pause.1>` Pause one or more pods + +:doc:`prune <man/podman-pod-prune.1>` Remove all stopped pods + +:doc:`ps <man/podman-pod-ps.1>` List pods + +:doc:`restart <man/podman-pod-restart.1>` Restart one or more pods + +:doc:`rm <man/podman-pod-rm.1>` Remove one or more pods + +:doc:`start <man/podman-pod-start.1>` Start one or more pods + +:doc:`stats <man/podman-pod-stats.1>` Display a live stream of resource usage statistics for the containers in one or more pods + +:doc:`stop <man/podman-pod-stop.1>` Stop one or more pods + +:doc:`top <man/podman-pod-top.1>` Display the running processes of containers in a pod + +:doc:`unpause <man/podman-pod-unpause.1>` Unpause one or more pods |