mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
bbde4298a5
Docker-DCO-1.1-Signed-off-by: William Henry <whenry@redhat.com> (github: ipbabble) Changes to be committed: modified: contrib/man/md/docker-build.md modified: contrib/man/md/docker-commit.md
84 lines
3.2 KiB
Groff
84 lines
3.2 KiB
Groff
.\" Process this file with
|
|
.\" nroff -man -Tascii docker-images.1
|
|
.\"
|
|
.TH "DOCKER" "1" "April 2014" "0.1" "Docker"
|
|
.SH NAME
|
|
docker-images \- List the images in the local repository
|
|
.SH SYNOPSIS
|
|
.B docker images
|
|
[\fB-a\fR|\fB--all\fR=\fIfalse\fR]
|
|
[\fB--no-trunc\fR[=\fIfalse\fR]
|
|
[\fB-q\fR|\fB--quiet\fR[=\fIfalse\fR]
|
|
[\fB-t\fR|\fB--tree\fR=\fIfalse\fR]
|
|
[\fB-v\fR|\fB--viz\fR=\fIfalse\fR]
|
|
[NAME]
|
|
.SH DESCRIPTION
|
|
This command lists the images stored in the local Docker repository.
|
|
.sp
|
|
By default, intermediate images, used during builds, are not listed. Some of the output, e.g. image ID, is truncated, for space reasons. However the truncated image ID, and often the first few characters, are enough to be used in other Docker commands that use the image ID. The output includes repository, tag, image ID, date created and the virtual size.
|
|
.sp
|
|
The title REPOSITORY for the first title may seem confusing. It is essentially the image name. However, because you can tag a specific image, and multiple tags (image instances) can be associated with a single name, the name is really a repository for all tagged images of the same name.
|
|
.SH "OPTIONS"
|
|
.TP
|
|
.B -a, --all=\fItrue\fR|\fIfalse\fR:
|
|
When set to true, also include all intermediate images in the list. The default is false.
|
|
.TP
|
|
.B --no-trunc=\fItrue\fR|\fIfalse\fR:
|
|
When set to true, list the full image ID and not the truncated ID. The default is false.
|
|
.TP
|
|
.B -q, --quiet=\fItrue\fR|\fIfalse\fR:
|
|
When set to true, list the complete image ID as part of the output. The default is false.
|
|
.TP
|
|
.B -t, --tree=\fItrue\fR|\fIfalse\fR:
|
|
When set to true, list the images in a tree dependency tree (hierarchy) format. The default is false.
|
|
.TP
|
|
.B -v, --viz=\fItrue\fR|\fIfalse\fR
|
|
When set to true, list the graph in graphviz format. The default is \fIfalse\fR.
|
|
.sp
|
|
.SH EXAMPLES
|
|
.sp
|
|
.B Listing the images
|
|
.TP
|
|
To list the images in a local repository (not the registry) run:
|
|
.sp
|
|
.RS
|
|
docker images
|
|
.RE
|
|
.sp
|
|
The list will contain the image repository name, a tag for the image, and an image ID, when it was created and its virtual size. Columns: REPOSITORY, TAG, IMAGE ID, CREATED, and VIRTUAL SIZE.
|
|
.sp
|
|
To get a verbose list of images which contains all the intermediate images used in builds use \fB-a\fR:
|
|
.sp
|
|
.RS
|
|
docker images -a
|
|
.RE
|
|
.sp
|
|
.B List images dependency tree hierarchy
|
|
.TP
|
|
To list the images in the local repository (not the registry) in a dependency tree format then use the \fB-t\fR|\fB--tree=true\fR option.
|
|
.sp
|
|
.RS
|
|
docker images -t
|
|
.RE
|
|
.sp
|
|
This displays a staggered hierarchy tree where the less indented image is the oldest with dependent image layers branching inward (to the right) on subsequent lines. The newest or top level image layer is listed last in any tree branch.
|
|
.sp
|
|
.B List images in GraphViz format
|
|
.TP
|
|
To display the list in a format consumable by a GraphViz tools run with \fB-v\fR|\fB--viz=true\fR. For example to produce a .png graph file of the hierarchy use:
|
|
.sp
|
|
.RS
|
|
docker images --viz | dot -Tpng -o docker.png
|
|
.sp
|
|
.RE
|
|
.sp
|
|
.B Listing only the shortened image IDs
|
|
.TP
|
|
Listing just the shortened image IDs. This can be useful for some automated tools.
|
|
.sp
|
|
.RS
|
|
docker images -q
|
|
.RE
|
|
.sp
|
|
.SH HISTORY
|
|
April 2014, Originally compiled by William Henry (whenry at redhat dot com) based on dockier.io source material and internal work.
|