mirror of
https://github.com/containers/podman.git
synced 2025-12-02 11:08:36 +08:00
beb71323b1
podman-generate and -play had the wrong NAMEs.
podman-restart and -volume-prune the wrong SYNOPSIS.
All the rest are varying degrees of minor:
- missing a space between the NAME and description
- multi-line SYNOPSIS that could be collapsed into one
- use of UPPER CASE in synopsis instead of *asterisks*
- improper use of **double asterisks** for options
- varlink and version were transposed in podman-1
- fixed inconsistencies between the description in
the man page and that in the parent manpage. These
are too numerous for me to fix all.
Added: script that could be used in CI to prevent future
such inconsistencies. It cannot be enabled yet because
there are still 35+ inconsistencies in need of cleaning.
This will be difficult to review on github. I suggest
pulling the PR and running 'git log -1 -p | cdif | less'
'cdif' is a handy tool for colorizing individual diffs between
lines:
http://kaz-utashiro.github.io/cdif/
There are other such tools; use your favorite. Comparing
without visual highlights may be painful.
I also encourage you to run hack/man-page-checker and suggest
more fixes for the problems it's finding.
Signed-off-by: Ed Santiago <santiago@redhat.com>
2.5 KiB
2.5 KiB
% podman-pod(1)
NAME
podman-pod - Simple management tool for groups of containers, called pods.
SYNOPSIS
podman pod subcommand
DESCRIPTION
podman pod is a set of subcommands that manage pods, or groups of containers.
SUBCOMMANDS
| Command | Man Page | Description |
|---|---|---|
| create | podman-pod-create(1) | Create a new pod. |
| exists | podman-pod-exists(1) | Check if a pod exists in local storage. |
| inspect | podman-pod-inspect(1) | Displays information describing a pod. |
| kill | podman-pod-kill(1) | Kill the main process of each container in pod. |
| pause | podman-pod-pause(1) | Pause one or more pods. |
| ps | podman-pod-ps(1) | Prints out information about pods. |
| restart | podman-pod-restart(1) | Restart one or more pods. |
| rm | podman-pod-rm(1) | Remove one or more pods. |
| start | podman-pod-start(1) | Start one or more pods. |
| stats | podman-pod-stats(1) | Display live stream resource usage stats for containers in one or more pods. |
| stop | podman-pod-stop(1) | Stop one or more pods. |
| top | podman-pod-top(1) | Display the running processes of containers in a pod. |
| unpause | podman-pod-unpause(1) | Unpause one or more pods. |
SEE ALSO
podman(1)
HISTORY
July 2018, Originally compiled by Peter Hunt pehunt@redhat.com