diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/Commands.rst | 24 | ||||
| -rw-r--r-- | docs/source/connection.rst | 12 | ||||
| -rw-r--r-- | docs/source/generate.rst | 6 | ||||
| -rw-r--r-- | docs/source/healthcheck.rst | 4 | ||||
| -rw-r--r-- | docs/source/image.rst | 47 | ||||
| -rw-r--r-- | docs/source/machine.rst | 15 | ||||
| -rw-r--r-- | docs/source/managecontainers.rst | 68 | ||||
| -rw-r--r-- | docs/source/manifest.rst | 18 | ||||
| -rw-r--r-- | docs/source/network.rst | 20 | ||||
| -rw-r--r-- | docs/source/play.rst | 4 | ||||
| -rw-r--r-- | docs/source/pod.rst | 32 | ||||
| -rw-r--r-- | docs/source/secret.rst | 9 | ||||
| -rw-r--r-- | docs/source/system.rst | 18 |
13 files changed, 12 insertions, 265 deletions
diff --git a/docs/source/Commands.rst b/docs/source/Commands.rst index 767b09c08..2911efe18 100644 --- a/docs/source/Commands.rst +++ b/docs/source/Commands.rst @@ -13,7 +13,7 @@ Commands :doc:`commit <markdown/podman-commit.1>` Create new image based on the changed container -:doc:`container <managecontainers>` Manage Containers +:doc:`container <markdown/podman-container.1>` Manage Containers :doc:`cp <markdown/podman-cp.1>` Copy files/folders between a container and the local filesystem @@ -27,13 +27,13 @@ Commands :doc:`export <markdown/podman-export.1>` Export container's filesystem contents as a tar archive -:doc:`generate <generate>` Generated structured data +:doc:`generate <markdown/podman-generate.1>` Generated structured data -:doc:`healthcheck <healthcheck>` Manage Healthcheck +:doc:`healthcheck <markdown/podman-healthcheck.1>` Manage Healthcheck :doc:`history <markdown/podman-history.1>` Show history of a specified image -:doc:`image <image>` Manage images +:doc:`image <markdown/podman-image.1>` Manage images :doc:`images <markdown/podman-images.1>` List images in local storage @@ -55,19 +55,19 @@ Commands :doc:`logs <markdown/podman-logs.1>` Fetch the logs of a container -:doc:`machine <machine>` Manage podman's virtual machine +:doc:`machine <markdown/podman-machine.1>` Manage podman's virtual machine -:doc:`manifest <manifest>` Create and manipulate manifest lists and image indexes +:doc:`manifest <markdown/podman-manifest.1>` Create and manipulate manifest lists and image indexes :doc:`mount <markdown/podman-mount.1>` Mount a working container's root filesystem -:doc:`network <network>` Manage Networks +:doc:`network <markdown/podman-network.1>` Manage Networks :doc:`pause <markdown/podman-pause.1>` Pause all the processes in one or more containers -:doc:`play <play>` Play a pod +:doc:`play <markdown/podman-play.1>` Play a pod -:doc:`pod <pod>` Manage pods +:doc:`pod <markdown/podman-pod.1>` Manage pods :doc:`port <markdown/podman-port.1>` List port mappings or a specific mapping for the container @@ -91,7 +91,7 @@ Commands :doc:`search <markdown/podman-search.1>` Search registry for image -:doc:`secret <secret>` Manage podman secrets +:doc:`secret <markdown/podman-secret.1>` Manage podman secrets :doc:`start <markdown/podman-start.1>` Start one or more containers @@ -99,7 +99,7 @@ Commands :doc:`stop <markdown/podman-stop.1>` Stop one or more containers -:doc:`system <system>` Manage podman +:doc:`system <markdown/podman-system.1>` Manage podman :doc:`tag <markdown/podman-tag.1>` Add an additional name to a local image @@ -115,6 +115,6 @@ Commands :doc:`version <markdown/podman-version.1>` Display the Podman Version Information -:doc:`volume <volume>` Manage volumes +:doc:`volume <markdown/podman-volume.1>` Manage volumes :doc:`wait <markdown/podman-wait.1>` Block on one or more containers diff --git a/docs/source/connection.rst b/docs/source/connection.rst deleted file mode 100644 index 64eb18c57..000000000 --- a/docs/source/connection.rst +++ /dev/null @@ -1,12 +0,0 @@ -Manage the destination(s) for Podman service(s) -================= - -:doc:`add <markdown/podman-system-connection-add.1>` Record destination for the Podman service - -:doc:`default <markdown/podman-system-connection-default.1>` Set named destination as default for the Podman service - -:doc:`list <markdown/podman-system-connection-list.1>` List the destination for the Podman service(s) - -:doc:`remove <markdown/podman-system-connection-remove.1>` Delete named destination - -:doc:`rename <markdown/podman-system-connection-rename.1>` Rename the destination for Podman service diff --git a/docs/source/generate.rst b/docs/source/generate.rst deleted file mode 100644 index fd267ce62..000000000 --- a/docs/source/generate.rst +++ /dev/null @@ -1,6 +0,0 @@ -Generate -======== - -:doc:`kube <markdown/podman-generate-kube.1>` Generate Kubernetes pod YAML from a container or pod - -:doc:`systemd <markdown/podman-generate-systemd.1>` Generate a systemd unit file for a Podman container diff --git a/docs/source/healthcheck.rst b/docs/source/healthcheck.rst deleted file mode 100644 index 2e2f88fbc..000000000 --- a/docs/source/healthcheck.rst +++ /dev/null @@ -1,4 +0,0 @@ -HealthCheck -=========== - -:doc:`run <markdown/podman-healthcheck-run.1>` run the health check of a container diff --git a/docs/source/image.rst b/docs/source/image.rst deleted file mode 100644 index 0987a0149..000000000 --- a/docs/source/image.rst +++ /dev/null @@ -1,47 +0,0 @@ -Image -===== - - -:doc:`build <markdown/podman-build.1>` Build an image using instructions from Containerfiles - -:doc:`diff <markdown/podman-image-diff.1>` Inspect changes on an image's filesystem - -:doc:`exists <markdown/podman-image-exists.1>` Check if an image exists in local storage - -:doc:`history <markdown/podman-history.1>` Show history of a specified image - -:doc:`import <markdown/podman-import.1>` Import a tarball to create a filesystem image - -:doc:`inspect <markdown/podman-inspect.1>` Display the configuration of an image - -:doc:`list <markdown/podman-images.1>` List images in local storage - -:doc:`load <markdown/podman-load.1>` Load an image from container archive - -:doc:`mount <markdown/podman-image-mount.1>` Mount an image's root filesystem. - -:doc:`prune <markdown/podman-image-prune.1>` Remove unused images - -:doc:`pull <markdown/podman-pull.1>` Pull an image from a registry - -:doc:`push <markdown/podman-push.1>` Push an image to a specified destination - -:doc:`rm <markdown/podman-rmi.1>` Removes one or more images from local storage - -:doc:`save <markdown/podman-save.1>` Save image to an archive - -:doc:`scp <markdown/podman-image-scp.1>` Securely copy an image from one host to another - -:doc:`search <markdown/podman-search.1>` Search a registry for an image - -:doc:`sign <markdown/podman-image-sign.1>` Sign an image - -:doc:`tag <markdown/podman-tag.1>` Add an additional name to a local image - -:doc:`tree <markdown/podman-image-tree.1>` Prints layer hierarchy of an image in a tree format - -:doc:`trust <markdown/podman-image-trust.1>` Manage container image trust policy - -:doc:`unmount <markdown/podman-image-unmount.1>` Unmount an image's root filesystem - -:doc:`untag <markdown/podman-untag.1>` Removes one or more names from a locally-stored image diff --git a/docs/source/machine.rst b/docs/source/machine.rst deleted file mode 100644 index 3962fca99..000000000 --- a/docs/source/machine.rst +++ /dev/null @@ -1,15 +0,0 @@ -Machine -====== - - -:doc:`init <markdown/podman-machine-init.1>` Initialize a new virtual machine - -:doc:`list <markdown/podman-machine-list.1>` List virtual machines - -:doc:`rm <markdown/podman-machine-rm.1>` Remove a virtual machine - -:doc:`ssh <markdown/podman-machine-ssh.1>` SSH into a virtual machine - -:doc:`start <markdown/podman-machine-start.1>` Start a virtual machine - -:doc:`stop <markdown/podman-machine-stop.1>` Stop a virtual machine diff --git a/docs/source/managecontainers.rst b/docs/source/managecontainers.rst deleted file mode 100644 index 9b3978f25..000000000 --- a/docs/source/managecontainers.rst +++ /dev/null @@ -1,68 +0,0 @@ -Manage Containers -================= - -:doc:`attach <markdown/podman-attach.1>` Attach to a running container - -:doc:`checkpoint <markdown/podman-container-checkpoint.1>` Checkpoints one or more containers - -:doc:`cleanup <markdown/podman-container-cleanup.1>` Cleanup network and mountpoints of one or more containers - -:doc:`commit <markdown/podman-commit.1>` Create new image based on the changed container - -:doc:`cp <markdown/podman-cp.1>` Copy files/folders between a container and the local filesystem - -:doc:`create <markdown/podman-create.1>` Create but do not start a container - -:doc:`diff <markdown/podman-diff.1>` Inspect changes on container's file systems - -:doc:`exec <markdown/podman-exec.1>` Run a process in a running container - -:doc:`exists <markdown/podman-container-exists.1>` Check if a container exists in local storage - -:doc:`export <markdown/podman-export.1>` Export container's filesystem contents as a tar archive - -:doc:`init <markdown/podman-init.1>` Initialize one or more containers - -:doc:`inspect <markdown/podman-inspect.1>` Display the configuration of a container or image - -:doc:`kill <markdown/podman-kill.1>` Kill one or more running containers with a specific signal - -:doc:`list <markdown/podman-ps.1>` List containers - -:doc:`logs <markdown/podman-logs.1>` Fetch the logs of a container - -:doc:`mount <markdown/podman-mount.1>` Mount a working container's root filesystem - -:doc:`pause <markdown/podman-pause.1>` Pause all the processes in one or more containers - -:doc:`port <markdown/podman-port.1>` List port mappings or a specific mapping for the container - -:doc:`prune <markdown/podman-container-prune.1>` Remove all stopped containers - -:doc:`ps <markdown/podman-ps.1>` List containers - -:doc:`rename <markdown/podman-rename.1>` Rename an existing container - -:doc:`restart <markdown/podman-restart.1>` Restart one or more containers - -:doc:`restore <markdown/podman-container-restore.1>` Restores one or more containers from a checkpoint - -:doc:`rm <markdown/podman-rm.1>` Remove one or more containers - -:doc:`run <markdown/podman-run.1>` Run a command in a new container - -:doc:`runlabel <markdown/podman-container-runlabel.1>` Execute the command described by an image label - -:doc:`start <markdown/podman-start.1>` Start one or more containers - -:doc:`stats <markdown/podman-stats.1>` Display a live stream of container resource usage statistics - -:doc:`stop <markdown/podman-stop.1>` Stop one or more containers - -:doc:`top <markdown/podman-top.1>` Display the running processes of a container - -:doc:`unmount <markdown/podman-unmount.1>` Unmounts working container's root filesystem - -:doc:`unpause <markdown/podman-unpause.1>` Unpause the processes in one or more containers - -:doc:`wait <markdown/podman-wait.1>` Block on one or more containers diff --git a/docs/source/manifest.rst b/docs/source/manifest.rst deleted file mode 100644 index f0a06c2c7..000000000 --- a/docs/source/manifest.rst +++ /dev/null @@ -1,18 +0,0 @@ -Create and manipulate manifest lists and image indexes -================= - -:doc:`add <markdown/podman-manifest-add.1>` Add an image to a manifest list or image index - -:doc:`annotate <markdown/podman-manifest-annotate.1>` Add or update information about an entry in a manifest list or image index - -:doc:`create <markdown/podman-manifest-create.1>` Create a manifest list or image index - -:doc:`exists <markdown/podman-manifest-exists.1>` Check if the given manifest list exists in local storage - -:doc:`inspect <markdown/podman-manifest-inspect.1>` Display a manifest list or image index - -:doc:`push <markdown/podman-manifest-push.1>` Push a manifest list or image index to a registry - -:doc:`remove <markdown/podman-manifest-remove.1>` Remove an image from a manifest list or image index - -:doc:`rm <markdown/podman-manifest-rm.1>` Remove manifest list or image index from local storage diff --git a/docs/source/network.rst b/docs/source/network.rst deleted file mode 100644 index eb0c2c7f9..000000000 --- a/docs/source/network.rst +++ /dev/null @@ -1,20 +0,0 @@ -Network -======= - -:doc:`connect <markdown/podman-network-connect.1>` network connect - -:doc:`create <markdown/podman-network-create.1>` network create - -:doc:`disconnect <markdown/podman-network-disconnect.1>` network disconnect - -:doc:`exists <markdown/podman-network-exists.1>` network exists - -:doc:`inspect <markdown/podman-network-inspect.1>` network inspect - -:doc:`ls <markdown/podman-network-ls.1>` network list - -:doc:`prune <markdown/podman-network-prune.1>` network prune - -:doc:`reload <markdown/podman-network-reload.1>` network reload - -:doc:`rm <markdown/podman-network-rm.1>` network rm diff --git a/docs/source/play.rst b/docs/source/play.rst deleted file mode 100644 index 8f00d2f45..000000000 --- a/docs/source/play.rst +++ /dev/null @@ -1,4 +0,0 @@ -Play -==== - -:doc:`kube <markdown/podman-play-kube.1>` Play a pod based on Kubernetes YAML diff --git a/docs/source/pod.rst b/docs/source/pod.rst deleted file mode 100644 index d9ad07d83..000000000 --- a/docs/source/pod.rst +++ /dev/null @@ -1,32 +0,0 @@ -Pod -=== - -:doc:`create <markdown/podman-pod-create.1>` Create a new empty pod - -:doc:`exists <markdown/podman-pod-exists.1>` Check if a pod exists in local storage - -:doc:`inspect <markdown/podman-pod-inspect.1>` Displays a pod configuration - -:doc:`kill <markdown/podman-pod-kill.1>` Send the specified signal or SIGKILL to containers in pod - -:doc:`logs <markdown/podman-pod-logs.1>` Displays logs for pod with one or more containers - -:doc:`pause <markdown/podman-pause.1>` Pause one or more pods - -:doc:`prune <markdown/podman-pod-prune.1>` Remove all stopped pods and their containers - -:doc:`ps <markdown/podman-pod-ps.1>` List pods - -:doc:`restart <markdown/podman-pod-restart.1>` Restart one or more pods - -:doc:`rm <markdown/podman-pod-rm.1>` Remove one or more stopped pods and containers - -:doc:`start <markdown/podman-pod-start.1>` Start one or more pods - -:doc:`stats <markdown/podman-pod-stats.1>` Display a live stream of resource usage statistics for the containers in one or more pods - -:doc:`stop <markdown/podman-pod-stop.1>` Stop one or more pods - -:doc:`top <markdown/podman-pod-top.1>` Display the running processes of containers in a pod - -:doc:`unpause <markdown/podman-pod-unpause.1>` Unpause one or more pods diff --git a/docs/source/secret.rst b/docs/source/secret.rst deleted file mode 100644 index 3825ad1df..000000000 --- a/docs/source/secret.rst +++ /dev/null @@ -1,9 +0,0 @@ -Secret -====== -:doc:`create <markdown/podman-secret-create.1>` Create a new secert - -:doc:`inspect <markdown/podman-secret-inspect.1>` Display detailed information on one or more secrets - -:doc:`ls <markdown/podman-secret-ls.1>` List secrets - -:doc:`rm <markdown/podman-secret-rm.1>` Remove one or more secrets diff --git a/docs/source/system.rst b/docs/source/system.rst deleted file mode 100644 index 566fd1a95..000000000 --- a/docs/source/system.rst +++ /dev/null @@ -1,18 +0,0 @@ -System -====== - -:doc:`connection <connection>` Manage the destination(s) for Podman service(s) - -:doc:`df <markdown/podman-system-df.1>` Show podman disk usage - -:doc:`info <markdown/podman-info.1>` Display podman system information - -:doc:`migrate <markdown/podman-system-migrate.1>` Migrate containers - -:doc:`prune <markdown/podman-system-prune.1>` Remove unused data - -:doc:`renumber <markdown/podman-system-renumber.1>` Migrate lock numbers - -:doc:`reset <markdown/podman-system-reset.1>` Reset podman storage - -:doc:`service <markdown/podman-system-service.1>` Run an API service |