Skip to content

Commit

Permalink
Add links to configuration man pages
Browse files Browse the repository at this point in the history
Help users discover additonal man pages by completing
SEE ALSO section.

Signed-off-by: Daniel J Walsh <[email protected]>
  • Loading branch information
rhatdan committed May 14, 2020
1 parent fbf0612 commit ab23005
Show file tree
Hide file tree
Showing 10 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/skopeo-copy.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ the images in the list, and the list itself.

**--authfile** _path_

Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `skopeo login`.
If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`.

Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE
Expand Down Expand Up @@ -132,7 +132,7 @@ skopeo copy --encryption-key jwe:./public.key --encrypt-layer 1 oci:local_nginx
```

## SEE ALSO
skopeo(1), podman-login(1), docker-login(1)
skopeo(1), skopeo-login(1), docker-login(1), containers-auth.json(5), containers-policy.json(5), containers-transports(5)

## AUTHORS

Expand Down
4 changes: 2 additions & 2 deletions docs/skopeo-delete.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ $ docker exec -it registry /usr/bin/registry garbage-collect /etc/docker-distrib

**--authfile** _path_

Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `skopeo login`.
If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`.

**--creds** _username[:password]_ for accessing the registry
Expand All @@ -44,7 +44,7 @@ See above for additional details on using the command **delete**.


## SEE ALSO
skopeo(1), podman-login(1), docker-login(1)
skopeo(1), skopeo-login(1), docker-login(1), containers-auth.json(5)

## AUTHORS

Expand Down
4 changes: 2 additions & 2 deletions docs/skopeo-inspect.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Return low-level information about _image-name_ in a registry

**--authfile** _path_

Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `skopeo login`.
If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`.

**--creds** _username[:password]_ for accessing the registry
Expand Down Expand Up @@ -63,7 +63,7 @@ $ skopeo inspect docker://docker.io/fedora
```

# SEE ALSO
skopeo(1), podman-login(1), docker-login(1)
skopeo(1), skopeo-login(1), docker-login(1), containers-auth.json(5)

## AUTHORS

Expand Down
6 changes: 3 additions & 3 deletions docs/skopeo-list-tags.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Return a list of tags from _repository-name_ in a registry.

**--authfile** _path_

Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `skopeo login`.
If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`.

**--creds** _username[:password]_ for accessing the registry
Expand All @@ -30,7 +30,7 @@ Repository names are transport-specific references as each transport may have it
This commands refers to repositories using a _transport_`:`_details_ format. The following formats are supported:

**docker://**_docker-repository-reference_
A repository in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in either `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(podman login)`. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`.
A repository in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in either `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(skopeo login)`. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`.
A _docker-repository-reference_ is of the form: **registryhost:port/repositoryname** which is similar to an _image-reference_ but with no tag or digest allowed as the last component (e.g no `:latest` or `@sha256:xyz`)

Examples of valid docker-repository-references:
Expand Down Expand Up @@ -94,7 +94,7 @@ $ skopeo list-tags docker://localhost:5000/fedora
```

# SEE ALSO
skopeo(1), podman-login(1), docker-login(1)
skopeo(1), skopeo-login(1), docker-login(1), containers-auth.json(5)

## AUTHORS

Expand Down
2 changes: 1 addition & 1 deletion docs/skopeo-login.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Login Succeeded!
```

## SEE ALSO
skopeo(1), skopeo-logout(1)
skopeo(1), skopeo-logout(1), containers-auth.json(5), containers-registries.conf(5), containers-certs.d.5.md

## HISTORY
May 2020, Originally compiled by Qi Wang <[email protected]>
2 changes: 1 addition & 1 deletion docs/skopeo-logout.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Remove login credentials for all registries
```

## SEE ALSO
skopeo(1), skopeo-login(1)
skopeo(1), skopeo-login(1), containers-auth.json(5)

## HISTORY
May 2020, Originally compiled by Qi Wang <[email protected]>
2 changes: 1 addition & 1 deletion docs/skopeo-standalone-sign.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ $
```

## SEE ALSO
skopeo(1), skopeo-copy(1)
skopeo(1), skopeo-copy(1), containers-signature(5)

## AUTHORS

Expand Down
2 changes: 1 addition & 1 deletion docs/skopeo-standalone-verify.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Signature verified, digest sha256:20bf21ed457b390829cdbeec8795a7bea1626991fda603
```

## SEE ALSO
skopeo(1)
skopeo(1), containers-signature(5)

## AUTHORS

Expand Down
4 changes: 2 additions & 2 deletions docs/skopeo-sync.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ name can be stored at _destination_.
## OPTIONS
**--authfile** _path_

Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `skopeo login`.
If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`.

**--src-authfile** _path_
Expand Down Expand Up @@ -152,7 +152,7 @@ In the above example, TLS verification is enabled for `reigstry.example.com`, wh
disabled for `quay.io`.

## SEE ALSO
skopeo(1), podman-login(1), docker-login(1)
skopeo(1), skopeo-login(1), docker-login(1), containers-auth.json(5), containers-poliyc.json(5), containers-transports(5)

## AUTHORS

Expand Down
8 changes: 4 additions & 4 deletions docs/skopeo.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Most commands refer to container images, using a _transport_`:`_details_ format.
An existing local directory _path_ storing the manifest, layer tarballs and signatures as individual files. This is a non-standardized format, primarily useful for debugging or noninvasive container inspection.

**docker://**_docker-reference_
An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in either `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(podman login)`. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`.
An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in either `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(skopeo login)`. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`.

**docker-archive:**_path_[**:**_docker-reference_]
An image is stored in the `docker save` formatted file. _docker-reference_ is only used when creating such a file, and it must not contain a digest.
Expand Down Expand Up @@ -84,14 +84,14 @@ Most commands refer to container images, using a _transport_`:`_details_ format.
## FILES
**/etc/containers/policy.json**
Default trust policy file, if **--policy** is not specified.
The policy format is documented in https://github.com/containers/image/blob/master/docs/containers-policy.json.5.md .
The policy format is documented in [containers-policy.json(5)](https://github.com/containers/image/blob/master/docs/containers-policy.json.5.md) .

**/etc/containers/registries.d**
Default directory containing registry configuration, if **--registries.d** is not specified.
The contents of this directory are documented in https://github.com/containers/image/blob/master/docs/containers-policy.json.5.md .
The contents of this directory are documented in [containers-policy.json(5)](https://github.com/containers/image/blob/master/docs/containers-policy.json.5.md).

## SEE ALSO
podman-login(1), docker-login(1)
skopeo-login(1), docker-login(1), containers-auth.json(5), containers-storage.conf(5), containers-policy.json(5), containers-transports(5)

## AUTHORS

Expand Down

0 comments on commit ab23005

Please sign in to comment.