mirror of
https://github.com/containers/podman.git
synced 2025-06-02 02:26:52 +08: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>
35 lines
2.7 KiB
Markdown
35 lines
2.7 KiB
Markdown
% 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)](podman-build.1.md) | Build a container using a Dockerfile. |
|
|
| exists | [podman-image-exists(1)](podman-image-exists.1.md) | Check if an image exists in local storage. |
|
|
| history | [podman-history(1)](podman-history.1.md) | Show the history of an image. |
|
|
| import | [podman-import(1)](podman-import.1.md) | Import a tarball and save it as a filesystem image. |
|
|
| inspect | [podman-inspect(1)](podman-inspect.1.md) | Display a image or image's configuration. |
|
|
| list | [podman-images(1)](podman-images.1.md) | List the container images on the system.(alias ls) |
|
|
| load | [podman-load(1)](podman-load.1.md) | Load an image from the docker archive. |
|
|
| prune | [podman-image-prune(1)](podman-image-prune.1.md)| Remove all unused images from the local store. |
|
|
| pull | [podman-pull(1)](podman-pull.1.md) | Pull an image from a registry. |
|
|
| push | [podman-push(1)](podman-push.1.md) | Push an image from local storage to elsewhere. |
|
|
| rm | [podman-rmi(1)](podman-rmi.1.md) | Removes one or more locally stored images. |
|
|
| save | [podman-save(1)](podman-save.1.md) | Save an image to docker-archive or oci. |
|
|
| sign | [podman-image-sign(1)](podman-image-sign.1.md) | Sign an image. |
|
|
| tag | [podman-tag(1)](podman-tag.1.md) | Add an additional name to a local image. |
|
|
| tree | [podman-image-tree(1)](podman-image-tree.1.md) | Prints layer hierarchy of an image in a tree format. |
|
|
| trust | [podman-image-trust(1)](podman-image-trust.1.md)| Manage container image trust policy. |
|
|
|
|
## SEE ALSO
|
|
podman
|