diff options
| author | Ryan Whalen <rj.whalen@gmail.com> | 2019-08-30 10:09:50 -0400 |
|---|---|---|
| committer | Ryan Whalen <rj.whalen@gmail.com> | 2019-08-30 12:00:19 -0400 |
| commit | e35a5a674db5b1369b6c295d8f694ad4694eab8e (patch) | |
| tree | c297f002c237f27812a35023550fe9d89cdce221 /docs | |
| parent | 8ba21acd459069cd53b492d46736b85c3436296b (diff) | |
| download | podman-e35a5a674db5b1369b6c295d8f694ad4694eab8e.tar.gz podman-e35a5a674db5b1369b6c295d8f694ad4694eab8e.tar.bz2 podman-e35a5a674db5b1369b6c295d8f694ad4694eab8e.zip | |
Fix formatting and enable hack/man-page-checker
Signed-off-by: Ryan Whalen <rj.whalen@gmail.com>
Diffstat (limited to 'docs')
39 files changed, 70 insertions, 69 deletions
diff --git a/docs/links/podman-image-rm.1 b/docs/links/podman-image-rm.1 index 6dfc6e98c..1007ad150 100644 --- a/docs/links/podman-image-rm.1 +++ b/docs/links/podman-image-rm.1 @@ -1 +1 @@ -.so man1/podman-rm.1 +.so man1/podman-rmi.1 diff --git a/docs/podman-container-cleanup.1.md b/docs/podman-container-cleanup.1.md index f6bb84113..69e21ce9f 100644 --- a/docs/podman-container-cleanup.1.md +++ b/docs/podman-container-cleanup.1.md @@ -1,7 +1,7 @@ % podman-container-cleanup(1) ## NAME -podman\-container\-cleanup - Cleanup Container storage and networks +podman\-container\-cleanup - Cleanup the container's network and mountpoints ## SYNOPSIS **podman container cleanup** [*options*] *container* diff --git a/docs/podman-container-prune.1.md b/docs/podman-container-prune.1.md index 26c6b0b49..d8a4b7f4e 100644 --- a/docs/podman-container-prune.1.md +++ b/docs/podman-container-prune.1.md @@ -1,7 +1,7 @@ % podman-container-prune(1) ## NAME -podman-container-prune - Remove all stopped containers +podman-container-prune - Remove all stopped containers from local storage ## SYNOPSIS **podman container prune** [*options*] diff --git a/docs/podman-container-restore.1.md b/docs/podman-container-restore.1.md index a49cb7421..1d2cf0b3e 100644 --- a/docs/podman-container-restore.1.md +++ b/docs/podman-container-restore.1.md @@ -1,7 +1,7 @@ % podman-container-restore(1) ## NAME -podman\-container\-restore - Restores one or more running containers +podman\-container\-restore - Restores one or more containers from a checkpoint ## SYNOPSIS **podman container restore** [*options*] *container* ... diff --git a/docs/podman-container-runlabel.1.md b/docs/podman-container-runlabel.1.md index c16d8c3f4..8511dd5cd 100644 --- a/docs/podman-container-runlabel.1.md +++ b/docs/podman-container-runlabel.1.md @@ -1,10 +1,10 @@ % podman-container-runlabel(1) ## NAME -podman-container-runlabel - Execute Image Label Method +podman-container-runlabel - Executes a command as described by a container image label ## SYNOPSIS -**podman container runlabel** [*options*] *LABEL* *IMAGE* [ARG...] +**podman container runlabel** [*options*] *label* *image* [*arg...*] ## DESCRIPTION **podman container runlabel** reads the provided `LABEL` field in the container diff --git a/docs/podman-container.1.md b/docs/podman-container.1.md index eb53149bd..4ea7c7acc 100644 --- a/docs/podman-container.1.md +++ b/docs/podman-container.1.md @@ -14,8 +14,8 @@ The container command allows you to manage containers | Command | Man Page | Description | | --------- | --------------------------------------------------- | ---------------------------------------------------------------------------- | | attach | [podman-attach(1)](podman-attach.1.md) | Attach to a running container. | -| checkpoint | [podman-container-checkpoint(1)](podman-container-checkpoint.1.md) | Checkpoints one or more containers. | -| cleanup | [podman-container-cleanup(1)](podman-container-cleanup.1.md) | Cleanup containers network and mountpoints. | +| checkpoint | [podman-container-checkpoint(1)](podman-container-checkpoint.1.md) | Checkpoints one or more running containers. | +| cleanup | [podman-container-cleanup(1)](podman-container-cleanup.1.md) | Cleanup the container's network and mountpoints. | | commit | [podman-commit(1)](podman-commit.1.md) | Create new image based on the changed container. | | cp | [podman-cp(1)](podman-cp.1.md) | Copy files/folders between a container and the local filesystem. | | create | [podman-create(1)](podman-create.1.md) | Create a new container. | diff --git a/docs/podman-generate-kube.1.md b/docs/podman-generate-kube.1.md index 93f746664..8f15e14ba 100644 --- a/docs/podman-generate-kube.1.md +++ b/docs/podman-generate-kube.1.md @@ -1,6 +1,6 @@ % podman-generate-kube(1) ## NAME -podman-generate-kube - Generate Kubernetes YAML +podman-generate-kube - Generate Kubernetes YAML based on a pod or container ## SYNOPSIS **podman generate kube** [*options*] *container* | *pod* diff --git a/docs/podman-generate-systemd.1.md b/docs/podman-generate-systemd.1.md index b4962f28b..b81e68a46 100644 --- a/docs/podman-generate-systemd.1.md +++ b/docs/podman-generate-systemd.1.md @@ -1,7 +1,7 @@ % podman-generate-systemd(1) ## NAME -podman-generate-systemd- Generate Systemd Unit file +podman\-generate\-systemd - Generate systemd unit file(s) for a container. Not supported for the remote client ## SYNOPSIS **podman generate systemd** [*options*] *container|pod* diff --git a/docs/podman-image-prune.1.md b/docs/podman-image-prune.1.md index 52278746d..b844a9f63 100644 --- a/docs/podman-image-prune.1.md +++ b/docs/podman-image-prune.1.md @@ -1,7 +1,7 @@ % podman-image-prune(1) ## NAME -podman-image-prune - Remove all unused images +podman-image-prune - Remove all unused images from the local store ## SYNOPSIS **podman image prune** [*options*] diff --git a/docs/podman-image-trust.1.md b/docs/podman-image-trust.1.md index 7c5b70833..b35e883d7 100644 --- a/docs/podman-image-trust.1.md +++ b/docs/podman-image-trust.1.md @@ -5,7 +5,7 @@ podman\-image\-trust - Manage container registry image trust policy ## SYNOPSIS -**podman image trust** set|show [*options*] *REGISTRY[/REPOSITORY]* +**podman image trust** set|show [*options*] *registry[/repository]* ## DESCRIPTION Manages which registries you trust as a source of container images based on its location. The location is determined diff --git a/docs/podman-image.1.md b/docs/podman-image.1.md index 01cf08d62..339a531dd 100644 --- a/docs/podman-image.1.md +++ b/docs/podman-image.1.md @@ -25,10 +25,10 @@ The image command allows you to manage images | push | [podman-push(1)](podman-push.1.md) | Push an image from local storage to elsewhere. | | rm | [podman-rmi(1)](podman-rmi.1.md) | Removes one or more locally stored images. | | save | [podman-save(1)](podman-save.1.md) | Save an image to docker-archive or oci. | -| sign | [podman-image-sign(1)](podman-image-sign.1.md) | Sign an image. | +| sign | [podman-image-sign(1)](podman-image-sign.1.md) | Create a signature for an image. | | tag | [podman-tag(1)](podman-tag.1.md) | Add an additional name to a local image. | | tree | [podman-image-tree(1)](podman-image-tree.1.md) | Prints layer hierarchy of an image in a tree format. | -| trust | [podman-image-trust(1)](podman-image-trust.1.md)| Manage container image trust policy. | +| trust | [podman-image-trust(1)](podman-image-trust.1.md)| Manage container registry image trust policy. | ## SEE ALSO podman diff --git a/docs/podman-info.1.md b/docs/podman-info.1.md index a7b259c95..9721755ef 100644 --- a/docs/podman-info.1.md +++ b/docs/podman-info.1.md @@ -1,12 +1,12 @@ % podman-info(1) ## NAME -podman\-system\-info - Display system information -podman\-info - Display system information +podman\-info - Displays Podman related system information ## SYNOPSIS **podman info** [*options*] +**podman system info** [*options*] ## DESCRIPTION diff --git a/docs/podman-kill.1.md b/docs/podman-kill.1.md index 118246fdb..5144511fb 100644 --- a/docs/podman-kill.1.md +++ b/docs/podman-kill.1.md @@ -1,7 +1,7 @@ % podman-kill(1) ## NAME -podman\-kill - Kills one or more containers with a signal +podman\-kill - Kill the main process in one or more containers ## SYNOPSIS **podman kill** [*options*] [*container* ...] diff --git a/docs/podman-logs.1.md b/docs/podman-logs.1.md index 310eff438..405f180d9 100644 --- a/docs/podman-logs.1.md +++ b/docs/podman-logs.1.md @@ -1,13 +1,13 @@ % podman-logs(1) ## NAME -podman\-container\-logs (podman\-logs) - Fetch the logs of one or more containers +podman\-logs - Display the logs of one or more containers ## SYNOPSIS -**podman container logs** [*options*] *container* [*container...*] - **podman logs** [*options*] *container* [*container...*] +**podman container logs** [*options*] *container* [*container...*] + ## DESCRIPTION The podman logs command batch-retrieves whatever logs are present for one or more containers at the time of execution. This does not guarantee execution order when combined with podman run (i.e. your run may not have generated diff --git a/docs/podman-mount.1.md b/docs/podman-mount.1.md index 2722f460c..5748fc804 100644 --- a/docs/podman-mount.1.md +++ b/docs/podman-mount.1.md @@ -1,7 +1,7 @@ % podman-mount(1) ## NAME -podman\-mount - Mount the specified working containers' root filesystem +podman\-mount - Mount a working container's root filesystem ## SYNOPSIS **podman mount** [*container* ...] diff --git a/docs/podman-network-inspect.1.md b/docs/podman-network-inspect.1.md index 576e61c79..dfa7e4b0c 100644 --- a/docs/podman-network-inspect.1.md +++ b/docs/podman-network-inspect.1.md @@ -1,7 +1,7 @@ % podman-network-inspect(1) ## NAME -podman\-network-inspect- Inspect one or more Podman networks +podman\-network\-inspect - Displays the raw CNI network configuration for one or more networks ## SYNOPSIS **podman network inspect** [*network* ...] diff --git a/docs/podman-network-ls.1.md b/docs/podman-network-ls.1.md index 725e07dbb..658b86c21 100644 --- a/docs/podman-network-ls.1.md +++ b/docs/podman-network-ls.1.md @@ -1,7 +1,7 @@ % podman-network-ls(1) ## NAME -podman\-network-ls- Display a summary of CNI networks +podman\-network\-ls - Display a summary of CNI networks ## SYNOPSIS **podman network ls** [*options*] diff --git a/docs/podman-network-rm.1.md b/docs/podman-network-rm.1.md index f72d6a694..c95c93cd8 100644 --- a/docs/podman-network-rm.1.md +++ b/docs/podman-network-rm.1.md @@ -1,7 +1,7 @@ % podman-network-rm(1) ## NAME -podman\-network-rm- Delete a Podman CNI network +podman\-network\-rm - Remove one or more CNI networks ## SYNOPSIS **podman network rm** [*network...*] diff --git a/docs/podman-network.1.md b/docs/podman-network.1.md index c01adc23e..c9f6725a3 100644 --- a/docs/podman-network.1.md +++ b/docs/podman-network.1.md @@ -1,7 +1,7 @@ % podman-network(1) ## NAME -podman\-network- Manage podman CNI networks +podman\-network - Manage Podman CNI networks ## SYNOPSIS **podman network** *subcommand* diff --git a/docs/podman-play-kube.1.md b/docs/podman-play-kube.1.md index 8b78c83d0..2ac860a32 100644 --- a/docs/podman-play-kube.1.md +++ b/docs/podman-play-kube.1.md @@ -4,7 +4,7 @@ podman-play-kube - Create pods and containers based on Kubernetes YAML ## SYNOPSIS -**podman play kube** [*options*] *file***.yml** +**podman play kube** [*options*] *file*__.yml__ ## DESCRIPTION **podman play kube** will read in a structured file of Kubernetes YAML. It will then recreate diff --git a/docs/podman-play.1.md b/docs/podman-play.1.md index f0bf8ea41..364baad60 100644 --- a/docs/podman-play.1.md +++ b/docs/podman-play.1.md @@ -14,7 +14,7 @@ file input. Containers will be automatically started. | Command | Man Page | Description | | ------- | --------------------------------------------------- | ---------------------------------------------------------------------------- | -| kube | [podman-play-kube(1)](podman-play-kube.1.md) | Recreate pods and containers based on Kubernetes YAML. | +| kube | [podman-play-kube(1)](podman-play-kube.1.md) | Create pods and containers based on Kubernetes YAML. | ## SEE ALSO podman, podman-pod(1), podman-container(1), podman-generate(1), podman-play(1), podman-play-kube(1) diff --git a/docs/podman-pod-kill.1.md b/docs/podman-pod-kill.1.md index 069db70d2..596e15cea 100644 --- a/docs/podman-pod-kill.1.md +++ b/docs/podman-pod-kill.1.md @@ -1,7 +1,7 @@ % podman-pod-kill(1) ## NAME -podman\-pod\-kill - Kills all containers in one or more pods with a signal +podman\-pod\-kill - Kill the main process of each container in one or more pods ## SYNOPSIS **podman pod kill** [*options*] *pod* ... diff --git a/docs/podman-pod-stats.1.md b/docs/podman-pod-stats.1.md index 12fc83cff..962edbda0 100644 --- a/docs/podman-pod-stats.1.md +++ b/docs/podman-pod-stats.1.md @@ -1,7 +1,7 @@ % podman-pod-stats(1) ## NAME -podman\-pod\-stats - Display a live stream of resource usage statistics for the containers in one or more pods +podman\-pod\-stats - Display a live stream of resource usage stats for containers in one or more pods ## SYNOPSIS **podman pod stats** [*options*] [*pod*] diff --git a/docs/podman-pod.1.md b/docs/podman-pod.1.md index d11614358..f28b2271b 100644 --- a/docs/podman-pod.1.md +++ b/docs/podman-pod.1.md @@ -1,7 +1,7 @@ % podman-pod(1) ## NAME -podman\-pod - Simple management tool for groups of containers, called pods. +podman\-pod - Management tool for groups of containers, called pods ## SYNOPSIS **podman pod** *subcommand* @@ -11,22 +11,22 @@ podman pod is a set of subcommands that manage pods, or groups of containers. ## SUBCOMMANDS -| Command | Man Page | Description | -| ------- | -------------------------------------------------------- | ------------------------------------------------------------------------------ | -| create | [podman-pod-create(1)](podman-pod-create.1.md) | Create a new pod. | -| exists | [podman-pod-exists(1)](podman-pod-exists.1.md) | Check if a pod exists in local storage. | -| inspect | [podman-pod-inspect(1)](podman-pod-inspect.1.md) | Displays information describing a pod. | -| kill | [podman-pod-kill(1)](podman-pod-kill.1.md) | Kill the main process of each container in pod. | -| pause | [podman-pod-pause(1)](podman-pod-pause.1.md) | Pause one or more pods. | -| prune | [podman-container-prune(1)](podman-container-prune.1.md) | Remove all stopped containers from local storage. | -| ps | [podman-pod-ps(1)](podman-pod-ps.1.md) | Prints out information about pods. | -| restart | [podman-pod-restart(1)](podman-pod-restart.1.md) | Restart one or more pods. | -| rm | [podman-pod-rm(1)](podman-pod-rm.1.md) | Remove one or more pods. | -| start | [podman-pod-start(1)](podman-pod-start.1.md) | Start one or more pods. | -| stats | [podman-pod-stats(1)](podman-pod-stats.1.md) | Display live stream resource usage stats for containers in one or more pods. | -| stop | [podman-pod-stop(1)](podman-pod-stop.1.md) | Stop one or more pods. | -| top | [podman-pod-top(1)](podman-pod-top.1.md) | Display the running processes of containers in a pod. | -| unpause | [podman-pod-unpause(1)](podman-pod-unpause.1.md) | Unpause one or more pods. | +| Command | Man Page | Description | +| ------- | ------------------------------------------------- | --------------------------------------------------------------------------------- | +| create | [podman-pod-create(1)](podman-pod-create.1.md) | Create a new pod. | +| exists | [podman-pod-exists(1)](podman-pod-exists.1.md) | Check if a pod exists in local storage. | +| inspect | [podman-pod-inspect(1)](podman-pod-inspect.1.md) | Displays information describing a pod. | +| kill | [podman-pod-kill(1)](podman-pod-kill.1.md) | Kill the main process of each container in one or more pods. | +| pause | [podman-pod-pause(1)](podman-pod-pause.1.md) | Pause one or more pods. | +| prune | [podman-pod-prune(1)](podman-pod-prune.1.md) | Remove all stopped pods. | +| ps | [podman-pod-ps(1)](podman-pod-ps.1.md) | Prints out information about pods. | +| restart | [podman-pod-restart(1)](podman-pod-restart.1.md) | Restart one or more pods. | +| rm | [podman-pod-rm(1)](podman-pod-rm.1.md) | Remove one or more pods. | +| start | [podman-pod-start(1)](podman-pod-start.1.md) | Start one or more pods. | +| stats | [podman-pod-stats(1)](podman-pod-stats.1.md) | Display a live stream of resource usage stats for containers in one or more pods. | +| stop | [podman-pod-stop(1)](podman-pod-stop.1.md) | Stop one or more pods. | +| top | [podman-pod-top(1)](podman-pod-top.1.md) | Display the running processes of containers in a pod. | +| unpause | [podman-pod-unpause(1)](podman-pod-unpause.1.md) | Unpause one or more pods. | ## SEE ALSO podman(1) diff --git a/docs/podman-remote.1.md b/docs/podman-remote.1.md index 84042a842..75ae7c166 100644 --- a/docs/podman-remote.1.md +++ b/docs/podman-remote.1.md @@ -1,7 +1,7 @@ % podman-remote(1) ## NAME -podman-remote - A remote CLI for Podman: A Simple management tool for pods, containers and images. +podman-remote - A tool for remote management of pods, containers and images ## SYNOPSIS **podman-remote** [*options*] *command* diff --git a/docs/podman-rm.1.md b/docs/podman-rm.1.md index 7f39c09ad..88339af16 100644 --- a/docs/podman-rm.1.md +++ b/docs/podman-rm.1.md @@ -1,13 +1,13 @@ % podman-rm(1) ## NAME -podman\-container\-rm (podman\-rm) - Remove one or more containers +podman\-rm - Remove one or more containers ## SYNOPSIS -**podman container rm** [*options*] *container* - **podman rm** [*options*] *container* +**podman container rm** [*options*] *container* + ## DESCRIPTION **podman rm** will remove one or more containers from the host. The container name or ID can be used. This does not remove images. Running containers will not be removed without the `-f` option diff --git a/docs/podman-rmi.1.md b/docs/podman-rmi.1.md index 6b242c94e..d911ee6cb 100644 --- a/docs/podman-rmi.1.md +++ b/docs/podman-rmi.1.md @@ -1,13 +1,13 @@ % podman-rmi(1) ## NAME -podman\-image\-rm (podman\-rmi) - Removes one or more images +podman\-rmi - Removes one or more locally stored images ## SYNOPSIS -**podman image rm** *image* [...] - **podman rmi** *image* [...] +**podman image rm** *image* [...] + ## DESCRIPTION Removes one or more locally stored images. diff --git a/docs/podman-stats.1.md b/docs/podman-stats.1.md index 2f604644f..49a3c5ac1 100644 --- a/docs/podman-stats.1.md +++ b/docs/podman-stats.1.md @@ -1,7 +1,7 @@ % podman-stats(1) ## NAME -podman\-stats - Display a live stream of 1 or more containers' resource usage statistics +podman\-stats - Display a live stream of one or more container's resource usage statistics ## SYNOPSIS **podman stats** [*options*] [*container*] diff --git a/docs/podman-stop.1.md b/docs/podman-stop.1.md index e2c4e8b44..d7ad41e30 100644 --- a/docs/podman-stop.1.md +++ b/docs/podman-stop.1.md @@ -1,7 +1,7 @@ % podman-stop(1) ## NAME -podman\-stop - Stop one or more containers +podman\-stop - Stop one or more running containers ## SYNOPSIS **podman stop** [*options*] *container* ... diff --git a/docs/podman-system-migrate.1.md b/docs/podman-system-migrate.1.md index 1efa779ce..d175d0344 100644 --- a/docs/podman-system-migrate.1.md +++ b/docs/podman-system-migrate.1.md @@ -1,7 +1,7 @@ % podman-system-migrate(1) ## NAME -podman\-system\-migrate - Migrate container to the latest version of podman +podman\-system\-migrate - Migrate existing containers to a new podman version ## SYNOPSIS ** podman system migrate** diff --git a/docs/podman-system-renumber.1.md b/docs/podman-system-renumber.1.md index af498f270..071eefe29 100644 --- a/docs/podman-system-renumber.1.md +++ b/docs/podman-system-renumber.1.md @@ -1,7 +1,7 @@ % podman-system-renumber(1) ## NAME -podman\-system\-renumber - Renumber container locks +podman\-system\-renumber - Migrate lock numbers to handle a change in maximum number of locks ## SYNOPSIS **podman system renumber** diff --git a/docs/podman-system.1.md b/docs/podman-system.1.md index d36715feb..bbd541066 100644 --- a/docs/podman-system.1.md +++ b/docs/podman-system.1.md @@ -15,7 +15,7 @@ The system command allows you to manage the podman systems | ------- | --------------------------------------------------- | ---------------------------------------------------------------------------- | | df | [podman-system-df(1)](podman-system-df.1.md) | Show podman disk usage. | | info | [podman-system-info(1)](podman-info.1.md) | Displays Podman related system information. | -| prune | [podman-system-prune(1)](podman-system-prune.1.md) | Remove all unused data | +| prune | [podman-system-prune(1)](podman-system-prune.1.md) | Remove all unused container, image and volume data | | renumber | [podman-system-renumber(1)](podman-system-renumber.1.md)| Migrate lock numbers to handle a change in maximum number of locks. | | migrate | [podman-system-migrate(1)](podman-system-migrate.1.md)| Migrate existing containers to a new podman version. | diff --git a/docs/podman-umount.1.md b/docs/podman-umount.1.md index 8ef7b20ac..95300a8e8 100644 --- a/docs/podman-umount.1.md +++ b/docs/podman-umount.1.md @@ -1,7 +1,7 @@ % podman-umount(1) ## NAME -podman\-umount - Unmount the specified working containers' root file system. +podman\-umount - Unmount a working container's root filesystem ## SYNOPSIS **podman umount** *container* [...] diff --git a/docs/podman-unshare.1.md b/docs/podman-unshare.1.md index d7fefb774..9052b97ab 100644 --- a/docs/podman-unshare.1.md +++ b/docs/podman-unshare.1.md @@ -1,10 +1,10 @@ % podman-unshare(1) ## NAME -podman\-unshare - Run a command inside of a modified user namespace. +podman\-unshare - Run a command inside of a modified user namespace ## SYNOPSIS -**podman unshare** [*options*] [**--**] [*command*] +**podman unshare** [*options*] [*--*] [*command*] ## DESCRIPTION Launches a process (by default, *$SHELL*) in a new user namespace. The user diff --git a/docs/podman-version.1.md b/docs/podman-version.1.md index cb0a3785f..4499f6338 100644 --- a/docs/podman-version.1.md +++ b/docs/podman-version.1.md @@ -1,7 +1,7 @@ % podman-version(1) ## NAME -podman\-version - Display the PODMAN Version Information +podman\-version - Display the Podman version information ## SYNOPSIS **podman version** [*options*] diff --git a/docs/podman-volume-inspect.1.md b/docs/podman-volume-inspect.1.md index b00c821bb..a6c99f6c8 100644 --- a/docs/podman-volume-inspect.1.md +++ b/docs/podman-volume-inspect.1.md @@ -1,7 +1,7 @@ % podman-volume-inspect(1) ## NAME -podman\-volume\-inspect - Inspect one or more volumes +podman\-volume\-inspect - Get detailed information on one or more volumes ## SYNOPSIS **podman volume inspect** [*options*] *volume* [...] diff --git a/docs/podman-volume-ls.1.md b/docs/podman-volume-ls.1.md index ef1582153..d431c7c6e 100644 --- a/docs/podman-volume-ls.1.md +++ b/docs/podman-volume-ls.1.md @@ -1,7 +1,7 @@ % podman-volume-ls(1) ## NAME -podman\-volume\-ls - List volumes +podman\-volume\-ls - List all the available volumes ## SYNOPSIS **podman volume ls** [*options*] diff --git a/docs/podman-volume.1.md b/docs/podman-volume.1.md index 77728b2b5..288e57b82 100644 --- a/docs/podman-volume.1.md +++ b/docs/podman-volume.1.md @@ -1,7 +1,7 @@ % podman-volume(1) ## NAME -podman\-volume - Simple management tool for volumes. +podman\-volume - Simple management tool for volumes ## SYNOPSIS **podman volume** *subcommand* diff --git a/docs/podman.1.md b/docs/podman.1.md index c643140a2..1a469caf7 100644 --- a/docs/podman.1.md +++ b/docs/podman.1.md @@ -153,15 +153,15 @@ the exit codes follow the `chroot` standard, see below: | [podman-images(1)](podman-images.1.md) | List images in local storage. | | [podman-import(1)](podman-import.1.md) | Import a tarball and save it as a filesystem image. | | [podman-info(1)](podman-info.1.md) | Displays Podman related system information. | -| [podman-init(1)](podman-init.1.md) | Initialize a container | +| [podman-init(1)](podman-init.1.md) | Initialize one or more containers | | [podman-inspect(1)](podman-inspect.1.md) | Display a container or image's configuration. | | [podman-kill(1)](podman-kill.1.md) | Kill the main process in one or more containers. | | [podman-load(1)](podman-load.1.md) | Load an image from a container image archive into container storage. | | [podman-login(1)](podman-login.1.md) | Login to a container registry. | | [podman-logout(1)](podman-logout.1.md) | Logout of a container registry. | -| [podman-logs(1)](podman-logs.1.md) | Display the logs of a container. | +| [podman-logs(1)](podman-logs.1.md) | Display the logs of one or more containers. | | [podman-mount(1)](podman-mount.1.md) | Mount a working container's root filesystem. | -| [podman-network(1)](podman-network.1.md) | Manage Podman CNI networks. | +| [podman-network(1)](podman-network.1.md) | Manage Podman CNI networks. | | [podman-pause(1)](podman-pause.1.md) | Pause one or more containers. | | [podman-play(1)](podman-play.1.md) | Play pods and containers based on a structured input file. | | [podman-pod(1)](podman-pod.1.md) | Management tool for groups of containers, called pods. | @@ -169,6 +169,7 @@ the exit codes follow the `chroot` standard, see below: | [podman-ps(1)](podman-ps.1.md) | Prints out information about containers. | | [podman-pull(1)](podman-pull.1.md) | Pull an image from a registry. | | [podman-push(1)](podman-push.1.md) | Push an image from local storage to elsewhere. | +| [podman-remote(1)](podman-remote.1.md) | A tool for remote management of pods, containers and images | | [podman-restart(1)](podman-restart.1.md) | Restart one or more containers. | | [podman-rm(1)](podman-rm.1.md) | Remove one or more containers. | | [podman-rmi(1)](podman-rmi.1.md) | Removes one or more locally stored images. | @@ -186,7 +187,7 @@ the exit codes follow the `chroot` standard, see below: | [podman-unshare(1)](podman-unshare.1.md) | Run a command inside of a modified user namespace. | | [podman-varlink(1)](podman-varlink.1.md) | Runs the varlink backend interface. | | [podman-version(1)](podman-version.1.md) | Display the Podman version information. | -| [podman-volume(1)](podman-volume.1.md) | Manage Volumes. | +| [podman-volume(1)](podman-volume.1.md) | Simple management tool for volumes. | | [podman-wait(1)](podman-wait.1.md) | Wait on one or more containers to stop and print their exit codes. | ## FILES |