diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2019-06-10 19:45:31 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-10 19:45:31 +0200 |
| commit | 013b897acee89018265fb563a1f52f899e8ec80c (patch) | |
| tree | d922011f842c59ce5d33090a1aa5fedb6372ee21 /docs/podman-image-sign.1.md | |
| parent | 75a3c22486a35990ab37693645c434dd09679420 (diff) | |
| parent | 19e0928037e2d9c6fb0941e2ac40b8cea731e22d (diff) | |
| download | podman-013b897acee89018265fb563a1f52f899e8ec80c.tar.gz podman-013b897acee89018265fb563a1f52f899e8ec80c.tar.bz2 podman-013b897acee89018265fb563a1f52f899e8ec80c.zip | |
Merge pull request #3254 from ashley-cui/standarddoc
Standardize Documentation
Diffstat (limited to 'docs/podman-image-sign.1.md')
| -rw-r--r-- | docs/podman-image-sign.1.md | 26 |
1 files changed, 11 insertions, 15 deletions
diff --git a/docs/podman-image-sign.1.md b/docs/podman-image-sign.1.md index 804ee03db..c425fcf2e 100644 --- a/docs/podman-image-sign.1.md +++ b/docs/podman-image-sign.1.md @@ -1,36 +1,32 @@ % podman-image-sign(1) -# NAME +## NAME podman-image-sign - Create a signature for an image -# SYNOPSIS -**podman image sign** -[**--help**|**-h**] -[**--directory**|**-d**] -[**--sign-by**] -[ IMAGE... ] +## SYNOPSIS +**podman image sign** [*options*] *image* [*image* ...] -# DESCRIPTION +## DESCRIPTION **podmain image sign** will create a local signature for one or more local images that have been pulled from a registry. The signature will be written to a directory derived from the registry configuration files in /etc/containers/registries.d. By default, the signature will be written into /var/lib/containers/sigstore directory. -# OPTIONS -**--help** **-h** +## OPTIONS +**--help**, **-h** Print usage statement. -**--directory** **-d** +**--directory**, **-d**=*dir* Store the signatures in the specified directory. Default: /var/lib/containers/sigstore -**--sign-by** +**--sign-by**=*identity* Override the default identity of the signature. -# EXAMPLES +## EXAMPLES Sign the busybox image with the identify of foo@bar.com with a user's keyring and save the signature in /tmp/signatures/. sudo podman image sign --sign-by foo@bar.com --directory /tmp/signatures docker://privateregistry.example.com/foobar -# RELATED CONFIGURATION +## RELATED CONFIGURATION The write (and read) location for signatures is defined in YAML-based configuration files in /etc/containers/registries.d/. When you sign @@ -48,5 +44,5 @@ the signature will be written into subdirectories of /var/lib/containers/sigstore/privateregistry.example.com. The use of 'sigstore' also means the signature will be 'read' from that same location on a pull-related function. -# HISTORY +## HISTORY November 2018, Originally compiled by Qi Wang (qiwan at redhat dot com) |