mirror of
https://github.com/containers/podman
synced 2024-10-21 01:34:37 +00: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>
39 lines
927 B
Markdown
39 lines
927 B
Markdown
% podman-pod-exits(1) Podman Man Pages
|
|
% Brent Baude
|
|
% December 2018
|
|
# NAME
|
|
podman-pod-exists - Check if a pod exists in local storage
|
|
|
|
# SYNOPSIS
|
|
**podman pod exists** [*-h*|*--help*] *pod*
|
|
|
|
# DESCRIPTION
|
|
**podman pod exists** checks if a pod exists in local storage. The **ID** or **Name**
|
|
of the pod may be used as input. Podman will return an exit code
|
|
of `0` when the pod is found. A `1` will be returned otherwise. An exit code of `125` indicates there
|
|
was an issue accessing the local storage.
|
|
|
|
## Examples ##
|
|
|
|
Check if a pod called `web` exists in local storage (the pod does actually exist).
|
|
```
|
|
$ sudo podman pod exists web
|
|
$ echo $?
|
|
0
|
|
$
|
|
```
|
|
|
|
Check if a pod called `backend` exists in local storage (the pod does not actually exist).
|
|
```
|
|
$ sudo podman pod exists backend
|
|
$ echo $?
|
|
1
|
|
$
|
|
```
|
|
|
|
## SEE ALSO
|
|
podman-pod(1), podman(1)
|
|
|
|
# HISTORY
|
|
December 2018, Originally compiled by Brent Baude (bbaude at redhat dot com)
|