Browse code

Edits based on ostezer's feedback.

Docker-DCO-1.1-Signed-off-by: William Henry <whenry@redhat.com> (github: ipbabble)

William Henry authored on 2014/04/18 00:36:58
Showing 30 changed files
... ...
@@ -1,8 +1,9 @@
1 1
 Docker Documentation
2 2
 ====================
3 3
 
4
-This directory contains the docker user manual in Markdown format.
5
-DO NOT edit the man pages in the man1 directory. Instead make changes here.
4
+This directory contains the Docker user manual in the Markdown format.
5
+Do *not* edit the man pages in the man1 directory. Instead, amend the
6
+Markdown (*.md) files.
6 7
 
7 8
 # File List
8 9
 
... ...
@@ -41,32 +42,34 @@ DO NOT edit the man pages in the man1 directory. Instead make changes here.
41 41
     Dockerfile
42 42
     md2man-all.sh
43 43
 
44
-# Generating man pages from the Markdown
44
+# Generating man pages from the Markdown files
45 45
 
46 46
 There are three ways to generate the man pages:
47
-* Manually Individually
48
-* Using the Script
49
-* Using a the Pandoc Container (**Recommended**)
47
+* Each page manually
48
+* All pages manually
49
+* Via a *Pandoc* Docker container (**Recommended**)
50 50
 
51
-The first and second approach require you to install pandoc packages
52
- on your host using the host operating systems package installer. Check
53
-to see if pandoc is available if you choose that method.
51
+The first and second approach require you to install the Pandoc package
52
+ on your computer using the default package installer for the system.
53
+You should check if Pandoc is available before trying to do so.
54 54
 
55
-The Pandoc container approach is recommneded because the conversion process
56
-is isolated inside a fedora container and thereofre does not require you
57
-find and install pandoc on your host.
55
+The recommended approach is the Pandoc Docker container one.
56
+Using the supplied Dockerfile, Docker creates a Fedora based container
57
+and isolates the Pandoc installation.
58
+This is a seamless process, saving you from dealing with Pandoc and
59
+dependencies on your own computer.
58 60
 
59
-## Manually Individually
61
+## Each page manually
60 62
 
61
-You can generate the manpage by:
63
+You can generate the man pages with:
62 64
 
63 65
     pandoc -s -t man docker-<command>.md ../man1/docker-<command>.1
64 66
 
65
-The resulting man pages are stored in ../man1
67
+The results will be stored ../man1
66 68
 
67
-## Manually All
69
+## All pages manually
68 70
 
69
-Or regenerate all the manpages from this source using:
71
+You can generate *all* the man pages from the source using:
70 72
 
71 73
     for FILE in *.md
72 74
     do
... ...
@@ -77,14 +80,16 @@ Or regenerate all the manpages from this source using:
77 77
 
78 78
 There is a Dockerfile provided in the `docker/contrib/man/md` directory.
79 79
 
80
-Use this Dockerfile to create a `fedora/pandoc` container:
80
+Using this Dockerfile, create a Docker image tagged `fedora/pandoc`.
81 81
 
82
-    # docker build  -t fedora/pandoc .
82
+    docker build  -t fedora/pandoc .
83 83
 
84
-After the container is created run the following command from your
85
-`docker/contrib/man/md` directory:
84
+Once the image is built, create a container inside the
85
+`docker/contrib/man/md` directory using the it:
86 86
 
87
-    # docker run -v /<path-to-git-dir>/docker/contrib/man:/pandoc:rw \
87
+    docker run -v /<path-to-git-dir>/docker/contrib/man:/pandoc:rw \
88 88
     -w /pandoc -i fedora/pandoc /pandoc/md/md2man-all.sh
89 89
 
90
-This will generate all man files into `docker/contrib/man/man1`.
90
+The Pandoc Docker container will process the Markdown files and generate
91
+ the man pages inside the `docker/contrib/man/man1` directory using
92
+ Docker volumes.
... ...
@@ -12,8 +12,8 @@ If you **docker run** a container in detached mode (**-d**), you can reattach to
12 12
  the detached container with **docker attach** using the container's ID or name.
13 13
 
