summaryrefslogtreecommitdiff
path: root/docs/podman-search.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/podman-search.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/podman-search.1.md')
-rw-r--r--docs/podman-search.1.md155
1 files changed, 0 insertions, 155 deletions
diff --git a/docs/podman-search.1.md b/docs/podman-search.1.md
deleted file mode 100644
index 31de6f839..000000000
--- a/docs/podman-search.1.md
+++ /dev/null
@@ -1,155 +0,0 @@
-% podman-search(1)
-
-## NAME
-podman\-search - Search a registry for an image
-
-## SYNOPSIS
-**podman search** [*options*] *term*
-
-## 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**.
-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.
-
-**podman [GLOBAL OPTIONS]**
-
-**podman search [GLOBAL OPTIONS]**
-
-**podman search [OPTIONS] TERM**
-
-## OPTIONS
-
-**--authfile**=*path*
-
-Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json (Not available for remote commands)
-
-Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE
-environment variable. `export REGISTRY_AUTH_FILE=path`
-
-**--filter**, **-f**=*filter*
-
-Filter output based on conditions provided (default [])
-
-Supported filters are:
-
-* stars (int - number of stars the image has)
-* is-automated (boolean - true | false) - is the image automated or not
-* is-official (boolean - true | false) - is the image official or not
-
-**--format**=*format*
-
-Change the output format to a Go template
-
-Valid placeholders for the Go template are listed below:
-
-| **Placeholder** | **Description** |
-| --------------- | ---------------------------- |
-| .Index | Registry |
-| .Name | Image name |
-| .Descriptions | Image description |
-| .Stars | Star count of image |
-| .Official | "[OK]" if image is official |
-| .Automated | "[OK]" if image is automated |
-
-**--limit**=*limit*
-
-Limit the number of results
-Note: The results from each registry will be limited to this value.
-Example if limit is 10 and two registries are being searched, the total
-number of results will be 20, 10 from each (if there are at least 10 matches in each).
-The order of the search results is the order in which the API endpoint returns the results.
-
-**--no-trunc**
-
-Do not truncate the output
-
-**--tls-verify**=*true|false*
-
-Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true,
-then TLS verification will be used. If set to false, then TLS verification will not be used if needed. If not specified,
-default registries will be searched through (in /etc/containers/registries.conf), and TLS will be skipped if a default
-registry is listed in the insecure registries. (Not available for remote commands)
-
-**--help**, **-h**
-
-Print usage statement
-
-## EXAMPLES
-
-```
-$ podman search --limit 3 rhel
-INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
-docker.io docker.io/richxsl/rhel7 RHEL 7 image with minimal installation 9
-docker.io docker.io/bluedata/rhel7 RHEL-7.x base container images 1
-docker.io docker.io/gidikern/rhel-oracle-jre RHEL7 with jre8u60 5 [OK]
-redhat.com redhat.com/rhel This platform image provides a minimal runti... 0
-redhat.com redhat.com/rhel6 This platform image provides a minimal runti... 0
-redhat.com redhat.com/rhel6.5 This platform image provides a minimal runti... 0
-```
-
-```
-$ podman search alpine
-INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
-docker.io docker.io/library/alpine A minimal Docker image based on Alpine Linux... 3009 [OK]
-docker.io docker.io/mhart/alpine-node Minimal Node.js built on Alpine Linux 332
-docker.io docker.io/anapsix/alpine-java Oracle Java 8 (and 7) with GLIBC 2.23 over A... 272 [OK]
-docker.io docker.io/tenstartups/alpine Alpine linux base docker image with useful p... 5 [OK]
-```
-
-```
-$ podman search registry.fedoraproject.org/fedora
-INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
-fedoraproject.org fedoraproject.org/fedora 0
-fedoraproject.org fedoraproject.org/fedora-minimal 0
-```
-
-```
-$ podman search --filter=is-official alpine
-INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
-docker.io docker.io/library/alpine A minimal Docker image based on Alpine Linux... 3009 [OK]
-```
-
-```
-$ podman search --format "table {{.Index}} {{.Name}}" registry.fedoraproject.org/fedora
-INDEX NAME
-fedoraproject.org fedoraproject.org/fedora
-fedoraproject.org fedoraproject.org/fedora-minimal
-```
-
-```
-$ podman search registry.fedoraproject.org/
-INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
-fedoraproject.org registry.fedoraproject.org/f25/cockpit 0
-fedoraproject.org registry.fedoraproject.org/f25/container-engine 0
-fedoraproject.org registry.fedoraproject.org/f25/docker 0
-fedoraproject.org registry.fedoraproject.org/f25/etcd 0
-fedoraproject.org registry.fedoraproject.org/f25/flannel 0
-fedoraproject.org registry.fedoraproject.org/f25/httpd 0
-fedoraproject.org registry.fedoraproject.org/f25/kubernetes-apiserver 0
-fedoraproject.org registry.fedoraproject.org/f25/kubernetes-controller-manager 0
-fedoraproject.org registry.fedoraproject.org/f25/kubernetes-kubelet 0
-fedoraproject.org registry.fedoraproject.org/f25/kubernetes-master 0
-fedoraproject.org registry.fedoraproject.org/f25/kubernetes-node 0
-fedoraproject.org registry.fedoraproject.org/f25/kubernetes-proxy 0
-fedoraproject.org registry.fedoraproject.org/f25/kubernetes-scheduler 0
-fedoraproject.org registry.fedoraproject.org/f25/mariadb 0
-```
-Note: This works only with registries that implement the v2 API. If tried with a v1 registry an error will be returned.
-
-## FILES
-
-**registries.conf** (`/etc/containers/registries.conf`)
-
- registries.conf is the configuration file which specifies which container registries should be consulted when completing image names which do not include a registry or domain portion.
-
-## SEE ALSO
-podman(1), containers-registries.conf(5)
-
-## HISTORY
-January 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>