diff options
author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2021-07-02 13:09:04 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-07-02 13:09:04 -0400 |
commit | f93d60d018ebbc32f76a46950cc0c75182de2983 (patch) | |
tree | 9d471e478ba0f938fcaa0c3f9cefa416c179fb55 | |
parent | 04209873562dff25c5d6f800e4a535dff18d485a (diff) | |
parent | 8606ead9126a464cf6f2e995e97540a50d74dbc9 (diff) | |
download | podman-f93d60d018ebbc32f76a46950cc0c75182de2983.tar.gz podman-f93d60d018ebbc32f76a46950cc0c75182de2983.tar.bz2 podman-f93d60d018ebbc32f76a46950cc0c75182de2983.zip |
Merge pull request #10842 from vrothberg/search-docs
[CI:DOCS] podman search: clarify that results depend on implementation
-rw-r--r-- | docs/source/markdown/podman-search.1.md | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/source/markdown/podman-search.1.md b/docs/source/markdown/podman-search.1.md index ec610d3ba..661ad6742 100644 --- a/docs/source/markdown/podman-search.1.md +++ b/docs/source/markdown/podman-search.1.md @@ -9,13 +9,18 @@ podman\-search - Search a registry for an image ## DESCRIPTION **podman search** searches a registry or a list of registries for a matching image. The user can specify which registry to search by prefixing the registry in the search term -(example **registry.fedoraproject.org/fedora**), default is the registries in the -**registries.search** table in the config file - **/etc/containers/registries.conf**. +(e.g., **registry.fedoraproject.org/fedora**). By default, all +unqualified-search registries in `containers-registries.conf(5)` are used. + The default number of results is 25. The number of results can be limited using the **--limit** flag. If more than one registry is being searched, the limit will be applied to each registry. The output can be filtered using the **--filter** flag. To get all available images in a registry without a specific search term, the user can just enter the registry name with a trailing "/" (example **registry.fedoraproject.org/**). -Note, searching without a search term will only work for registries that implement the v2 API. + +Note that **podman search** is not a reliable way to determine the presence or existence of an image. +The search behavior of the v1 and v2 Docker distribution API is specific to the implementation of each registry. +Some registries may not support searching at all. +Further note that searching without a search term will only work for registries that implement the v2 API. **podman [GLOBAL OPTIONS]** |