14 14
 You can detach from the container again (and leave it running) with `CTRL-c` (for
15
- a quiet exit) or `CTRL-\` to get a stacktrace of the Docker client when it quits
16
-. When you detach from a container the exit code will be returned to
15
+a quiet exit) or `CTRL-\` to get a stacktrace of the Docker client when it quits.
16
+When you detach from a container the exit code will be returned to
17 17
 the client.
18 18
 
19 19
 # OPTIONS
... ...
@@ -26,7 +26,7 @@ mode). The default is *true*.
26 26
 
27 27
 # EXAMPLES
28 28
 
29
-##Attaching to a container
29
+## Attaching to a container
30 30
 
31 31
 In this example the top command is run inside a container, from an image called
32 32
 fedora, in detached mode. The ID from the container is passed into the **docker
... ...
@@ -53,4 +53,5 @@ attach** command:
53 53
     1 root      20   0 17208 1144  932 R    0  0.3   0:00.03 top
54 54
 
55 55
 # HISTORY
56
-April 2014, Originally compiled by William Henry (whenry at redhat dot com) based on docker.io source material and internal work.
56
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
57
+based on docker.io source material and internal work.
... ...
@@ -9,64 +9,75 @@ docker-build - Build a container image from a Dockerfile source at PATH
9 9
  [**-rm**] [**-t**|**--tag**=*tag*] PATH | URL | -
10 10
 
11 11
 # DESCRIPTION
12
-This will read the Dockerfile from the directory specified in **PATH**. It also
13
- sends any other files and directories found in the current directory to the
14
-Docker daemon. The contents of this directory would be used by **ADD** commands
15
-found within the Dockerfile. Warning, this will send a lot of data to the Docker
16
-daemon if the current directory contains a lot of data.
12
+This will read the Dockerfile from the directory specified in **PATH**.
13
+It also sends any other files and directories found in the current
14
+directory to the Docker daemon. The contents of this directory would
15
+be used by **ADD** commands found within the Dockerfile.
17 16
 
18
-If the absolute path is provided instead of ‘.’, only the files and directories
19
-required by the **ADD** command from the Dockerfile will be added to the context
20
- and transferred to the Docker daemon.
17
+Warning, this will send a lot of data to the Docker daemon depending
18
+on the contents of the current directory.
21 19
 
22
-When a single Dockerfile is given as URL, then no context is set. When a Git
23
-repository is set as **URL**, the repository is used as context.
20
+If the absolute path is provided instead of ‘.’, only the files and
21
+directories required by the **ADD** command from the Dockerfile will
22
+be added to the context and transferred to the Docker daemon.
23
+
24
+When a single Dockerfile is given as the URL, then no context is set.
25
+When a Git repository is set as the **URL**, the repository is used
26
+as context.
24 27
 
25 28
 # OPTIONS
26 29
 
27 30
 **-q**, **--quiet**=*true*|*false*
28
-:  When set to true, suppress verbose build output. Default is *false*.
31
+   When set to true, suppress verbose build output. Default is *false*.
29 32
 
30 33
 **--rm**=*true*|*false*
31
-:  When true, remove intermediate containers that are created during the build process. The default is true.
34
+   When true, remove intermediate containers that are created during the
35
+build process. The default is true.
32 36
 
33 37
 **-t**, **--tag**=*tag*
34
-:  Tag to be applied to the resulting image on successful completion of the build.
38
+   Tag to be applied to the resulting image on successful completion of
39
+the build.
35 40
 
36 41
 **--no-cache**=*true*|*false*
37
-:  When set to true, do not use a cache when building the image. The default is *false*.
42
+   When set to true, do not use a cache when building the image. The
43
+default is *false*.
38 44
 
39 45
 # EXAMPLES
40 46
 
41
-## Building an image from current directory
47
+## Building an image using a Dockefile located inside the current directory
42 48
 
43
-Using a Dockerfile, Docker images are built using the build command:
49
+Docker images can be built using the build command and a Dockerfile:
44 50
 
45 51
     docker build .
46 52
 
47
-If, for some reason, you do not what to remove the intermediate containers created during the build you must set --rm=false:
53
+During the build process Docker creates intermediate images. In order to
54
+remove them, you must explicitly set `--rm=false`.
48 55
 
49 56
     docker build --rm=false .
50 57
 
51
-A good practice is to make a sub-directory with a related name and create the
52
-Dockerfile in that directory. E.g. a directory called mongo may contain a
53
-Dockerfile for a MongoDB image, or a directory called httpd may contain a
54
-Dockerfile for an Apache web server.
58
+A good practice is to make a sub-directory with a related name and create
59
+the Dockerfile in that directory. For example, a directory called mongo may
60
+contain a Dockerfile to create a Docker MongoDB image. Likewise, another
61
+directory called httpd may be used to store Dockerfiles for Apache web
62
+server images.
55 63
 
56
-It is also good practice to add the files required for the image to the
57
-sub-directory. These files will be then specified with the `ADD` instruction in
58
-the Dockerfile. Note: if you include a tar file, which is good practice, then
59
-Docker will automatically extract the contents of the tar file specified in the
60
-`ADD` instruction into the specified target.
64
+It is also a good practice to add the files required for the image to the
65
+sub-directory. These files will then be specified with the `ADD` instruction
66
+in the Dockerfile. Note: If you include a tar file (a good practice!), then
67
+Docker will automatically extract the contents of the tar file
68
+specified within the `ADD` instruction into the specified target.
61 69
 
62 70
 ## Building an image using a URL
63 71
 
64
-This will clone the Github repository and use it as context. The Dockerfile at the root of the repository is used as Dockerfile. This only works if the Github repository is a dedicated repository.
72
+This will clone the specified Github repository from the URL and use it
73
+as context. The Dockerfile at the root of the repository is used as
74
+Dockerfile. This only works if the Github repository is a dedicated
75
+repository.
65 76
 
66 77
     docker build github.com/scollier/Fedora-Dockerfiles/tree/master/apache
67 78
 
68
-Note that you can specify an arbitrary Git repository by using the `git://`
69
-schema.
79
+Note: You can set an arbitrary Git repository via the `git://` schema.
70 80
 
71 81
 # HISTORY
72
-March 2014, Originally compiled by William Henry (whenry at redhat dot com) based on docker.io source material and internal work.
82
+March 2014, Originally compiled by William Henry (whenry at redhat dot com)
83
+based on docker.io source material and internal work.
... ...
@@ -3,11 +3,11 @@
3 3
 % APRIL 2014
4 4
 # NAME
5 5
 docker-commit - Create a new image from the changes to an existing
6
- container
6
+container
7 7
 
8 8
 # SYNOPSIS
9
-**docker commit** **-a**|**--author**[=""] **-m**|**--message**[=""] CONTAINER
10
- [REPOSITORY[:TAG]]
9
+**docker commit** **-a**|**--author**[=""] **-m**|**--message**[=""]
10
+CONTAINER [REPOSITORY[:TAG]]
11 11
 
12 12
 # DESCRIPTION
13 13
 Using an existing container's name or ID you can create a new image.
... ...
@@ -24,7 +24,7 @@ Using an existing container's name or ID you can create a new image.
24 24
 ## Creating a new image from an existing container
25 25
 And existing Fedora based container has had Apache installed while running
26 26
 in interactive mode with the bash shell. Apache is also running. To
27
- create a new image run docker ps to find the container's ID and then run:
27
+create a new image run docker ps to find the container's ID and then run:
28 28
 
29 29
     # docker commit -me= "Added Apache to Fedora base image" \
30 30
       --a="A D Ministrator" 98bd7fc99854 fedora/fedora_httpd:20
... ...
@@ -20,4 +20,5 @@ the exited container to the current dir on the host:
20 20
 
21 21
 # HISTORY
22 22
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
23
- based on docker.io source material and internal work.
23
+based on docker.io source material and internal work.
24
+
... ...
@@ -39,4 +39,6 @@ Inspect the changes to on a nginx container:
39 39
 
40 40
 # HISTORY
41 41
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
42
- based on docker.io source material and internal work.
42
+based on docker.io source material and internal work.
43
+
44
+
... ...
@@ -19,8 +19,8 @@ seconds since epoch, or date string.
19 19
 
20 20
 ## Listening for Docker events
21 21
 
22
-After running docker events a container 786d698004576 is started and stopped:
23
-(The container name has been shortened in the ouput below)
22
+After running docker events a container 786d698004576 is started and stopped
23
+(The container name has been shortened in the ouput below):
24 24
 
25 25
     # docker events
26 26
     [2014-04-12 18:23:04 -0400 EDT] 786d69800457: (from whenry/testimage:latest) start
... ...
@@ -43,4 +43,4 @@ Again the output container IDs have been shortened for the purposes of this docu
43 43
 
44 44
 # HISTORY
45 45
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
46
- based on docker.io source material and internal work.
47 46
\ No newline at end of file
47
+based on docker.io source material and internal work.
48 48
\ No newline at end of file
... ...
@@ -29,4 +29,4 @@ Show the history of when and how an image was created.
29 29
 
