diff options
| author | Patrycja Guzik <patrycja.k.guzik@gmail.com> | 2022-04-05 23:33:18 +0200 |
|---|---|---|
| committer | Patrycja Guzik <patrycja.k.guzik@gmail.com> | 2022-04-05 23:40:07 +0200 |
| commit | e73547a6352042d27c6dc34574d08ae51f84ee65 (patch) | |
| tree | 14fae6636853ca4ca80c4e9ca89395145ad58db4 /docs | |
| parent | dd9eec06a33470f0dcaa449bdd96fc50d2ad2fea (diff) | |
| download | podman-e73547a6352042d27c6dc34574d08ae51f84ee65.tar.gz podman-e73547a6352042d27c6dc34574d08ae51f84ee65.tar.bz2 podman-e73547a6352042d27c6dc34574d08ae51f84ee65.zip | |
Unify examples section across several man pages: pod rm/start/unpause
Signed-off-by: Patrycja Guzik <patrycja.k.guzik@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/markdown/podman-pod-rm.1.md | 16 | ||||
| -rw-r--r-- | docs/source/markdown/podman-pod-start.1.md | 15 | ||||
| -rw-r--r-- | docs/source/markdown/podman-pod-unpause.1.md | 6 |
3 files changed, 36 insertions, 1 deletions
diff --git a/docs/source/markdown/podman-pod-rm.1.md b/docs/source/markdown/podman-pod-rm.1.md index 75a44c6d4..befab6791 100644 --- a/docs/source/markdown/podman-pod-rm.1.md +++ b/docs/source/markdown/podman-pod-rm.1.md @@ -39,17 +39,31 @@ Seconds to wait before forcibly stopping running containers within the pod. The ## EXAMPLE +Remove pod with a given name +``` podman pod rm mywebserverpod +``` +Remove multiple pods with given names and/or IDs +``` podman pod rm mywebserverpod myflaskserverpod 860a4b23 +``` +Forcefully remove pod with a given ID +``` podman pod rm -f 860a4b23 +``` +Forcefully remove all pods +``` podman pod rm -f -a - podman pod rm -fa +``` +Remove pod using ID specified in a given file +``` podman pod rm --pod-id-file /path/to/id/file +``` ## Exit Status **0** All specified pods removed diff --git a/docs/source/markdown/podman-pod-start.1.md b/docs/source/markdown/podman-pod-start.1.md index bab109212..45fc50c51 100644 --- a/docs/source/markdown/podman-pod-start.1.md +++ b/docs/source/markdown/podman-pod-start.1.md @@ -26,15 +26,30 @@ Read pod ID from the specified file and start the pod. Can be specified multipl ## EXAMPLE +Start pod with a given name +``` podman pod start mywebserverpod +``` +Start pods with given IDs +``` podman pod start 860a4b23 5421ab4 +``` +Start the latest pod created by Podman +``` podman pod start --latest +``` +Start all pods +``` podman pod start --all +``` +Start pod using ID specified in a given file +``` podman pod start --pod-id-file /path/to/id/file +``` ## SEE ALSO **[podman(1)](podman.1.md)**, **[podman-pod(1)](podman-pod.1.md)**, **[podman-pod-stop(1)](podman-pod-stop.1.md)** diff --git a/docs/source/markdown/podman-pod-unpause.1.md b/docs/source/markdown/podman-pod-unpause.1.md index ce883af69..d6645d69c 100644 --- a/docs/source/markdown/podman-pod-unpause.1.md +++ b/docs/source/markdown/podman-pod-unpause.1.md @@ -21,9 +21,15 @@ Instead of providing the pod name or ID, unpause the last created pod. (This opt ## EXAMPLE +Unpause pod with a given name +``` podman pod unpause mywebserverpod +``` +Unpause pod with a given ID +``` podman pod unpause 860a4b23 +``` ## SEE ALSO **[podman(1)](podman.1.md)**, **[podman-pod(1)](podman-pod.1.md)**, **[podman-pod-pause(1)](podman-pod-pause.1.md)** |