Browse Source

add a little documentation for docker pull

Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
SvenDowideit 11 years ago
parent
commit
82b0c3e59c
2 changed files with 10 additions and 3 deletions
  1. 4 1
      docs/man/docker-pull.1.md
  2. 6 2
      docs/sources/reference/commandline/cli.md

+ 4 - 1
docs/man/docker-pull.1.md

@@ -6,6 +6,7 @@ docker-pull - Pull an image or a repository from the registry
 
 
 # SYNOPSIS
 # SYNOPSIS
 **docker pull**
 **docker pull**
+[**-a**|**--all-tags**[=*false*]]
 NAME[:TAG]
 NAME[:TAG]
 
 
 # DESCRIPTION
 # DESCRIPTION
@@ -16,7 +17,8 @@ images for that repository name are pulled down including any tags.
 It is also possible to specify a non-default registry to pull from.
 It is also possible to specify a non-default registry to pull from.
 
 
 # OPTIONS
 # OPTIONS
-There are no available options.
+**-a**, **--all-tags**=*true*|*false*
+   Download all tagged images in the repository. The default is *false*.
 
 
 # EXAMPLES
 # EXAMPLES
 
 
@@ -53,3 +55,4 @@ There are no available options.
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
 based on docker.com source material and internal work.
 based on docker.com source material and internal work.
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

+ 6 - 2
docs/sources/reference/commandline/cli.md

@@ -852,6 +852,8 @@ This shows all the containers that have exited with status of '0'
 
 
     Pull an image or a repository from the registry
     Pull an image or a repository from the registry
 
 
+      -a, --all-tags=false    Download all tagged images in the repository
+
 Most of your images will be created on top of a base image from the
 Most of your images will be created on top of a base image from the
 [Docker Hub](https://hub.docker.com) registry.
 [Docker Hub](https://hub.docker.com) registry.
 
 
@@ -867,11 +869,13 @@ To download a particular image, or set of images (i.e., a repository),
 use `docker pull`:
 use `docker pull`:
 
 
     $ docker pull debian
     $ docker pull debian
-    # will pull all the images in the debian repository
+    # will pull only the debian:latest image and its intermediate layers 
     $ docker pull debian:testing
     $ docker pull debian:testing
     # will pull only the image named debian:testing and any intermediate layers
     # will pull only the image named debian:testing and any intermediate layers
-    # it is based on. (Typically the empty `scratch` image, a MAINTAINERs layer,
+    # it is based on. (Typically the empty `scratch` image, a MAINTAINER layer,
     # and the un-tarred base).
     # and the un-tarred base).
+    $ docker pull --all-tags centos
+    # will pull all the images from the centos repository
     $ docker pull registry.hub.docker.com/debian
     $ docker pull registry.hub.docker.com/debian
     # manually specifies the path to the default Docker registry. This could
     # manually specifies the path to the default Docker registry. This could
     # be replaced with the path to a local registry to pull from another source.
     # be replaced with the path to a local registry to pull from another source.