30 30
 # HISTORY
31 31
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
32
- based on docker.io source material and internal work.
32
+based on docker.io source material and internal work.
... ...
@@ -20,11 +20,11 @@ By default, intermediate images, used during builds, are not listed. Some of the
20 20
 output, e.g. image ID, is truncated, for space reasons. However the truncated
21 21
 image ID, and often the first few characters, are enough to be used in other
22 22
 Docker commands that use the image ID. The output includes repository, tag, image
23
- ID, date created and the virtual size.
23
+ID, date created and the virtual size.
24 24
 
25 25
 The title REPOSITORY for the first title may seem confusing. It is essentially
26 26
 the image name. However, because you can tag a specific image, and multiple tags
27
- (image instances) can be associated with a single name, the name is really a
27
+(image instances) can be associated with a single name, the name is really a
28 28
 repository for all tagged images of the same name. For example consider an image
29 29
 called fedora. It may be tagged with 18, 19, or 20, etc. to manage different
30 30
 versions.
... ...
@@ -32,22 +32,24 @@ versions.
32 32
 # OPTIONS
33 33
 
34 34
 **-a**, **--all**=*true*|*false*
35
-:  When set to true, also include all intermediate images in the list. The
35
+   When set to true, also include all intermediate images in the list. The
36 36
 default is false.
37 37
 
38 38
 **--no-trunc**=*true*|*false*
39
-:  When set to true, list the full image ID and not the truncated ID. The default is false.
39
+   When set to true, list the full image ID and not the truncated ID. The
40
+default is false.
40 41
 
41 42
 **-q**, **--quiet**=*true*|*false*
42
-:  When set to true, list the complete image ID as part of the output. The
43
+   When set to true, list the complete image ID as part of the output. The
43 44
 default is false.
44 45
 
45 46
 **-t**, **--tree**=*true*|*false*
46
-:  When set to true, list the images in a tree dependency tree (hierarchy) format
47
-. The default is false.
47
+   When set to true, list the images in a tree dependency tree (hierarchy)
48
+format. The default is false.
48 49
 
49 50
 **-v**, **--viz**=*true*|*false*
50
-:  When set to true, list the graph in graphviz format. The default is *false*.
51
+   When set to true, list the graph in graphviz format. The default is
52
+*false*.
51 53
 
52 54
 # EXAMPLES
53 55
 
... ...
@@ -61,7 +63,8 @@ The list will contain the image repository name, a tag for the image, and an
61 61
 image ID, when it was created and its virtual size. Columns: REPOSITORY, TAG,
62 62
 IMAGE ID, CREATED, and VIRTUAL SIZE.
63 63
 
64
-To get a verbose list of images which contains all the intermediate images used in builds use **-a**:
64
+To get a verbose list of images which contains all the intermediate images
65
+used in builds use **-a**:
65 66
 
66 67
     docker images -a
67 68
 
... ...
@@ -72,21 +75,25 @@ tree format, use the **-t** option.
72 72
 
73 73
     docker images -t
74 74
 
75
-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.
75
+This displays a staggered hierarchy tree where the less indented image is
76
+the oldest with dependent image layers branching inward (to the right) on
77
+subsequent lines. The newest or top level image layer is listed last in
78
+any tree branch.
76 79
 
77 80
 ## List images in GraphViz format
78 81
 
79
-To display the list in a format consumable by a GraphViz tools run with **-v**.
80
-For example to produce a .png graph file of the hierarchy use:
82
+To display the list in a format consumable by a GraphViz tools run with
83
+**-v**. For example to produce a .png graph file of the hierarchy use:
81 84
 
82 85
     docker images --viz | dot -Tpng -o docker.png
83 86
 
84 87
 ## Listing only the shortened image IDs
85 88
 
86
-Listing just the shortened image IDs. This can be useful for some automated tools.
89
+Listing just the shortened image IDs. This can be useful for some automated
90
+tools.
87 91
 
88 92
     docker images -q
89 93
 
90 94
 # HISTORY
91
-April 2014, Originally compiled by William Henry (whenry at redhat dot com) based
92
- on docker.io source material and internal work.
95
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
96
+based on docker.io source material and internal work.
... ...
@@ -2,15 +2,15 @@
2 2
 % William Henry
3 3
 % APRIL 2014
4 4
 # NAME
5
-docker-import - Create an empty filesystem image and import the contents of
6
- the tarball into it.
5
+docker-import - Create an empty filesystem image and import the contents
6
+of the tarball into it.
7 7
 
8 8
 # SYNOPSIS
9 9
 **docker import** URL|- [REPOSITORY[:TAG]]
10 10
 
11 11
 # DESCRIPTION
12
-Create a new filesystem image from the contents of a tarball (.tar, .tar.gz,
13
- .tgz, .bzip, .tar.xz, .txz) into it, then optionally tag it.
12
+Create a new filesystem image from the contents of a tarball (.tar,
13
+.tar.gz, .tgz, .bzip, .tar.xz, .txz) into it, then optionally tag it.
14 14
 
15 15
 # EXAMPLES
16 16
 
... ...
@@ -36,4 +36,4 @@ Import to docker via pipe and stdin:
36 36
 
37 37
 # HISTORY
38 38
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
39
- based on docker.io source material and internal work.
39
+based on docker.io source material and internal work.
... ...
@@ -10,8 +10,8 @@ docker-info - Display system wide information
10 10
 # DESCRIPTION
11 11
 This command displays system wide information regarding the Docker installation.
12 12
 Information displayed includes the number of containers and images, pool name,
13
-data file, metadata file, data space used, total data space, metadata space used,
14
- total metadata space, execution driver, and the kernel version.
13
+data file, metadata file, data space used, total data space, metadata space used
14
+, total metadata space, execution driver, and the kernel version.
15 15
 
16 16
 The data file is where the images are stored and the metadata file is where the
17 17
 meta data regarding those images are stored. When run for the first time Docker
... ...
@@ -42,4 +42,5 @@ Here is a sample output:
42 42
     Kernel Version: 3.10.0-116.el7.x86_64
43 43
 
44 44
 # HISTORY
45
-April 2014, Originally compiled by William Henry (whenry at redhat dot com) based on docker.io source material and internal work.
45
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
46
+based on docker.io source material and internal work.
... ...
@@ -17,7 +17,7 @@ each result.
17 17
 
18 18
 # OPTIONS
19 19
 **-f**, **--format**=""
20
-:   The text/template package of Go describes all the details of the
20
+   The text/template package of Go describes all the details of the
21 21
 format. See examples section
