From 52b92023edeba3a5e2c466d92d742e54b14a85cb Mon Sep 17 00:00:00 2001 From: baude Date: Thu, 24 Oct 2019 14:54:57 -0500 Subject: 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 --- docs/source/Commands.rst | 107 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 107 insertions(+) create mode 100644 docs/source/Commands.rst (limited to 'docs/source/Commands.rst') diff --git a/docs/source/Commands.rst b/docs/source/Commands.rst new file mode 100644 index 000000000..bc34da60b --- /dev/null +++ b/docs/source/Commands.rst @@ -0,0 +1,107 @@ +Commands +======== + + +:doc:`attach ` Attach to a running container + +:doc:`build ` Build an image using instructions from Containerfiles + +:doc:`commit ` Create new image based on the changed container + +:doc:`containers ` Manage Containers + +:doc:`cp ` Copy files/folders between a container and the local filesystem + +:doc:`create ` Create but do not start a container + +:doc:`diff ` Inspect changes on container's file systems + +:doc:`events ` Show podman events + +:doc:`exec ` Run a process in a running container + +:doc:`export ` Export container's filesystem contents as a tar archive + +:doc:`generate ` Generated structured data + +:doc:`healthcheck ` Manage Healthcheck + +:doc:`history ` Show history of a specified image + +:doc:`image ` Manage images + +:doc:`images ` List images in local storage + +:doc:`import ` Import a tarball to create a filesystem image + +:doc:`info ` Display podman system information + +:doc:`init ` Initialize one or more containers + +:doc:`inspect ` Display the configuration of a container or image + +:doc:`kill ` Kill one or more running containers with a specific signal + +:doc:`load ` Load an image from container archive + +:doc:`login ` Login to a container registry + +:doc:`logout ` Logout of a container registry + +:doc:`logs ` Fetch the logs of a container + +:doc:`mount ` Mount a working container's root filesystem + +:doc:`network ` Manage Networks + +:doc:`pause ` Pause all the processes in one or more containers + +:doc:`play ` Play a pod + +:doc:`pod ` Manage pods + +:doc:`port ` List port mappings or a specific mapping for the container + +:doc:`ps ` List containers + +:doc:`pull ` Pull an image from a registry + +:doc:`push ` Push an image to a specified destination + +:doc:`restart ` Restart one or more containers + +:doc:`rm ` Remove one or more containers + +:doc:`rmi ` Removes one or more images from local storage + +:doc:`run ` Run a command in a new container + +:doc:`save ` Save image to an archive + +:doc:`search ` Search registry for image + +:doc:`start ` Start one or more containers + +:doc:`stats ` Display a live stream of container resource usage statistics + +:doc:`stop ` Stop one or more containers + +:doc:`system ` Manage podman + +:doc:`tag ` Add an additional name to a local image + +:doc:`top ` Display the running processes of a container + +:doc:`umount ` Unmounts working container's root filesystem + +:doc:`unpause ` Unpause the processes in one or more containers + +:doc:`unshare ` Run a command in a modified user namespace + +:doc:`varlink ` Run varlink interface + +:doc:`version ` Display the Podman Version Information + +:doc:`volume ` Manage volumes + +:doc:`wait ` Block on one or more containers \ No newline at end of file -- cgit v1.2.3-54-g00ecf