Browse code

add a little documentation for docker pull

Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)

SvenDowideit authored on 2014/08/29 09:16:40
Showing 2 changed files
... ...
@@ -6,6 +6,7 @@ docker-pull - Pull an image or a repository from the registry
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker pull**
9
+[**-a**|**--all-tags**[=*false*]]
9 10
 NAME[:TAG]
10 11
 
11 12
 # DESCRIPTION
... ...
@@ -16,7 +17,8 @@ images for that repository name are pulled down including any tags.
16 16
 It is also possible to specify a non-default registry to pull from.
17 17
 
18 18
 # OPTIONS
19
-There are no available options.
19
+**-a**, **--all-tags**=*true*|*false*
20
+   Download all tagged images in the repository. The default is *false*.
20 21
 
21 22
 # EXAMPLES
22 23
 
... ...
@@ -53,3 +55,4 @@ There are no available options.
53 53
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
54 54
 based on docker.com source material and internal work.
55 55
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
56
+August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -852,6 +852,8 @@ This shows all the containers that have exited with status of '0'
852 852
 
853 853
     Pull an image or a repository from the registry
854 854
 
855
+      -a, --all-tags=false    Download all tagged images in the repository
856
+
855 857
 Most of your images will be created on top of a base image from the
856 858
 [Docker Hub](https://hub.docker.com) registry.
857 859
 
... ...
@@ -867,11 +869,13 @@ To download a particular image, or set of images (i.e., a repository),
867 867
 use `docker pull`:
868 868
 
869 869
     $ docker pull debian
870
-    # will pull all the images in the debian repository
870
+    # will pull only the debian:latest image and its intermediate layers 
871 871
     $ docker pull debian:testing
872 872
     # will pull only the image named debian:testing and any intermediate layers
873
-    # it is based on. (Typically the empty `scratch` image, a MAINTAINERs layer,
873
+    # it is based on. (Typically the empty `scratch` image, a MAINTAINER layer,
874 874
     # and the un-tarred base).
875
+    $ docker pull --all-tags centos
876
+    # will pull all the images from the centos repository
875 877
     $ docker pull registry.hub.docker.com/debian
876 878
     # manually specifies the path to the default Docker registry. This could
877 879
     # be replaced with the path to a local registry to pull from another source.