22 22
 
23 23
 # EXAMPLES
... ...
@@ -28,11 +28,11 @@ To get information on a container use it's ID or instance name:
28 28
 
29 29
     #docker inspect 1eb5fabf5a03
30 30
     [{
31
-        "ID": "1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b",
32
-	"Created": "2014-04-04T21:33:52.02361335Z",
33
-	"Path": "/usr/sbin/nginx",
34
-	"Args": [],
35
-        "Config": {
31
+       "ID": "1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b",
32
+       "Created": "2014-04-04T21:33:52.02361335Z",
33
+       "Path": "/usr/sbin/nginx",
34
+       "Args": [],
35
+       "Config": {
36 36
             "Hostname": "1eb5fabf5a03",
37 37
             "Domainname": "",
38 38
             "User": "",
... ...
@@ -50,8 +50,8 @@ To get information on a container use it's ID or instance name:
50 50
             "OpenStdin": false,
51 51
             "StdinOnce": false,
52 52
             "Env": [
53
-                "HOME=/",
54
-		"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
53
+               "HOME=/",
54
+	       "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
55 55
             ],
56 56
             "Cmd": [
57 57
                 "/usr/sbin/nginx"
... ...
@@ -66,8 +66,8 @@ To get information on a container use it's ID or instance name:
66 66
             "NetworkDisabled": false,
67 67
             "OnBuild": null,
68 68
             "Context": {
69
-                "mount_label": "system_u:object_r:svirt_sandbox_file_t:s0:c0,c650",
70
-		"process_label": "system_u:system_r:svirt_lxc_net_t:s0:c0,c650"
69
+               "mount_label": "system_u:object_r:svirt_sandbox_file_t:s0:c0,c650",
70
+	       "process_label": "system_u:system_r:svirt_lxc_net_t:s0:c0,c650"
71 71
 	    }
72 72
         },
73 73
         "State": {
... ...
@@ -135,7 +135,8 @@ To get the IP address of a container use:
135 135
 One can loop over arrays and maps in the results to produce simple text
136 136
 output:
137 137
 
138
-    # docker inspect --format='{{range $p, $conf := .NetworkSettings.Ports}} {{$p}} -> {{(index $conf 0).HostPort}} {{end}}' 1eb5fabf5a03
138
+    # docker inspect --format='{{range $p, $conf := .NetworkSettings.Ports}} \
139
+     {{$p}} -> {{(index $conf 0).HostPort}} {{end}}' 1eb5fabf5a03
139 140
 
140 141
     80/tcp -> 80
141 142
 
... ...
@@ -224,5 +225,5 @@ Use an image's ID or name (e.g. repository/name[:tag]) to get information
224 224
 
225 225
 # HISTORY
226 226
 
227
-April 2014, Originally compiled by William Henry (whenry at redhat dot
228
-com) based on docker.io source material and internal work.
227
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
228
+based on docker.io source material and internal work.
... ...
@@ -10,7 +10,7 @@ docker-load - Load an image from a tar archive on STDIN
10 10
 # DESCRIPTION
11 11
 
12 12
 Loads a tarred repository from a file or the standard input stream.
13
- Restores both images and tags.
13
+Restores both images and tags.
14 14
 
15 15
 # OPTIONS
16 16
 
... ...
@@ -33,4 +33,4 @@ Loads a tarred repository from a file or the standard input stream.
33 33
 
34 34
 # HISTORY
35 35
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
36
- based on docker.io source material and internal work.
36
+based on docker.io source material and internal work.
... ...
@@ -10,9 +10,8 @@ docker-login - Register or Login to a docker registry server.
10 10
 
11 11
 # DESCRIPTION
12 12
 Register or Login to a docker registry server, if no server is
13
- specified "https://index.docker.io/v1/" is the default. If you want to
14
- login to a private registry you can specify this by adding the server
15
- name.
13
+specified "https://index.docker.io/v1/" is the default. If you want to
14
+login to a private registry you can specify this by adding the server name.
16 15
 
17 16
 # OPTIONS
18 17
 **-e**, **--email**=""
... ...
@@ -30,7 +29,7 @@ Register or Login to a docker registry server, if no server is
30 30
 
31 31
     # docker login localhost:8080
32 32
 
33
-
34 33
 # HISTORY
35 34
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
36
- based on docker.io source material and internal work.
35
+based on docker.io source material and internal work.
36
+
... ...
@@ -9,12 +9,12 @@ docker-logs - Fetch the logs of a container
9 9
 
10 10
 # DESCRIPTION
11 11
 The **docker logs** command batch-retrieves whatever logs are present for
12
- a container at the time of execution. This does not guarantee execution
12
+a container at the time of execution. This does not guarantee execution
13 13
 order when combined with a docker run (i.e. your run may not have generated
14
- any logs at the time you execute docker logs).
14
+any logs at the time you execute docker logs).
15 15
 
16 16
 The **docker logs --follow** command combines commands **docker logs** and
17
- **docker attach**.  It will first return all logs from the beginning and
17
+**docker attach**.  It will first return all logs from the beginning and
18 18
 then continue streaming new output from the container’s stdout and stderr.
19 19
 
20 20
 # OPTIONS
... ...
@@ -23,4 +23,4 @@ then continue streaming new output from the container’s stdout and stderr.
23 23
 
24 24
 # HISTORY
25 25
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
26
- based on docker.io source material and internal work.
26
+based on docker.io source material and internal work.
... ...
@@ -12,4 +12,4 @@ Lookup the public-facing port which is NAT-ed to PRIVATE_PORT
12 12
 
13 13
 # HISTORY
14 14
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
15
- based on docker.io source material and internal work.
15
+based on docker.io source material and internal work.
... ...
@@ -19,19 +19,19 @@ the running containers.
19 19
 
20 20
 **-a**, **--all**=*true*|*false*
21 21
    When true show all containers. Only running containers are shown by
22
- default. Default is false.
22
+default. Default is false.
23 23
 
24 24
 **--before**=""
25 25
    Show only container created before Id or Name, include non-running
26
- ones.
26
+ones.
27 27
 
28 28
 **-l**, **--latest**=*true*|*false*
29 29
    When true show only the latest created container, include non-running
30
- ones. The default is false.
30
+ones. The default is false.
31 31
 
32 32
 **-n**=NUM
33 33
    Show NUM (integer) last created containers, include non-running ones.
34
- The default is -1 (none)
34
+The default is -1 (none)
35 35
 
36 36
 **--no-trunc**=*true*|*false*
37 37
    When true truncate output. Default is false.
... ...
@@ -65,4 +65,4 @@ the running containers.
65 65
 
66 66
 # HISTORY
67 67
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
68
- based on docker.io source material and internal work.
68
+based on docker.io source material and internal work.
... ...
@@ -33,4 +33,5 @@ images for that repository name are pulled down including any tags.
33 33
 
34 34
 # HISTORY
35 35
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
36
- based on docker.io source material and internal work.
36
+based on docker.io source material and internal work.
37
+
... ...
@@ -9,7 +9,7 @@ docker-push - Push an image or a repository to the registry
9 9
 
10 10
 # DESCRIPTION
11 11
 Push and image or repository to a registry.  The registry may the default
12
- [index.docker.io](https://index.docker.io/v1/) or a another registry
12
+[index.docker.io](https://index.docker.io/v1/) or a another registry
13 13
 
14 14
 # EXAMPLE
15 15
 
... ...
@@ -22,9 +22,9 @@ and then committing it to a new image name:
22 22
 
23 23
 Now push the image to the registry using the image ID. In this example
24 24
 the registry is on host named registry-host and listening on port 5000.
25
- Default Docker commands will push to the default `index.docker.io`
26
- registry. Instead, push to the local registry, which is on a host called
27
- registry-host*. To do this, tag the image with the host name or IP
25
+Default Docker commands will push to the default `index.docker.io`
26
+registry. Instead, push to the local registry, which is on a host called
27
+registry-host*. To do this, tag the image with the host name or IP
28 28
 address, and the port of the registry:
29 29
 
30 30
     # docker tag rhel-httpd registry-host:5000/myadmin/rhel-httpd
... ...
@@ -35,8 +35,8 @@ Check that this worked by running:
35 35
     # docker images
36 36
 
37 37
 You should see both `rhel-httpd` and `registry-host:5000/myadmin/rhel-httpd`
38
- listed.
38
+listed.
39 39
 
40 40
 # HISTORY
41 41
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
42
- based on docker.io source material and internal work.
42
+based on docker.io source material and internal work.
... ...
@@ -13,8 +13,9 @@ Restart each container listed.
13 13
 # OPTIONS
14 14
 **-t**, **--time**=NUM
15 15
    Number of seconds to try to stop for before killing the container. Once
16
- killed it will then be restarted. Default=10
16
+killed it will then be restarted. Default=10
17 17
 
18 18
 # HISTORY
19 19
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
20
- based on docker.io source material and internal work.
20
+based on docker.io source material and internal work.
21
+
... ...
@@ -22,15 +22,15 @@ containers on a host use the **docker ps -a** command.
22 22
 # OPTIONS
23 23
 
24 24
 **-f**, **--force**=*true*|*false*
25
-:   When set to true, force the removal of the container. The default is
25
+   When set to true, force the removal of the container. The default is
26 26
 *false*.
27 27
 
28 28
 **-l**, **--link**=*true*|*false*
29
-:   When set to true, remove the specified link and not the underlying
29
+   When set to true, remove the specified link and not the underlying
30 30
 container. The default is *false*.
31 31
 
32 32
 **-v**, **--volumes**=*true*|*false*
33
-:   When set to true, remove the volumes associated to the container. The
33
+   When set to true, remove the volumes associated to the container. The
34 34
 default is *false*.
35 35
 
36 36
 # EXAMPLES
... ...
@@ -39,7 +39,7 @@ default is *false*.
39 39
 
40 40
 To remove a container using its ID, find either from a **docker ps -a**
41 41
 command, or use the ID returned from the **docker run** command, or retrieve
42
- it from a file used to store it using the **docker run --cidfile**:
42
+it from a file used to store it using the **docker run --cidfile**:
43 43
 
44 44
     docker rm abebf7571666
45 45
 
... ...
@@ -52,5 +52,5 @@ command. The use that name as follows:
52 52
 
53 53
 # HISTORY
54 54
 
55
-April 2014, Originally compiled by William Henry (whenry at redhat dot com) based
56
- on docker.io source material and internal work.
55
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
56
+based on docker.io source material and internal work.
... ...
@@ -13,12 +13,12 @@ docker-rmi \- Remove one or more images.
13 13
 This will remove one or more images from the host node. This does not
14 14
 remove images from a registry. You cannot remove an image of a running
15 15
 container unless you use the **-f** option. To see all images on a host
16
- use the **docker images** command.
16
+use the **docker images** command.
17 17
 
18 18
 # OPTIONS
19 19
 
20 20
 **-f**, **--force**=*true*|*false*
21
-:   When set to true, force the removal of the image. The default is
21
+   When set to true, force the removal of the image. The default is
22 22
 *false*.
23 23
 
24 24
 # EXAMPLES
... ...
@@ -31,5 +31,5 @@ Here is an example of removing and image:
31 31
 
32 32
 # HISTORY
33 33
 
34
-April 2014, Originally compiled by William Henry (whenry at redhat dot com) based
35
- on docker.io source material and internal work.
34
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
35
+based on docker.io source material and internal work.
... ...
@@ -38,112 +38,114 @@ pull** IMAGE, before it starts the container from that image.
38 38
 
39 39
 # OPTIONS
40 40
 
41
-**-a**, **--attach**=*stdin*|*stdout*|*stderr*:
42
-Attach to stdin, stdout or stderr. In foreground mode (the default when **-d** is
43
- not specified), **docker run** can start the process in the container and attach
44
- the console to the process’s standard input, output, and standard error. It can
45
-even pretend to be a TTY (this is what most commandline executables expect) and
46
-pass along signals. The **-a** option can be set for each of stdin, stdout, and
47
-stderr.
48
-
49
-**-c**, **--cpu-shares**=0:
50
-CPU shares in relative weight. You can increase the priority of a container with
51
-the -c option. By default, all containers run at the same priority and get the
52
-same proportion of CPU cycles, but you can tell the kernel to give more shares of
53
- CPU time to one or more containers when you start them via **docker run**.
54
-
55
-**--cidfile**=*file*:
56
-Write the container ID to the file specified.
57
-
58
-
59
-**-d**, **-detach**=*true*|*false*:
60
-Detached mode. This runs the container in the background. It outputs the new
41
+**-a**, **--attach**=*stdin*|*stdout*|*stderr*
42
+   Attach to stdin, stdout or stderr. In foreground mode (the default when
43
+**-d** is not specified), **docker run** can start the process in the container
44
+and attach the console to the process’s standard input, output, and standard
45
+error. It can even pretend to be a TTY (this is what most commandline
46
+executables expect) and pass along signals. The **-a** option can be set for
47
+each of stdin, stdout, and stderr.
48
+
49
+**-c**, **--cpu-shares**=0
50
+   CPU shares in relative weight. You can increase the priority of a container
51
+with the -c option. By default, all containers run at the same priority and get
52
+the same proportion of CPU cycles, but you can tell the kernel to give more
53
+shares of CPU time to one or more containers when you start them via **docker
54
+run**.
55
+
56
+**--cidfile**=*file*
57
+   Write the container ID to the file specified.
58
+
59
+
60
+**-d**, **-detach**=*true*|*false*
61
+   Detached mode. This runs the container in the background. It outputs the new
61 62
 container's ID and any error messages. At any time you can run **docker ps** in
62 63
 the other shell to view a list of the running containers. You can reattach to a
63 64
 detached container with **docker attach**. If you choose to run a container in
64 65
 the detached mode, then you cannot use the **-rm** option.
65 66
 
66 67
 
67
-**--dns**=*IP-address*:
68
-Set custom DNS servers. This option can be used to override the DNS configuration
69
- passed to the container. Typically this is necessary when the host DNS
70
-configuration is invalid for the container (eg. 127.0.0.1). When this is the case
71
- the **-dns** flags is necessary for every run.
68
+**--dns**=*IP-address*
69
+   Set custom DNS servers. This option can be used to override the DNS
70
+configuration passed to the container. Typically this is necessary when the
71
+host DNS configuration is invalid for the container (eg. 127.0.0.1). When this
72
+is the case the **-dns** flags is necessary for every run.
72 73
 
73 74
 
74
-**-e**, **-env**=*environment*:
75
-Set environment variables. This option allows you to specify arbitrary
75
+**-e**, **-env**=*environment*
76
+   Set environment variables. This option allows you to specify arbitrary
76 77
 environment variables that are available for the process that will be launched
77 78
 inside of the container.
78 79
 
79 80
 
80
-**--entrypoint**=*command*:
81
-This option allows you to overwrite the default entrypoint of the image that is
82
-set in the Dockerfile. The ENTRYPOINT of an image is similar to a COMMAND because
83
- it specifies what executable to run when the container starts, but it is
81
+**--entrypoint**=*command*
82
+   This option allows you to overwrite the default entrypoint of the image that
83
+is set in the Dockerfile. The ENTRYPOINT of an image is similar to a COMMAND
84
+because it specifies what executable to run when the container starts, but it is
84 85
 (purposely) more difficult to override. The ENTRYPOINT gives a container its
85 86
 default nature or behavior, so that when you set an ENTRYPOINT you can run the
86 87
 container as if it were that binary, complete with default options, and you can
87 88
 pass in more options via the COMMAND. But, sometimes an operator may want to run
88 89
 something else inside the container, so you can override the default ENTRYPOINT
89
-at runtime by using a **--entrypoint** and a string to specify the new ENTRYPOINT
90
-.
91
-
92
-**--expose**=*port*:
93
-Expose a port from the container without publishing it to your host. A containers
94
- port can be exposed to other containers in three ways: 1) The developer can
95
-expose the port using the EXPOSE parameter of the Dockerfile, 2) the operator can
96
- use the **--expose** option with **docker run**, or 3) the container can be
97
-started with the **--link**.
98
-
99
-**-m**, **-memory**=*memory-limit*:
100
-Allows you to constrain the memory available to a container. If the host supports
101
- swap memory, then the -m memory setting can be larger than physical RAM. The
102
-memory limit format: <number><optional unit>, where unit = b, k, m or g.
103
-
104
-**-P**, **-publish-all**=*true*|*false*:
105
-When set to true publish all exposed ports to the host interfaces. The default is
106
- false. If the operator uses -P (or -p) then Docker will make the exposed port
107
-accessible on the host and the ports will be available to any client that can
108
-reach the host. To find the map between the host ports and the exposed ports, use
109
- **docker port**.
110
-
111
-
112
-**-p**, **-publish**=[]:
113
-Publish a container's port to the host (format: ip:hostPort:containerPort |
90
+at runtime by using a **--entrypoint** and a string to specify the new
91
+ENTRYPOINT.
92
+
93
+**--expose**=*port*
94
+   Expose a port from the container without publishing it to your host. A
95
+containers port can be exposed to other containers in three ways: 1) The
96
+developer can expose the port using the EXPOSE parameter of the Dockerfile, 2)
97
+the operator can use the **--expose** option with **docker run**, or 3) the
98
+container can be started with the **--link**.
99
+
100
+**-m**, **-memory**=*memory-limit*
101
+   Allows you to constrain the memory available to a container. If the host
102
+supports swap memory, then the -m memory setting can be larger than physical
103
+RAM. The memory limit format: <number><optional unit>, where unit = b, k, m or
104
+g.
105
+
106
+**-P**, **-publish-all**=*true*|*false*
107
+   When set to true publish all exposed ports to the host interfaces. The
108
+default is false. If the operator uses -P (or -p) then Docker will make the
109
+exposed port accessible on the host and the ports will be available to any
110
+client that can reach the host. To find the map between the host ports and the
111
+exposed ports, use **docker port**.
112
+
113
+
114
+**-p**, **-publish**=[]
115
+   Publish a container's port to the host (format: ip:hostPort:containerPort |
114 116
 ip::containerPort | hostPort:containerPort) (use **docker port** to see the
115 117
 actual mapping)
