summaryrefslogtreecommitdiff
path: root/docs/source/managecontainers.rst
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/managecontainers.rst
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-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/managecontainers.rst')
-rw-r--r--docs/source/managecontainers.rst64
1 files changed, 64 insertions, 0 deletions
diff --git a/docs/source/managecontainers.rst b/docs/source/managecontainers.rst
new file mode 100644
index 000000000..0607f129d
--- /dev/null
+++ b/docs/source/managecontainers.rst
@@ -0,0 +1,64 @@
+Manage Containers
+=================
+
+:doc:`attach <man/podman-attach.1>` Attach to a running container
+
+:doc:`checkpoint <man/podman-container-checkpoint.1>` Checkpoints one or more containers
+
+:doc:`cleanup <man/podman-container-cleanup.1>` Cleanup network and mountpoints of one or more containers
+
+:doc:`commit <man/podman-commit.1>` Create new image based on the changed container
+
+:doc:`cp <man/podman-cp.1>` Copy files/folders between a container and the local filesystem
+
+:doc:`create <man/podman-create.1>` Create but do not start a container
+
+:doc:`diff <man/podman-diff.1>` Inspect changes on container's file systems
+
+:doc:`exec <man/podman-exec.1>` Run a process in a running container
+
+:doc:`exists <man/podman-container-exists.1>` Check if a container exists in local storage
+
+:doc:`export <man/podman-export.1>` Export container's filesystem contents as a tar archive
+
+:doc:`init <man/podman-init.1>` Initialize one or more containers
+
+:doc:`inspect <man/podman-inspect.1>` Display the configuration of a container or image
+
+:doc:`kill <man/podman-kill.1>` Kill one or more running containers with a specific signal
+
+:doc:`list <man/podman-ps.1>` List containers
+
+:doc:`logs <man/podman-logs.1>` Fetch the logs of a container
+
+:doc:`mount <man/podman-mount.1>` Mount a working container's root filesystem
+
+:doc:`pause <man/podman-pause.1>` Pause all the processes in one or more containers
+
+:doc:`port <man/podman-port.1>` List port mappings or a specific mapping for the container
+
+:doc:`restart <man/podman-restart.1>` Restart one or more containers
+
+:doc:`prune <man/podman-container-prune.1>` Remove all stopped containers
+
+:doc:`restore <man/podman-container-restore.1>` Restores one or more containers from a checkpoint
+
+:doc:`rm <man/podman-rm.1>` Remove one or more containers
+
+:doc:`run <man/podman-run.1>` Run a command in a new container
+
+:doc:`runlabel <man/podman-container-runlabel.1>` Execute the command described by an image label
+
+:doc:`start <man/podman-start.1>` Start one or more containers
+
+:doc:`stats <man/podman-stats.1>` Display a live stream of container resource usage statistics
+
+:doc:`stop <man/podman-stop.1>` Stop one or more containers
+
+:doc:`top <man/podman-top.1>` Display the running processes of a container
+
+:doc:`umount <man/podman-umount.1>` Unmounts working container's root filesystem
+
+:doc:`unpause <man/podman-unpause.1>` Unpause the processes in one or more containers
+
+:doc:`wait <man/podman-wait.1>` Block on one or more containers