Merge pull request #4339 from baude/rtdfirstmenu

Initial dump of man pages and first menus

9 files changed, 176 insertions, 0 deletions

diff --git a/docs/rtd/source/man/generate.rst b/docs/rtd/source/man/generate.rst
new file mode 100644
index 000000000..e82a15735
--- /dev/null
+++ b/docs/rtd/source/man/generate.rst
@@ -0,0 +1,6 @@
+Generate
+========
+
+:doc:`kube <podman-generate-kube.1>` Generate Kubernetes pod YAML from a container or pod
+
+:doc:`systemd <podman-generate-systemd.1>` Generate a systemd unit file for a Podman container
diff --git a/docs/rtd/source/man/healthcheck.rst b/docs/rtd/source/man/healthcheck.rst
new file mode 100644
index 000000000..697c1358b
--- /dev/null
+++ b/docs/rtd/source/man/healthcheck.rst
@@ -0,0 +1,4 @@
+HealthCheck
+===========
+
+:doc:`run <podman-healthcheck-run.1>` run the health check of a container
diff --git a/docs/rtd/source/man/image.rst b/docs/rtd/source/man/image.rst
new file mode 100644
index 000000000..ad963cd41
--- /dev/null
+++ b/docs/rtd/source/man/image.rst
@@ -0,0 +1,35 @@
+Image
+=====
+
+
+:doc:`build <podman-build.1>` Build an image using instructions from Containerfiles
+
+:doc:`exists <podman-image-exists.1>` Check if an image exists in local storage
+
+:doc:`history <podman-history.1>` Show history of a specified image
+
+:doc:`import <podman-import.1>` Import a tarball to create a filesystem image
+
+:doc:`inspect <podman-inspect.1>` Display the configuration of an image
+
+:doc:`list <podman-images.1>` List images in local storage
+
+:doc:`load <podman-load.1>` Load an image from container archive
+
+:doc:`prune <podman-image-prune.1>` Remove unused images
+
+:doc:`pull <podman-pull.1>` Pull an image from a registry
+
+:doc:`push <podman-push.1>` Push an image to a specified destination
+
+:doc:`rm <podman-rmi.1>` Removes one or more images from local storage
+
+:doc:`save <podman-save.1>` Save image to an archive
+
+:doc:`sign <podman-image-sign.1>` Sign an image
+
+:doc:`tag <podman-tag.1>` Add an additional name to a local image
+
+:doc:`tree <podman-image-tree.1>` Prints layer hierarchy of an image in a tree format
+
+:doc:`trust <podman-image-trust.1>` Manage container image trust policy
diff --git a/docs/rtd/source/man/managecontainers.rst b/docs/rtd/source/man/managecontainers.rst
new file mode 100644
index 000000000..20e8c0679
--- /dev/null
+++ b/docs/rtd/source/man/managecontainers.rst
@@ -0,0 +1,64 @@
+Manage Containers
+=================
+
+:doc:`attach <podman-attach.1>` Attach to a running container
+
+:doc:`checkpoint <podman-container-checkpoint.1>` Checkpoints one or more containers
+
+:doc:`cleanup <podman-container-cleanup.1>` Cleanup network and mountpoints of one or more containers
+
+:doc:`commit <podman-commit.1>` Create new image based on the changed container
+
+:doc:`cp <podman-cp.1>` Copy files/folders between a container and the local filesystem
+
+:doc:`create <podman-create.1>` Create but do not start a container
+
+:doc:`diff <podman-diff.1>` Inspect changes on container's file systems
+
+:doc:`exec <podman-exec.1>` Run a process in a running container
+
+:doc:`exists <podman-exists.1>` Check if a container exists in local storage
+
+:doc:`export <podman-export.1>` Export container's filesystem contents as a tar archive
+
+:doc:`init <podman-init.1>` Initialize one or more containers
+
+:doc:`inspect <podman-inspect.1>` Display the configuration of a container or image
+
+:doc:`kill <podman-kill.1>` Kill one or more running containers with a specific signal
+
+:doc:`list <podman-ps.1>` List containers
+
+:doc:`logs <podman-logs.1>` Fetch the logs of a container
+
+:doc:`mount <podman-mount.1>` Mount a working container's root filesystem
+
+:doc:`pause <podman-pause.1>` Pause all the processes in one or more containers
+
+:doc:`port <podman-port.1>` List port mappings or a specific mapping for the container
+
+:doc:`restart <podman-restart.1>` Restart one or more containers
+
+:doc:`prune <podman-container-prune.1>` Remove all stopped containers
+
+:doc:`restore <podman-container-restore.1>` Restores one or more containers from a checkpoint
+
+:doc:`rm <podman-rm.1>` Remove one or more containers
+
+:doc:`run <podman-run.1>` Run a command in a new container
+
+:doc:`runlabel <podman-container-runlabel.1>` Execute the command described by an image label
+
+:doc:`start <podman-start.1>` Start one or more containers
+
+:doc:`stats <podman-stats.1>` Display a live stream of container resource usage statistics
+
+:doc:`stop <podman-stop.1>` Stop one or more containers
+
+:doc:`top <podman-top.1>` Display the running processes of a container
+
+:doc:`umount <podman-umount.1>` Unmounts working container's root filesystem
+
+:doc:`unpause <podman-unpause.1>` Unpause the processes in one or more containers
+
+:doc:`wait <podman-wait.1>` Block on one or more containers
diff --git a/docs/rtd/source/man/network.rst b/docs/rtd/source/man/network.rst
new file mode 100644
index 000000000..6d6a4c022
--- /dev/null
+++ b/docs/rtd/source/man/network.rst
@@ -0,0 +1,10 @@
+Network
+=====
+
+:doc:`create <podman-network-create.1>` network create
+
+:doc:`inspect <podman-network-inspect.1>` network inspect
+
+:doc:`ls <podman-network-ls.1>` network list
+
+:doc:`rm <podman-network-rm.1>` network rm
\ No newline at end of file
diff --git a/docs/rtd/source/man/play.rst b/docs/rtd/source/man/play.rst
new file mode 100644
index 000000000..93e1a9a1e
--- /dev/null
+++ b/docs/rtd/source/man/play.rst
@@ -0,0 +1,4 @@
+Play
+====
+
+:doc:`kube <podman-play-kube.1>` Play a pod based on Kubernetes YAML
diff --git a/docs/rtd/source/man/pod.rst b/docs/rtd/source/man/pod.rst
new file mode 100644
index 000000000..13c1740f8
--- /dev/null
+++ b/docs/rtd/source/man/pod.rst
@@ -0,0 +1,30 @@
+Pod
+===
+
+:doc:`create <podman-pod-create.1>` Create a new empty pod
+
+:doc:`exists <podman-pod-exists.1>` Check if a pod exists in local storage
+
+:doc:`inspect <podman-pod-inspect.1>` Displays a pod configuration
+
+:doc:`kill <podman-pod-kill.1>` Send the specified signal or SIGKILL to containers in pod
+
+:doc:`pause <podman-pause.1>` Pause one or more pods
+
+:doc:`prune <podman-pod-prune.1>` Remove all stopped pods
+
+:doc:`ps <podman-pod-ps.1>` List pods
+
+:doc:`restart <podman-pod-restart.1>` Restart one or more pods
+
+:doc:`rm <podman-pod-rm.1>` Remove one or more pods
+
+:doc:`start <podman-pod-start.1>` Start one or more pods
+
+:doc:`stats <podman-pod-stats.1>` Display a live stream of resource usage statistics for the containers in one or more pods
+
+:doc:`stop <podman-pod-stop.1>` Stop one or more pods
+
+:doc:`top <podman-pod-top.1>` Display the running processes of containers in a pod
+
+:doc:`unpause <podman-pod-unpause.1>` Unpause one or more pods
diff --git a/docs/rtd/source/man/system.rst b/docs/rtd/source/man/system.rst
new file mode 100644
index 000000000..764ec01c1
--- /dev/null
+++ b/docs/rtd/source/man/system.rst
@@ -0,0 +1,12 @@
+System
+======
+
+:doc:`df <podman-system-df.1>` Show podman disk usage
+
+:doc:`info <podman-info.1>` Display podman system information
+
+:doc:`migrate <podman-system-migrate.1>` Migrate containers
+
+:doc:`prune <podman-system-prune.1>` Remove unused data
+
+:doc:`renumber <podman-system-renumber.1>` Migrate lock numbers
diff --git a/docs/rtd/source/man/volume.rst b/docs/rtd/source/man/volume.rst
new file mode 100644
index 000000000..ee18e4b2e
--- /dev/null
+++ b/docs/rtd/source/man/volume.rst
@@ -0,0 +1,11 @@
+Volume
+======
+:doc:`create <podman-volume-create.1>` Create a new volume
+
+:doc:`inspect <podman-volume-inspect.1>` Display detailed information on one or more volumes
+
+:doc:`ls <podman-volume-ls.1>` List volumes
+
+:doc:`prune <podman-volume-prune.1>` Remove all unused volumes
+
+:doc:`rm <podman-volume-rm.1>` Remove one or more volumes
\ No newline at end of file