116 118
 
117 119
 
118
-**-h**, **-hostname**=*hostname*:
119
-Sets the container host name that is available inside the container.
120
+**-h**, **-hostname**=*hostname*
121
+   Sets the container host name that is available inside the container.
120 122
 
121 123
 
122
-**-i**, **-interactive**=*true*|*false*:
123
-When set to true, keep stdin open even if not attached. The default is false.
124
+**-i**, **-interactive**=*true*|*false*
125
+   When set to true, keep stdin open even if not attached. The default is false.
124 126
 
125 127
 
126
-**--link**=*name*:*alias*:
127
-Add link to another container. The format is name:alias. If the operator uses
128
-**--link** when starting the new client container, then the client container can
129
-access the exposed port via a private networking interface. Docker will set some
130
-environment variables in the client container to help indicate which interface
131
-and port to use.
128
+**--link**=*name*:*alias*
129
+   Add link to another container. The format is name:alias. If the operator
130
+uses **--link** when starting the new client container, then the client
131
+container can access the exposed port via a private networking interface. Docker
132
+will set some environment variables in the client container to help indicate
133
+which interface and port to use.
132 134
 
133 135
 
134
-**-n**, **-networking**=*true*|*false*:
135
-By default, all containers have networking enabled (true) and can make outgoing
136
-connections. The operator can disable networking with **--networking** to false.
137
- This disables all incoming and outgoing networking. In cases like this, I/O can
138
-only be performed through files or by using STDIN/STDOUT.
136
+**-n**, **-networking**=*true*|*false*
137
+   By default, all containers have networking enabled (true) and can make
138
+outgoing connections. The operator can disable networking with **--networking**
139
+to false. This disables all incoming and outgoing networking. In cases like this
140
+, I/O can only be performed through files or by using STDIN/STDOUT.
139 141
 
