mirror of
https://github.com/containers/podman.git
synced 2025-05-22 01:27:07 +08:00
c6090c290e
New functionality in hack/man-page-checker: start cross- referencing the man page 'Synopsis' line against the output of 'podman foo --help'. This is part 1, flag/option consistency. Part 2 (arg consistency) is too big and will have to wait for later. flag/option consistency means: if 'podman foo --help' includes the string '[flags]' in the Usage message, make sure the man page includes '[*options*]' in its Synopsis line, and vice-versa. This found several inconsistencies, which I've fixed. While doing this I realized that Cobra automatically includes a 'Flags:' subsection in its --help output for all subcommands that have defined flags. This is great - it lets us cross-check against the usage synopsis, and make sure that '[flags]' is present or absent as needed, without fear of human screwups. If a flag-less subcommand ever gets extended with flags, but the developer forgets to add '[flags]' and remove DisableFlagsInUseLine, we now have a test that will catch that. (This, too, caught two instances which I fixed). I don't actually know if the new man-page-checker functionality will work in CI: I vaguely recall that it might run before 'make podman' does; and also vaguely recall that some steps were taken to remedy that. Signed-off-by: Ed Santiago <santiago@redhat.com>
43 lines
1006 B
Markdown
43 lines
1006 B
Markdown
% podman-container-exists(1)
|
|
|
|
## NAME
|
|
podman-container-exists - Check if a container exists in local storage
|
|
|
|
## SYNOPSIS
|
|
**podman container exists** *container*
|
|
|
|
## DESCRIPTION
|
|
**podman container exists** checks if a container exists in local storage. The **ID** or **Name**
|
|
of the container may be used as input. Podman will return an exit code
|
|
of `0` when the container is found. A `1` will be returned otherwise. An exit code of `125` indicates there
|
|
was an issue accessing the local storage.
|
|
|
|
## OPTIONS
|
|
|
|
**-h**, **--help**
|
|
Print usage statement
|
|
|
|
## Examples
|
|
|
|
Check if an container called `webclient` exists in local storage (the container does actually exist).
|
|
```
|
|
$ podman container exists webclient
|
|
$ echo $?
|
|
0
|
|
$
|
|
```
|
|
|
|
Check if an container called `webbackend` exists in local storage (the container does not actually exist).
|
|
```
|
|
$ podman container exists webbackend
|
|
$ echo $?
|
|
1
|
|
$
|
|
```
|
|
|
|
## SEE ALSO
|
|
podman(1)
|
|
|
|
## HISTORY
|
|
November 2018, Originally compiled by Brent Baude (bbaude at redhat dot com)
|