From a180dd43fc4f58a177d41333ad06b16932e55fab Mon Sep 17 00:00:00 2001 From: baude Date: Thu, 24 Oct 2019 09:39:55 -0500 Subject: Initial dump of man pages and first menus Signed-off-by: baude --- docs/rtd/Makefile | 105 +++++++++++++++++++++++++++++- docs/rtd/source/Commands.rst | 107 +++++++++++++++++++++++++++++++ docs/rtd/source/Introduction.rst | 2 + docs/rtd/source/Reference.rst | 2 + docs/rtd/source/Tutorials.rst | 2 + docs/rtd/source/conf.py | 1 + docs/rtd/source/index.rst | 6 ++ docs/rtd/source/man/generate.rst | 6 ++ docs/rtd/source/man/healthcheck.rst | 4 ++ docs/rtd/source/man/image.rst | 35 ++++++++++ docs/rtd/source/man/managecontainers.rst | 64 ++++++++++++++++++ docs/rtd/source/man/network.rst | 10 +++ docs/rtd/source/man/play.rst | 4 ++ docs/rtd/source/man/pod.rst | 30 +++++++++ docs/rtd/source/man/system.rst | 12 ++++ docs/rtd/source/man/volume.rst | 11 ++++ 16 files changed, 400 insertions(+), 1 deletion(-) create mode 100644 docs/rtd/source/Commands.rst create mode 100644 docs/rtd/source/Introduction.rst create mode 100644 docs/rtd/source/Reference.rst create mode 100644 docs/rtd/source/Tutorials.rst create mode 100644 docs/rtd/source/man/generate.rst create mode 100644 docs/rtd/source/man/healthcheck.rst create mode 100644 docs/rtd/source/man/image.rst create mode 100644 docs/rtd/source/man/managecontainers.rst create mode 100644 docs/rtd/source/man/network.rst create mode 100644 docs/rtd/source/man/play.rst create mode 100644 docs/rtd/source/man/pod.rst create mode 100644 docs/rtd/source/man/system.rst create mode 100644 docs/rtd/source/man/volume.rst (limited to 'docs/rtd') diff --git a/docs/rtd/Makefile b/docs/rtd/Makefile index d0c3cbf10..50af6490a 100644 --- a/docs/rtd/Makefile +++ b/docs/rtd/Makefile @@ -12,7 +12,110 @@ BUILDDIR = build help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -.PHONY: help Makefile +clean: + rm -fr build/ + rm -f source/man/podman-*.1.md + +copy: + cp -v ../podman-attach.1.md source/man/ + cp -v ../podman-build.1.md source/man/ + cp -v ../podman-commit.1.md source/man/ + # container + cp -v ../podman-container-checkpoint.1.md source/man/ + cp -v ../podman-container-exists.1.md source/man/ + cp -v ../podman-container-restore.1.md source/man/ + cp -v ../podman-container-cleanup.1.md source/man/ + cp -v ../podman-container-prune.1.md source/man/ + cp -v ../podman-container-runlabel.1.md source/man/ + cp -v ../podman-cp.1.md source/man/ + cp -v ../podman-create.1.md source/man/ + cp -v ../podman-diff.1.md source/man/ + cp -v ../podman-events.1.md source/man/ + cp -v ../podman-exec.1.md source/man/ + cp -v ../podman-export.1.md source/man/ + # generate + cp -v ../podman-generate-systemd.1.md source/man/ + cp -v ../podman-generate-kube.1.md source/man/ + # healthcheck + cp -v ../podman-healthcheck-run.1.md source/man/ + #cp -v ../podman-help.1.md source/ + cp -v ../podman-history.1.md source/man/ + # image + cp -v ../podman-image-prune.1.md source/man/ + cp -v ../podman-image-tree.1.md source/man/ + cp -v ../podman-image-trust.1.md source/man/ + cp -v ../podman-image-exists.1.md source/man/ + cp -v ../podman-image-sign.1.md source/man/ + cp -v ../podman-images.1.md source/man/ + cp -v ../podman-import.1.md source/man/ + cp -v ../podman-info.1.md source/man/ + cp -v ../podman-init.1.md source/man/ + cp -v ../podman-inspect.1.md source/man/ + cp -v ../podman-kill.1.md source/man/ + cp -v ../podman-load.1.md source/man/ + cp -v ../podman-login.1.md source/man/ + cp -v ../podman-logout.1.md source/man/ + cp -v ../podman-logs.1.md source/man/ + cp -v ../podman-mount.1.md source/man/ + # network + cp -v ../podman-network-create.1.md source/man/ + cp -v ../podman-network-ls.1.md source/man/ + cp -v ../podman-network-inspect.1.md source/man/ + cp -v ../podman-network-rm.1.md source/man/ + cp -v ../podman-pause.1.md source/man/ + # play + cp -v ../podman-play-kube.1.md source/man/ + # pod + cp -v ../podman-pod-create.1.md source/man/ + cp -v ../podman-pod-pause.1.md source/man/ + cp -v ../podman-pod-rm.1.md source/man/ + cp -v ../podman-pod-top.1.md source/man/ + cp -v ../podman-pod-exists.1.md source/man/ + cp -v ../podman-pod-prune.1.md source/man/ + cp -v ../podman-pod-start.1.md source/man/ + cp -v ../podman-pod-unpause.1.md source/man/ + cp -v ../podman-pod-inspect.1.md source/man/ + cp -v ../podman-pod-ps.1.md source/man/ + cp -v ../podman-pod-stats.1.md source/man/ + cp -v ../podman-pod-kill.1.md source/man/ + cp -v ../podman-pod-restart.1.md source/man/ + cp -v ../podman-pod-stop.1.md source/man/ + cp -v ../podman-port.1.md source/man/ + cp -v ../podman-ps.1.md source/man/ + cp -v ../podman-pull.1.md source/man/ + cp -v ../podman-push.1.md source/man/ + cp -v ../podman-restart.1.md source/man/ + cp -v ../podman-rm.1.md source/man/ + cp -v ../podman-rmi.1.md source/man/ + cp -v ../podman-run.1.md source/man/ + cp -v ../podman-save.1.md source/man/ + cp -v ../podman-search.1.md source/man/ + cp -v ../podman-start.1.md source/man/ + cp -v ../podman-stats.1.md source/man/ + cp -v ../podman-stop.1.md source/man/ + # system + cp -v ../podman-system-migrate.1.md source/man/ + cp -v ../podman-system-renumber.1.md source/man/ + cp -v ../podman-system-df.1.md source/man/ + cp -v ../podman-system-prune.1.md source/man/ + cp -v ../podman-top.1.md source/man/ + cp -v ../podman-umount.1.md source/man/ + cp -v ../podman-unpause.1.md source/man/ + cp -v ../podman-unshare.1.md source/man/ + cp -v ../podman-varlink.1.md source/man/ + cp -v ../podman-version.1.md source/man/ + # volume + cp -v ../podman-volume-inspect.1.md source/man/ + cp -v ../podman-volume-prune.1.md source/man/ + cp -v ../podman-volume-create.1.md source/man/ + cp -v ../podman-volume-ls.1.md source/man/ + cp -v ../podman-volume-rm.1.md source/man/ + cp -v ../podman-wait.1.md source/man/ + +.PHONY: help Makefile copy + +html: copy + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). diff --git a/docs/rtd/source/Commands.rst b/docs/rtd/source/Commands.rst new file mode 100644 index 000000000..f6ba5b20d --- /dev/null +++ b/docs/rtd/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 diff --git a/docs/rtd/source/Introduction.rst b/docs/rtd/source/Introduction.rst new file mode 100644 index 000000000..c516b3317 --- /dev/null +++ b/docs/rtd/source/Introduction.rst @@ -0,0 +1,2 @@ +Introduction +============ diff --git a/docs/rtd/source/Reference.rst b/docs/rtd/source/Reference.rst new file mode 100644 index 000000000..9a771c87f --- /dev/null +++ b/docs/rtd/source/Reference.rst @@ -0,0 +1,2 @@ +Reference +========= diff --git a/docs/rtd/source/Tutorials.rst b/docs/rtd/source/Tutorials.rst new file mode 100644 index 000000000..0c7e28c3b --- /dev/null +++ b/docs/rtd/source/Tutorials.rst @@ -0,0 +1,2 @@ +Tutorials +========= diff --git a/docs/rtd/source/conf.py b/docs/rtd/source/conf.py index 9290c343a..d95290f72 100644 --- a/docs/rtd/source/conf.py +++ b/docs/rtd/source/conf.py @@ -39,6 +39,7 @@ templates_path = ['_templates'] # This pattern also affects html_static_path and html_extra_path. exclude_patterns = [] +master_doc = 'index' # -- Options for HTML output ------------------------------------------------- diff --git a/docs/rtd/source/index.rst b/docs/rtd/source/index.rst index 90033056c..9dd61a6a6 100644 --- a/docs/rtd/source/index.rst +++ b/docs/rtd/source/index.rst @@ -10,6 +10,12 @@ Welcome to Podman's documentation! :maxdepth: 2 :caption: Contents: + Introduction + Commands + Reference + Tutorials + + Indices and tables 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 ` Generate Kubernetes pod YAML from a container or pod + +:doc:`systemd ` 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 ` 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 ` Build an image using instructions from Containerfiles + +:doc:`exists ` Check if an image exists in local storage + +:doc:`history ` Show history of a specified image + +:doc:`import ` Import a tarball to create a filesystem image + +:doc:`inspect ` Display the configuration of an image + +:doc:`list ` List images in local storage + +:doc:`load ` Load an image from container archive + +:doc:`prune ` Remove unused images + +:doc:`pull ` Pull an image from a registry + +:doc:`push ` Push an image to a specified destination + +:doc:`rm ` Removes one or more images from local storage + +:doc:`save ` Save image to an archive + +:doc:`sign ` Sign an image + +:doc:`tag ` Add an additional name to a local image + +:doc:`tree ` Prints layer hierarchy of an image in a tree format + +:doc:`trust ` 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 ` Attach to a running container + +:doc:`checkpoint ` Checkpoints one or more containers + +:doc:`cleanup ` Cleanup network and mountpoints of one or more containers + +:doc:`commit ` Create new image based on the changed container + +: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:`exec ` Run a process in a running container + +:doc:`exists ` Check if a container exists in local storage + +:doc:`export ` Export container's filesystem contents as a tar archive + +: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:`list ` List containers + +:doc:`logs ` Fetch the logs of a container + +:doc:`mount ` Mount a working container's root filesystem + +:doc:`pause ` Pause all the processes in one or more containers + +:doc:`port ` List port mappings or a specific mapping for the container + +:doc:`restart ` Restart one or more containers + +:doc:`prune ` Remove all stopped containers + +:doc:`restore ` Restores one or more containers from a checkpoint + +:doc:`rm ` Remove one or more containers + +:doc:`run ` Run a command in a new container + +:doc:`runlabel ` Execute the command described by an image label + +: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:`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:`wait ` 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 ` network create + +:doc:`inspect ` network inspect + +:doc:`ls ` network list + +:doc:`rm ` 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 ` 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 ` Create a new empty pod + +:doc:`exists ` Check if a pod exists in local storage + +:doc:`inspect ` Displays a pod configuration + +:doc:`kill ` Send the specified signal or SIGKILL to containers in pod + +:doc:`pause ` Pause one or more pods + +:doc:`prune ` Remove all stopped pods + +:doc:`ps ` List pods + +:doc:`restart ` Restart one or more pods + +:doc:`rm ` Remove one or more pods + +:doc:`start ` Start one or more pods + +:doc:`stats ` Display a live stream of resource usage statistics for the containers in one or more pods + +:doc:`stop ` Stop one or more pods + +:doc:`top ` Display the running processes of containers in a pod + +:doc:`unpause ` 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 ` Show podman disk usage + +:doc:`info ` Display podman system information + +:doc:`migrate ` Migrate containers + +:doc:`prune ` Remove unused data + +:doc:`renumber ` 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 ` Create a new volume + +:doc:`inspect ` Display detailed information on one or more volumes + +:doc:`ls ` List volumes + +:doc:`prune ` Remove all unused volumes + +:doc:`rm ` Remove one or more volumes \ No newline at end of file -- cgit v1.2.3-54-g00ecf