140 142
 Also by default, the container will use the same DNS servers as the host. The
141 143
 operator may override this with **-dns**.
142 144
 
143 145
 
144
-**--name**=*name*:
145
-Assign a name to the container. The operator can identify a container in three
146
-ways:
146
+**--name**=*name*
147
+   Assign a name to the container. The operator can identify a container in
148
+three ways:
147 149
 
148 150
     UUID long identifier (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”)
149 151
     UUID short identifier (“f78375b1c487”)
... ...
@@ -152,73 +154,73 @@ ways:
152 152
 The UUID identifiers come from the Docker daemon, and if a name is not assigned
153 153
 to the container with **--name** then the daemon will also generate a random
154 154
 string name. The name is useful when defining links (see **--link**) (or any
155
-other place you need to identify a container). This works for both background and
156
- foreground Docker containers.
155
+other place you need to identify a container). This works for both background
156
+and foreground Docker containers.
157 157
 
158 158
 
159
-**--privileged**=*true*|*false*:
160
-Give extended privileges to this container. By default, Docker containers are
159
+**--privileged**=*true*|*false*
160
+   Give extended privileges to this container. By default, Docker containers are
161 161
 “unprivileged” (=false) and cannot, for example, run a Docker daemon inside the
162
-Docker container. This is because by default a container is not allowed to access
163
- any devices. A “privileged” container is given access to all devices.
162
+Docker container. This is because by default a container is not allowed to
163
+access any devices. A “privileged” container is given access to all devices.
164 164
 
