components/docker/files/man/docker-search.1
changeset 6468 af5d82385cd7
equal deleted inserted replaced
6467:e5632698211d 6468:af5d82385cd7
       
     1 .TH "DOCKER" "1" " Docker User Manuals" "Docker Community" "JUNE 2014"  ""
       
     2 
       
     3 
       
     4 .SH NAME
       
     5 .PP
       
     6 docker\-search \- Search the Docker Hub for images
       
     7 
       
     8 
       
     9 .SH SYNOPSIS
       
    10 .PP
       
    11 \fBdocker search\fP
       
    12 [\fB\-\-automated\fP]
       
    13 [\fB\-\-help\fP]
       
    14 [\fB\-\-no\-trunc\fP]
       
    15 [\fB\-s\fP|\fB\-\-stars\fP[=\fI0\fP]]
       
    16 TERM
       
    17 
       
    18 
       
    19 .SH DESCRIPTION
       
    20 .PP
       
    21 Search Docker Hub for images that match the specified \fB\fCTERM\fR. The table
       
    22 of images returned displays the name, description (truncated by default), number
       
    23 of stars awarded, whether the image is official, and whether it is automated.
       
    24 
       
    25 .PP
       
    26 \fINote\fP \- Search queries will only return up to 25 results
       
    27 
       
    28 
       
    29 .SH OPTIONS
       
    30 .PP
       
    31 \fB\-\-automated\fP=\fItrue\fP|\fIfalse\fP
       
    32    Only show automated builds. The default is \fIfalse\fP.
       
    33 
       
    34 .PP
       
    35 \fB\-\-help\fP
       
    36   Print usage statement
       
    37 
       
    38 .PP
       
    39 \fB\-\-no\-trunc\fP=\fItrue\fP|\fIfalse\fP
       
    40    Don't truncate output. The default is \fIfalse\fP.
       
    41 
       
    42 .PP
       
    43 \fB\-s\fP, \fB\-\-stars\fP=\fIX\fP
       
    44    Only displays with at least X stars. The default is zero.
       
    45 
       
    46 
       
    47 .SH EXAMPLES
       
    48 .SH Search Docker Hub for ranked images
       
    49 .PP
       
    50 Search a registry for the term 'fedora' and only display those images
       
    51 ranked 3 or higher:
       
    52 
       
    53 .PP
       
    54 .RS
       
    55 
       
    56 .nf
       
    57 $ docker search \-s 3 fedora
       
    58 NAME                  DESCRIPTION                                    STARS OFFICIAL  AUTOMATED
       
    59 mattdm/fedora         A basic Fedora image corresponding roughly...  50
       
    60 fedora                (Semi) Official Fedora base image.             38
       
    61 mattdm/fedora\-small   A small Fedora image on which to build. Co...  8
       
    62 goldmann/wildfly      A WildFly application server running on a ...  3               [OK]
       
    63 
       
    64 .fi
       
    65 .RE
       
    66 
       
    67 .SH Search Docker Hub for automated images
       
    68 .PP
       
    69 Search Docker Hub for the term 'fedora' and only display automated images
       
    70 ranked 1 or higher:
       
    71 
       
    72 .PP
       
    73 .RS
       
    74 
       
    75 .nf
       
    76 $ docker search \-\-automated \-s 1 fedora
       
    77 NAME               DESCRIPTION                                     STARS OFFICIAL  AUTOMATED
       
    78 goldmann/wildfly   A WildFly application server running on a ...   3               [OK]
       
    79 tutum/fedora\-20    Fedora 20 image with SSH access. For the r...   1               [OK]
       
    80 
       
    81 .fi
       
    82 .RE
       
    83 
       
    84 
       
    85 .SH HISTORY
       
    86 .PP
       
    87 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
       
    88 based on docker.com source material and internal work.
       
    89 June 2014, updated by Sven Dowideit 
       
    90 \[la][email protected]\[ra]
       
    91 April 2015, updated by Mary Anthony for v2 
       
    92 \[la][email protected]\[ra]