mirror of https://github.com/containers/podman synced 2024-10-21 01:34:37 +00:00

Ed Santiago beb71323b1 man pages - consistency fixes

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>

2019-03-20 14:37:59 -06:00

1,006 B

Raw Blame History

% PODMAN(1) Podman Man Pages % Brent Baude % November 2018

NAME

podman-container-exists - Check if a container exists in local storage

SYNOPSIS

podman container exists [-h|--help] 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.

Examples

Check if an container called webclient exists in local storage (the container does actually exist).

$ sudo podman container exists webclient
$ echo $?
0
$

Check if an container called webbackend exists in local storage (the container does not actually exist).

$ sudo podman container exists webbackend
$ echo $?
1
$

HISTORY

November 2018, Originally compiled by Brent Baude (bbaude at redhat dot com)

1,006 B Raw Blame History