165 165
 When the operator executes **docker run -privileged**, Docker will enable access
166
-to all devices on the host as well as set some configuration in AppArmor to allow
167
- the container nearly all the same access to the host as processes running
166
+to all devices on the host as well as set some configuration in AppArmor to
167
+allow the container nearly all the same access to the host as processes running
168 168
 outside of a container on the host.
169 169
 
170 170
 
171
-**--rm**=*true*|*false*:
172
-If set to *true* the container is automatically removed when it exits. The
171
+**--rm**=*true*|*false*
172
+   If set to *true* the container is automatically removed when it exits. The
173 173
 default is *false*. This option is incompatible with **-d**.
174 174
 
175 175
 
176
-**--sig-proxy**=*true*|*false*:
177
-When set to true, proxify all received signals to the process (even in non-tty
178
-mode). The default is true.
176
+**--sig-proxy**=*true*|*false*
177
+   When set to true, proxify all received signals to the process (even in
178
+non-tty mode). The default is true.
179 179
 
180 180
 
181
-**-t**, **-tty**=*true*|*false*:
182
-When set to true Docker can allocate a pseudo-tty and attach to the standard
181
+**-t**, **-tty**=*true*|*false*
182
+   When set to true Docker can allocate a pseudo-tty and attach to the standard
183 183
 input of any container. This can be used, for example, to run a throwaway
184 184
 interactive shell. The default is value is false.
185 185
 
186 186
 
187
-**-u**, **-user**=*username*,*uid*:
188
-Set a username or UID for the container.
187
+**-u**, **-user**=*username*,*uid*
188
+   Set a username or UID for the container.
189 189
 
190 190
 
191
-**-v**, **-volume**=*volume*:
192
-Bind mount a volume to the container. The **-v** option can be used one or more
193
-times to add one or more mounts to a container. These mounts can then be used in
194
-other containers using the **--volumes-from** option. See examples.
191
+**-v**, **-volume**=*volume*
192
+   Bind mount a volume to the container. The **-v** option can be used one or
193
+more times to add one or more mounts to a container. These mounts can then be
194
+used in other containers using the **--volumes-from** option. See examples.
195 195
 
196 196
 
197
-**--volumes-from**=*container-id*:
198
-Will mount volumes from the specified container identified by container-id. Once
199
-a volume is mounted in a one container it can be shared with other containers
200
-using the **--volumes-from** option when running those other containers. The
201
-volumes can be shared even if the original container with the mount is not
202
-running.
197
+**--volumes-from**=*container-id*
198
+   Will mount volumes from the specified container identified by container-id.
199
+Once a volume is mounted in a one container it can be shared with other
200
+containers using the **--volumes-from** option when running those other
201
+containers. The volumes can be shared even if the original container with the
202
+mount is not running.
203 203
 
204 204
 
205
-**-w**, **-workdir**=*directory*:
206
-Working directory inside the container. The default working directory for running
207
- binaries within a container is the root directory (/). The developer can set a
208
-different default with the Dockerfile WORKDIR instruction. The operator can
209
-override the working directory by using the **-w** option.
205
+**-w**, **-workdir**=*directory*
206
+   Working directory inside the container. The default working directory for
207
+running binaries within a container is the root directory (/). The developer can
208
+set a different default with the Dockerfile WORKDIR instruction. The operator
209
+can override the working directory by using the **-w** option.
210 210
 
211 211
 
212
-**IMAGE**:
213
-The image name or ID.
212
+**IMAGE**
213
+   The image name or ID.
214 214
 
215 215
 
216
-**COMMAND**:
217
-The command or program to run inside the image.
216
+**COMMAND**
217
+   The command or program to run inside the image.
218 218
 
219 219
 
220
-**ARG**:
221
-The arguments for the command to be run in the container.
220
+**ARG**
221
+   The arguments for the command to be run in the container.
222 222
 
223 223
 # EXAMPLES
224 224
 
... ...
@@ -252,12 +254,13 @@ you’d like to connect instead, as in:
252 252
 ## Linking Containers
253 253
 
254 254
 The link feature allows multiple containers to communicate with each other. For
255
-example, a container whose Dockerfile has exposed port 80 can be run and named as
256
- follows:
255
+example, a container whose Dockerfile has exposed port 80 can be run and named
256
+as follows:
257 257
 
258 258
     # docker run --name=link-test -d -i -t fedora/httpd
259 259
 
