opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-10-25 02:04:43 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
podman/docs/source/markdown/podman-pod.1.md
Erik Sjölund de92db0c81 man pages and command help: clean up descriptions 
Short description in man pages:
* Use imperative form

Command help (cobra.Command.Short):
* Capitalize first letter
* Use imperative form
* Remove ending full stop when the short description
  only contains one sentence without any commas

Command help (cobra.Command.Long):
* Capitalize first letter unless the sentence starts
  with a command "podman command ..."
* Use imperative form when the long description is
  identical or almost identical to the short description.
  This modification was only done in a few places.

Command tables:
* Use imperative form in the "Description" column

[NO NEW TESTS NEEDED]

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-05-28 18:57:43 +02:00

3.0 KiB
Raw Blame History

% podman-pod 1

NAME

podman-pod - 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
clone podman-pod-clone(1) Create a copy of an existing pod.
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) Display information describing a pod.
kill podman-pod-kill(1) Kill the main process of each container in one or more pods.
logs podman-pod-logs(1) Display logs for pod with one or more containers.
pause podman-pod-pause(1) Pause one or more pods.
prune podman-pod-prune(1) Remove all stopped pods and their containers.
ps podman-pod-ps(1) Print out information about pods.
restart podman-pod-restart(1) Restart one or more pods.
rm podman-pod-rm(1) Remove one or more stopped pods and containers.
start podman-pod-start(1) Start one or more pods.
stats podman-pod-stats(1) Display a live stream of 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