podman/docs/podman-image.1.md
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

2.7 KiB

% podman-image(1)

NAME

podman-image - Manage images

SYNOPSIS

podman image subcommand

DESCRIPTION

The image command allows you to manage images

COMMANDS

Command Man Page Description
build podman-build(1) Build a container using a Dockerfile.
exists podman-image-exists(1) Check if an image exists in local storage.
history podman-history(1) Show the history of an image.
import podman-import(1) Import a tarball and save it as a filesystem image.
inspect podman-inspect(1) Display a image or image's configuration.
list podman-images(1) List the container images on the system.(alias ls)
load podman-load(1) Load an image from the docker archive.
prune podman-image-prune(1) Remove all unused images from the local store.
pull podman-pull(1) Pull an image from a registry.
push podman-push(1) Push an image from local storage to elsewhere.
rm podman-rmi(1) Removes one or more locally stored images.
save podman-save(1) Save an image to docker-archive or oci.
sign podman-image-sign(1) Sign an image.
tag podman-tag(1) Add an additional name to a local image.
tree podman-image-tree(1) Prints layer hierarchy of an image in a tree format.
trust podman-image-trust(1) Manage container image trust policy.

SEE ALSO

podman