Files
podman/docs/source/markdown/podman-manifest-annotate.1.md
Paul Holzinger bc48211924 Fix long option format on docs.podman.io
Escape the two dashes, otherwise they are combined into one long dash.
I tested that this change is safe and still renders correctly on github
and with the man pages.

This commit also contains a small change to make it build locally.
Assuming you have the dependencies installed you can do:
```
cd docs
make html
```
Preview the html files in docs/build/html with
`python -m http.server 8000 --directory build/html`.

Fixes containers/podman.io#373

Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
2021-03-29 14:38:25 +02:00

62 lines
2.0 KiB
Markdown

% podman-manifest-annotate(1)
## NAME
podman\-manifest\-annotate - Add or update information about an entry in a manifest list or image index
## SYNOPSIS
**podman manifest annotate** [*options*] *listnameorindexname* *imagemanifestdigest*
## DESCRIPTION
Adds or updates information about an image included in a manifest list or image index.
## OPTIONS
#### **\-\-annotation** *annotation=value*
Set an annotation on the entry for the specified image.
#### **\-\-arch**
Override the architecture which the list or index records as a requirement for
the image. This is usually automatically retrieved from the image's
configuration information, so it is rarely necessary to use this option.
#### **\-\-features**
Specify the features list which the list or index records as requirements for
the image. This option is rarely used.
#### **\-\-os**
Override the OS which the list or index records as a requirement for the image.
This is usually automatically retrieved from the image's configuration
information, so it is rarely necessary to use this option.
#### **\-\-os-features**
Specify the OS features list which the list or index records as requirements
for the image. This option is rarely used.
#### **\-\-os-version**
Specify the OS version which the list or index records as a requirement for the
image. This option is rarely used.
#### **\-\-variant**
Specify the variant which the list or index records for the image. This option
is typically used to distinguish between multiple entries which share the same
architecture value, but which expect different versions of its instruction set.
## EXAMPLE
```
podman manifest annotate --arch arm64 --variant v8 mylist:v1.11 sha256:59eec8837a4d942cc19a52b8c09ea75121acc38114a2c68b98983ce9356b8610
07ec8dc22b5dba3a33c60b68bce28bbd2b905e383fdb32a90708fa5eeac13a07: sha256:59eec8837a4d942cc19a52b8c09ea75121acc38114a2c68b98983ce9356b8610
```
## SEE ALSO
podman(1), podman-manifest(1), podman-manifest-add(1), podman-manifest-create(1), podman-manifest-inspect(1), podman-rmi(1)