260
-A second container, in this case called linker, can communicate with the httpd container, named link-test, by running with the **--link=<name>:<alias>**
260
+A second container, in this case called linker, can communicate with the httpd
261
+container, named link-test, by running with the **--link=<name>:<alias>**
261 262
 
262 263
     # docker run -t -i --link=link-test:lt --name=linker fedora /bin/bash
263 264
 
... ...
@@ -280,15 +283,15 @@ Running the **env** command in the linker container shows environment variables
280 280
     LT_PORT_80_TCP_ADDR=172.17.0.3
281 281
     _=/usr/bin/env
282 282
 
283
-When linking two containers Docker will use the exposed ports of the container to
284
- create a secure tunnel for the parent to access.
283
+When linking two containers Docker will use the exposed ports of the container
284
+to create a secure tunnel for the parent to access.
285 285
 
286 286
 
287 287
 ## Mapping Ports for External Usage
288 288
 
289 289
 The exposed port of an application can be mapped to a host port using the **-p**
290
- flag. For example a httpd port 80 can be mapped to the host port 8080 using the
291
- following:
290
+flag. For example a httpd port 80 can be mapped to the host port 8080 using the
291
+following:
292 292
 
293 293
     # docker run -p 8080:80 -d -i -t fedora/httpd
294 294
 
... ...
@@ -313,8 +316,9 @@ container, allowing to abstract the actual data source from users of that data:
313 313
 
314 314
 ## Mounting External Volumes
315 315
 
316
-To mount a host directory as a container volume, specify the absolute path to the
317
- directory and the absolute path for the container directory separated by a colon:
316
+To mount a host directory as a container volume, specify the absolute path to
317
+the directory and the absolute path for the container directory separated by a
318
+colon:
318 319
 
319 320
     # docker run -v /var/db:/data1 -i -t fedora bash
320 321
 
... ...
@@ -335,5 +339,5 @@ Now, writing to the /data1 volume in the container will be allowed and the
335 335
 changes will also be reflected on the host in /var/db.
336 336
 
337 337
 # HISTORY
338
-April 2014, Originally compiled by William Henry (whenry at redhat dot com) based
339
- on docker.io source material and internal work.
338
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
339
+based on docker.io source material and internal work.
... ...
@@ -20,7 +20,7 @@ Stream to a file instead of STDOUT by using **-o**.
20 20
 # EXAMPLE
21 21
 
22 22
 Save all fedora repository images to a fedora-all.tar and save the latest
23
- fedora image to a fedora-latest.tar:
23
+fedora image to a fedora-latest.tar:
24 24
 
25 25
     $ sudo docker save fedora > fedora-all.tar
26 26
     $ sudo docker save --output=fedora-latest.tar fedora:latest
... ...
@@ -31,4 +31,5 @@ Save all fedora repository images to a fedora-all.tar and save the latest
31 31
 
32 32
 # HISTORY
33 33
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
34
- based on docker.io source material and internal work.
34
+based on docker.io source material and internal work.
35
+
... ...
@@ -12,18 +12,18 @@ docker-search - Search the docker index for images
12 12
 
13 13
 Search an index for an image with that matches the term TERM. The table
14 14
 of images returned displays the name, description (truncated by default),
15
- number of stars awarded, whether the image is official, and
16
-whether it is trusted.
15
+number of stars awarded, whether the image is official, and whether it
16
+is trusted.
17 17
 
18 18
 # OPTIONS
19
-**--no-trunc**=*true*|*false*:
19
+**--no-trunc**=*true*|*false*
20 20
    When true display the complete description. The default is false.
21 21
 
22 22
 **-s**, **--stars**=NUM
23 23
    Only displays with at least NUM (integer) stars. I.e. only those images
24 24
 ranked >=NUM.
25 25
 
26
-**-t**, **--trusted**=*true*|*false*:
26
+**-t**, **--trusted**=*true*|*false*
27 27
    When true only show trusted builds. The default is false.
28 28
 
29 29
 # EXAMPLE
... ...
@@ -52,4 +52,4 @@ ranked 1 or higher:
52 52
 
53 53
 # HISTORY
54 54
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
55
- based on docker.io source material and internal work.
55
+based on docker.io source material and internal work.
... ...
@@ -22,4 +22,4 @@ the process
22 22
 
23 23
 # HISTORY
24 24
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
25
- based on docker.io source material and internal work.
25
+based on docker.io source material and internal work.
... ...
@@ -19,4 +19,4 @@ The default is 10 seconds.
19 19
 
20 20
 # HISTORY
21 21
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
22
- based on docker.io source material and internal work.
22
+based on docker.io source material and internal work.
... ...
@@ -12,21 +12,22 @@ IMAGE [REGISTRYHOST/][USERNAME/]NAME[:TAG]
12 12
 This will tag an image in the repository.
13 13
 
14 14
 # "OPTIONS"
15
-**-f**, **--force**=*true*|*false*:
16
-When set to true, force the tag name. The default is *false*.
15
+**-f**, **--force**=*true*|*false*
16
+   When set to true, force the tag name. The default is *false*.
17 17
 
18 18
 **REGISTRYHOST**
19
-: The hostname of the registry if required. This may also include the port
19
+   The hostname of the registry if required. This may also include the port
20 20
 separated by a ':'
21 21
 
22 22
 **USERNAME**
23
-: The username or other qualifying identifier for the image.
23
+   The username or other qualifying identifier for the image.
24 24
 
25 25
 **NAME**
26
-: The image name.
26
+   The image name.
27 27
 
28 28
 **TAG**
29
-: The tag you are assigning to the image.
29
+   The tag you are assigning to the image.
30
+
30 31
 # EXAMPLES
31 32
 
32 33
 ## Tagging an image
... ...
@@ -43,5 +44,5 @@ registry you must tag it with the registry hostname and port (if needed).
43 43
     docker tag 0e5574283393 myregistryhost:5000/fedora/httpd:version1.0
44 44
 
45 45
 # HISTORY
46
-April 2014, Originally compiled by William Henry (whenry at redhat dot com) based
47
- on docker.io source material and internal work.
46
+April 2014, Originally compiled by William Henry (whenry at redhat dot com)
47
+based on docker.io source material and internal work.
... ...
@@ -23,4 +23,5 @@ Run **docker top** with the ps option of -x:
23 23
 
24 24
 # HISTORY
25 25
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
26
- based on docker.io source material and internal work.
26
+based on docker.io source material and internal work.
27
+
... ...
@@ -19,4 +19,5 @@ Block until a container stops, then print its exit code.
19 19
 
20 20
 # HISTORY
21 21
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
22
- based on docker.io source material and internal work.
22
+based on docker.io source material and internal work.
23
+