Browse code

Update cli.md and man pages to match current cli

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

SvenDowideit authored on 2014/07/01 11:58:04
Showing 40 changed files
... ...
@@ -1540,7 +1540,7 @@ func (cli *DockerCli) CmdCommit(args ...string) error {
1540 1540
 	cmd := cli.Subcmd("commit", "[OPTIONS] CONTAINER [REPOSITORY[:TAG]]", "Create a new image from a container's changes")
1541 1541
 	flPause := cmd.Bool([]string{"p", "-pause"}, true, "Pause container during commit")
1542 1542
 	flComment := cmd.String([]string{"m", "-message"}, "", "Commit message")
1543
-	flAuthor := cmd.String([]string{"a", "#author", "-author"}, "", "Author (eg. \"John Hannibal Smith <hannibal@a-team.com>\")")
1543
+	flAuthor := cmd.String([]string{"a", "#author", "-author"}, "", "Author (e.g., \"John Hannibal Smith <hannibal@a-team.com>\")")
1544 1544
 	// FIXME: --run is deprecated, it will be replaced with inline Dockerfile commands.
1545 1545
 	flConfig := cmd.String([]string{"#run", "#-run"}, "", "This option is deprecated and will be removed in a future version in favor of inline Dockerfile-compatible commands")
1546 1546
 	if err := cmd.Parse(args); err != nil {
... ...
@@ -79,7 +79,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from build' -s t -l tag -d '
79 79
 
80 80
 # commit
81 81
 complete -c docker -f -n '__fish_docker_no_subcommand' -a commit -d "Create a new image from a container's changes"
82
-complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -s a -l author -d 'Author (eg. "John Hannibal Smith <hannibal@a-team.com>"'
82
+complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -s a -l author -d 'Author (e.g., "John Hannibal Smith <hannibal@a-team.com>"'
83 83
 complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -s m -l message -d 'Commit message'
84 84
 complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -l run -d 'Config automatically applied when the image is run. (ex: -run=\'{"Cmd": ["cat", "/world"], "PortSpecs": ["22"]}\')'
85 85
 complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -a '(__fish_print_docker_containers all)' -d "Container"
86 86
new file mode 100755
... ...
@@ -0,0 +1,214 @@
0
+#!/usr/bin/env python
1
+
2
+#
3
+# Sven's quick hack script to update the documentation
4
+#
5
+# call with:
6
+#       ./docs/update.py /usr/bin/docker
7
+#
8
+
9
+import re
10
+from sys import argv
11
+import subprocess
12
+import os
13
+import os.path
14
+
15
+script, docker_cmd = argv
16
+
17
+def print_usage(outtext, docker_cmd, command):
18
+    help = ""
19
+    try:
20
+        #print "RUN ", "".join((docker_cmd, " ", command, " --help"))
21
+        help = subprocess.check_output("".join((docker_cmd, " ", command, " --help")), stderr=subprocess.STDOUT, shell=True)
22
+    except subprocess.CalledProcessError, e:
23
+        help = e.output
24
+    for l in str(help).strip().split("\n"):
25
+        l = l.rstrip()
26
+        if l == '':
27
+            outtext.write("\n")
28
+        else:
29
+            # `docker --help` tells the user the path they called it with
30
+            l = re.sub(docker_cmd, "docker", l)
31
+            outtext.write("    "+l+"\n")
32
+    outtext.write("\n")
33
+
34
+# TODO: look for an complain about any missing commands
35
+def update_cli_reference():
36
+    originalFile = "docs/sources/reference/commandline/cli.md"
37
+    os.rename(originalFile, originalFile+".bak")
38
+
39
+    intext = open(originalFile+".bak", "r")
40
+    outtext = open(originalFile, "w")
41
+
42
+    mode = 'p'
43
+    space = "    "
44
+    command = ""
45
+    # 2 mode line-by line parser
46
+    for line in intext:
47
+        if mode=='p':
48
+            # Prose
49
+            match = re.match("(    \s*)Usage: docker ([a-z]+)", line)
50
+            if match:
51
+                # the begining of a Docker command usage block
52
+                space = match.group(1)
53
+                command = match.group(2)
54
+                mode = 'c'
55
+            else:
56
+                match = re.match("(    \s*)Usage of .*docker.*:", line)
57
+                if match:
58
+                    # the begining of the Docker --help usage block
59
+                    space = match.group(1)
60
+                    command = ""
61
+                    mode = 'c'
62
+                else:
63
+                    outtext.write(line)
64
+        else:
65
+            # command usage block
66
+            match = re.match("("+space+")(.*)|^$", line)
67
+            #print "CMD ", command
68
+            if not match:
69
+                # The end of the current usage block - Shell out to run docker to see the new output
70
+                print_usage(outtext, docker_cmd, command)
71
+                outtext.write(line)
72
+                mode = 'p'
73
+    if mode == 'c':
74
+        print_usage(outtext, docker_cmd, command)
75
+
76
+def update_man_pages():
77
+    cmds = []
78
+    try:
79
+        help = subprocess.check_output("".join((docker_cmd)), stderr=subprocess.STDOUT, shell=True)
80
+    except subprocess.CalledProcessError, e:
81
+        help = e.output
82
+    for l in str(help).strip().split("\n"):
83
+        l = l.rstrip()
84
+        if l != "":
85
+            match = re.match("    (.*?) .*", l)
86
+            if match:
87
+                cmds.append(match.group(1))
88
+
89
+    desc_re = re.compile(r".*# DESCRIPTION(.*?)# (OPTIONS|EXAMPLES?).*", re.MULTILINE|re.DOTALL)
90
+    example_re = re.compile(r".*# EXAMPLES?(.*)# HISTORY.*", re.MULTILINE|re.DOTALL)
91
+    history_re = re.compile(r".*# HISTORY(.*)", re.MULTILINE|re.DOTALL)
92
+
93
+    for command in cmds:
94
+        print "COMMAND: "+command
95
+        history = ""
96
+        description = ""
97
+        examples = ""
98
+        if os.path.isfile("docs/man/docker-"+command+".1.md"):
99
+            intext = open("docs/man/docker-"+command+".1.md", "r")
100
+            txt = intext.read()
101
+            intext.close()
102
+            match = desc_re.match(txt)
103
+            if match:
104
+                description = match.group(1)
105
+            match = example_re.match(txt)
106
+            if match:
107
+                examples = match.group(1)
108
+            match = history_re.match(txt)
109
+            if match:
110
+                history = match.group(1).strip()
111
+        
112
+        usage = ""
113
+        usage_description = ""
114
+        params = {}
115
+        key_params = {}
116
+        
117
+        help = ""
118
+        try:
119
+            help = subprocess.check_output("".join((docker_cmd, " ", command, " --help")), stderr=subprocess.STDOUT, shell=True)
120
+        except subprocess.CalledProcessError, e:
121
+            help = e.output
122
+        last_key = ""
123
+        for l in str(help).split("\n"):
124
+            l = l.rstrip()
125
+            if l != "":
126
+                match = re.match("Usage: docker "+command+"(.*)", l)
127
+                if match:
128
+                    usage = match.group(1).strip()
129
+                else:
130
+                    #print ">>>>"+l
131
+                    match = re.match("  (-+)(.*) \s+(.*)", l)
132
+                    if match:
133
+                        last_key = match.group(2).rstrip()
134
+                        #print "    found "+match.group(1)
135
+                        key_params[last_key] = match.group(1)+last_key
136
+                        params[last_key] = match.group(3)
137
+                    else:
138
+                        if last_key != "":
139
+                            params[last_key] = params[last_key] + "\n" + l
140
+                        else:
141
+                            if usage_description != "":
142
+                                usage_description = usage_description + "\n"
143
+                            usage_description = usage_description + l
144
+        
145
+        # replace [OPTIONS] with the list of params     
146
+        options = ""
147
+        match = re.match("\[OPTIONS\](.*)", usage)
148
+        if match:
149
+            usage = match.group(1)
150
+
151
+        new_usage = ""
152
+        # TODO: sort without the `-`'s
153
+        for key in sorted(params.keys(), key=lambda s: s.lower()):
154
+            # split on commas, remove --?.*=.*, put in *'s mumble
155
+            ps = []
156
+            opts = []
157
+            for k in key_params[key].split(","):
158
+                #print "......"+k
159
+                match = re.match("(-+)([A-Za-z-0-9]*)(?:=(.*))?", k.lstrip())
160
+                if match:
161
+                    p = "**"+match.group(1)+match.group(2)+"**"
162
+                    o = "**"+match.group(1)+match.group(2)+"**"
163
+                    if match.group(3):
164
+                        # if ="" then use UPPERCASE(group(2))"
165
+                        val = match.group(3)
166
+                        if val == "\"\"":
167
+                            val = match.group(2).upper()
168
+                        p = p+"[=*"+val+"*]"
169
+                        val = match.group(3)
170
+                        if val in ("true", "false"):
171
+                            params[key] = params[key].rstrip()
172
+                            if not params[key].endswith('.'):
173
+                                params[key] = params[key]+ "."
174
+                            params[key] = params[key] + " The default is *"+val+"*."
175
+                            val = "*true*|*false*"
176
+                        o = o+"="+val
177
+                    ps.append(p)
178
+                    opts.append(o)
179
+                else:
180
+                    print "nomatch:"+k
181
+            new_usage = new_usage+ "\n["+"|".join(ps)+"]"
182
+            options = options + ", ".join(opts) + "\n   "+ params[key]+"\n\n"
183
+        if new_usage != "":
184
+            new_usage = new_usage.strip() + "\n"
185
+        usage = new_usage + usage
186
+            
187
+        
188
+        outtext = open("docs/man/docker-"+command+".1.md", "w")
189
+        outtext.write("""% DOCKER(1) Docker User Manuals
190
+% Docker Community
191
+% JUNE 2014
192
+# NAME
193
+""")
194
+        outtext.write("docker-"+command+" - "+usage_description+"\n\n")
195
+        outtext.write("# SYNOPSIS\n**docker "+command+"**\n"+usage+"\n\n")
196
+        if description != "":
197
+            outtext.write("# DESCRIPTION"+description)
198
+        if options == "":
199
+            options = "There are no available options.\n\n"
200
+        outtext.write("# OPTIONS\n"+options)
201
+        if examples != "":
202
+           outtext.write("# EXAMPLES"+examples)
203
+        outtext.write("# HISTORY\n")
204
+        if history != "":
205
+           outtext.write(history+"\n")
206
+        recent_history_re = re.compile(".*June 2014.*", re.MULTILINE|re.DOTALL)
207
+        if not recent_history_re.match(history):
208
+            outtext.write("June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>\n")
209
+        outtext.close()
210
+
211
+# main
212
+update_cli_reference()
213
+update_man_pages()
... ...
@@ -1,11 +1,14 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-attach - Attach to a running container
6 6
 
7 7
 # SYNOPSIS
8
-**docker attach** **--no-stdin**[=*false*] **--sig-proxy**[=*true*] CONTAINER
8
+**docker attach**
9
+[**--no-stdin**[=*false*]]
10
+[**--sig-proxy**[=*true*]]
11
+ CONTAINER
9 12
 
10 13
 # DESCRIPTION
11 14
 If you **docker run** a container in detached mode (**-d**), you can reattach to
... ...
@@ -19,11 +22,10 @@ the client.
19 19
 
20 20
 # OPTIONS
21 21
 **--no-stdin**=*true*|*false*
22
-When set to true, do not attach to stdin. The default is *false*.
22
+   Do not attach STDIN. The default is *false*.
23 23
 
24
-**--sig-proxy**=*true*|*false*:
25
-When set to true, proxify received signals to the process (even in non-tty
26
-mode). SIGCHLD is not proxied. The default is *true*.
24
+**--sig-proxy**=*true*|*false*
25
+   Proxify all received signals to the process (even in non-TTY mode). SIGCHLD is not proxied. The default is *true*.
27 26
 
28 27
 # EXAMPLES
29 28
 
... ...
@@ -56,3 +58,4 @@ attach** command:
56 56
 # HISTORY
57 57
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
58 58
 based on docker.io source material and internal work.
59
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,12 +1,17 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-build - Build an image from a Dockerfile source at PATH
5
+docker-build - Build a new image from the source code at PATH
6 6
 
7 7
 # SYNOPSIS
8
-**docker build** [**--no-cache**[=*false*]] [**-q**|**--quiet**[=*false*]]
9
- [**--rm**] [**-t**|**--tag**=TAG] PATH | URL | -
8
+**docker build**
9
+[**--force-rm**[=*false*]]
10
+[**--no-cache**[=*false*]]
11
+[**-q**|**--quiet**[=*false*]]
12
+[**--rm**[=*true*]]
13
+[**-t**|**--tag**[=*TAG*]]
14
+ PATH | URL | -
10 15
 
11 16
 # DESCRIPTION
12 17
 This will read the Dockerfile from the directory specified in **PATH**.
... ...
@@ -25,22 +30,20 @@ When a Git repository is set as the **URL**, the repository is used
25 25
 as context.
26 26
 
27 27
 # OPTIONS
28
+**--force-rm**=*true*|*false*
29
+   Always remove intermediate containers, even after unsuccessful builds. The default is *false*.
30
+
31
+**--no-cache**=*true*|*false*
32
+   Do not use cache when building the image. The default is *false*.
28 33
 
29 34
 **-q**, **--quiet**=*true*|*false*
30
-   When set to true, suppress verbose build output. Default is *false*.
35
+   Suppress the verbose output generated by the containers. The default is *false*.
31 36
 
32 37
 **--rm**=*true*|*false*
33
-   When true, remove intermediate containers that are created during the
34
-build process. The default is true.
38
+   Remove intermediate containers after a successful build. The default is *true*.
35 39
 
36
-**-t**, **--tag**=*tag*
37
-   The name to be applied to the resulting image on successful completion of
38
-the build. `tag` in this context means the entire image name including the 
39
-optional TAG after the ':'.
40
-
41
-**--no-cache**=*true*|*false*
42
-   When set to true, do not use a cache when building the image. The
43
-default is *false*.
40
+**-t**, **--tag**=""
41
+   Repository name (and optionally a tag) to be applied to the resulting image in case of success
44 42
 
45 43
 # EXAMPLES
46 44
 
... ...
@@ -115,3 +118,4 @@ Note: You can set an arbitrary Git repository via the `git://` schema.
115 115
 # HISTORY
116 116
 March 2014, Originally compiled by William Henry (whenry at redhat dot com)
117 117
 based on docker.io source material and internal work.
118
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,22 +1,23 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-commit - Create a new image from the changes to an existing
6
-container
5
+docker-commit - Create a new image from a container's changes
7 6
 
8 7
 # SYNOPSIS
9
-**docker commit** **-a**|**--author**[=""] **-m**|**--message**[=""]
10
-CONTAINER [REPOSITORY[:TAG]]
8
+**docker commit**
9
+[**-a**|**--author**[=*AUTHOR*]]
10
+[**-m**|**--message**[=*MESSAGE*]]
11
+ CONTAINER [REPOSITORY[:TAG]]
11 12
 
12 13
 # DESCRIPTION
13 14
 Using an existing container's name or ID you can create a new image.
14 15
 
15 16
 # OPTIONS
16
-**-a, --author**=""
17
-   Author name. (e.g., "John Hannibal Smith <hannibal@a-team.com>"
17
+**-a**, **--author**=""
18
+   Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
18 19
 
19
-**-m, --message**=""
20
+**-m**, **--message**=""
20 21
    Commit message
21 22
 
22 23
 **-p, --pause**=true
... ...
@@ -35,3 +36,4 @@ create a new image run docker ps to find the container's ID and then run:
35 35
 # HISTORY
36 36
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
37 37
 based on docker.io source material and in
38
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,18 +1,22 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-cp - Copy files/folders from the PATH to the HOSTPATH
6 6
 
7 7
 # SYNOPSIS
8
-**docker cp** CONTAINER:PATH HOSTPATH
8
+**docker cp**
9
+CONTAINER:PATH HOSTPATH
9 10
 
10 11
 # DESCRIPTION
11 12
 Copy files/folders from a container's filesystem to the host
12 13
 path. Paths are relative to the root of the filesystem. Files
13 14
 can be copied from a running or stopped container.
14 15
 
15
-# EXAMPLE
16
+# OPTIONS
17
+There are no available options.
18
+
19
+# EXAMPLES
16 20
 An important shell script file, created in a bash shell, is copied from
17 21
 the exited container to the current dir on the host:
18 22
 
... ...
@@ -21,4 +25,4 @@ the exited container to the current dir on the host:
21 21
 # HISTORY
22 22
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
23 23
 based on docker.io source material and internal work.
24
-
24
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,18 +1,22 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-diff - Inspect changes on a container's filesystem
6 6
 
7 7
 # SYNOPSIS
8
-**docker diff** CONTAINER
8
+**docker diff**
9
+CONTAINER
9 10
 
10 11
 # DESCRIPTION
11 12
 Inspect changes on a container's filesystem. You can use the full or
12 13
 shortened container ID or the container name set using
13 14
 **docker run --name** option.
14 15
 
15
-# EXAMPLE
16
+# OPTIONS
17
+There are no available options.
18
+
19
+# EXAMPLES
16 20
 Inspect the changes to on a nginx container:
17 21
 
18 22
     # docker diff 1fdfd1f54c1b
... ...
@@ -40,5 +44,4 @@ Inspect the changes to on a nginx container:
40 40
 # HISTORY
41 41
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
42 42
 based on docker.io source material and internal work.
43
-
44
-
43
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,10 +1,14 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-events - Get real time events from the server
6 6
 
7
-**docker events** **--since**=""|*epoch-time*
7
+# SYNOPSIS
8
+**docker events**
9
+[**--since**[=*SINCE*]]
10
+[**--until**[=*UNTIL*]]
11
+
8 12
 
9 13
 # DESCRIPTION
10 14
 Get event information from the Docker daemon. Information can include historical
... ...
@@ -12,8 +16,10 @@ information and real-time information.
12 12
 
13 13
 # OPTIONS
14 14
 **--since**=""
15
-Show previously created events and then stream. This can be in either
16
-seconds since epoch, or date string.
15
+   Show all events created since timestamp
16
+
17
+**--until**=""
18
+   Stream events until this timestamp
17 19
 
18 20
 # EXAMPLES
19 21
 
... ...
@@ -44,3 +50,4 @@ Again the output container IDs have been shortened for the purposes of this docu
44 44
 # HISTORY
45 45
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
46 46
 based on docker.io source material and internal work.
47
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,19 +1,22 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-export - Export the contents of a filesystem as a tar archive to
6
-STDOUT.
5
+docker-export - Export the contents of a filesystem as a tar archive to STDOUT
7 6
 
8 7
 # SYNOPSIS
9
-**docker export** CONTAINER
8
+**docker export**
9
+CONTAINER
10 10
 
11 11
 # DESCRIPTION
12 12
 Export the contents of a container's filesystem using the full or shortened
13 13
 container ID or container name. The output is exported to STDOUT and can be
14 14
 redirected to a tar file.
15 15
 
16
-# EXAMPLE
16
+# OPTIONS
17
+There are no available options.
18
+
19
+# EXAMPLES
17 20
 Export the contents of the container called angry_bell to a tar file
18 21
 called test.tar:
19 22
 
... ...
@@ -24,3 +27,4 @@ called test.tar:
24 24
 # HISTORY
25 25
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
26 26
 based on docker.io source material and internal work.
27
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,11 +1,13 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-history - Show the history of an image
6 6
 
7 7
 # SYNOPSIS
8
-**docker history** **--no-trunc**[=*false*] [**-q**|**--quiet**[=*false*]]
8
+**docker history**
9
+[**--no-trunc**[=*false*]]
10
+[**-q**|**--quiet**[=*false*]]
9 11
  IMAGE
10 12
 
11 13
 # DESCRIPTION
... ...
@@ -13,14 +15,13 @@ docker-history - Show the history of an image
13 13
 Show the history of when and how an image was created.
14 14
 
15 15
 # OPTIONS
16
-
17 16
 **--no-trunc**=*true*|*false*
18
-   When true don't truncate output. Default is false
17
+   Don't truncate output. The default is *false*.
19 18
 
20
-**-q**, **--quiet=*true*|*false*
21
-   When true only show numeric IDs. Default is false.
19
+**-q**, **--quiet**=*true*|*false*
20
+   Only show numeric IDs. The default is *false*.
22 21
 
23
-# EXAMPLE
22
+# EXAMPLES
24 23
     $ sudo docker history fedora
25 24
     IMAGE          CREATED          CREATED BY                                      SIZE
26 25
     105182bb5e8b   5 days ago       /bin/sh -c #(nop) ADD file:71356d2ad59aa3119d   372.7 MB
... ...
@@ -30,3 +31,4 @@ Show the history of when and how an image was created.
30 30
 # HISTORY
31 31
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
32 32
 based on docker.io source material and internal work.
33
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,17 +1,16 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-images - List the images in the local repository
5
+docker-images - List images
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker images**
9
-[**-a**|**--all**=*false*]
10
-[**--no-trunc**[=*false*]
11
-[**-q**|**--quiet**[=*false*]
12
-[**-t**|**--tree**=*false*]
13
-[**-v**|**--viz**=*false*]
14
-[NAME]
9
+[**-a**|**--all**[=*false*]]
10
+[**-f**|**--filter**[=*[]*]]
11
+[**--no-trunc**[=*false*]]
12
+[**-q**|**--quiet**[=*false*]]
13
+ [NAME]
15 14
 
16 15
 # DESCRIPTION
17 16
 This command lists the images stored in the local Docker repository.
... ...
@@ -30,26 +29,17 @@ called fedora. It may be tagged with 18, 19, or 20, etc. to manage different
30 30
 versions.
31 31
 
32 32
 # OPTIONS
33
-
34 33
 **-a**, **--all**=*true*|*false*
35
-   When set to true, also include all intermediate images in the list. The
36
-default is false.
34
+   Show all images (by default filter out the intermediate image layers). The default is *false*.
35
+
36
+**-f**, **--filter**=[]
37
+   Provide filter values (i.e. 'dangling=true')
37 38
 
38 39
 **--no-trunc**=*true*|*false*
39
-   When set to true, list the full image ID and not the truncated ID. The
40
-default is false.
40
+   Don't truncate output. The default is *false*.
41 41
 
42 42
 **-q**, **--quiet**=*true*|*false*
43
-   When set to true, list the complete image ID as part of the output. The
44
-default is false.
45
-
46
-**-t**, **--tree**=*true*|*false*
47
-   When set to true, list the images in a tree dependency tree (hierarchy)
48
-format. The default is false.
49
-
50
-**-v**, **--viz**=*true*|*false*
51
-   When set to true, list the graph in graphviz format. The default is
52
-*false*.
43
+   Only show numeric IDs. The default is *false*.
53 44
 
54 45
 # EXAMPLES
55 46
 
... ...
@@ -97,3 +87,4 @@ tools.
97 97
 # HISTORY
98 98
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
99 99
 based on docker.io source material and internal work.
100
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,17 +1,20 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-import - Create an empty filesystem image and import the contents
6
-of the tarball into it.
5
+docker-import - Create an empty filesystem image and import the contents of the tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) into it, then optionally tag it.
7 6
 
8 7
 # SYNOPSIS
9
-**docker import** URL|- [REPOSITORY[:TAG]]
8
+**docker import**
9
+URL|- [REPOSITORY[:TAG]]
10 10
 
11 11
 # DESCRIPTION
12 12
 Create a new filesystem image from the contents of a tarball (`.tar`,
13 13
 `.tar.gz`, `.tgz`, `.bzip`, `.tar.xz`, `.txz`) into it, then optionally tag it.
14 14
 
15
+# OPTIONS
16
+There are no available options.
17
+
15 18
 # EXAMPLES
16 19
 
17 20
 ## Import from a remote location
... ...
@@ -37,3 +40,4 @@ Import to docker via pipe and stdin:
37 37
 # HISTORY
38 38
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
39 39
 based on docker.io source material and internal work.
40
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,12 +1,13 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-info - Display system wide information
5
+docker-info - Display system-wide information
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker info**
9 9
 
10
+
10 11
 # DESCRIPTION
11 12
 This command displays system wide information regarding the Docker installation.
12 13
 Information displayed includes the number of containers and images, pool name,
... ...
@@ -44,3 +45,4 @@ Here is a sample output:
44 44
 # HISTORY
45 45
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
46 46
 based on docker.io source material and internal work.
47
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,12 +1,13 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-inspect - Return low-level information on a container/image
5
+docker-inspect - Return low-level information on a container or image
6 6
 
7 7
 # SYNOPSIS
8
-**docker inspect** [**-f**|**--format**="" CONTAINER|IMAGE
9
-[CONTAINER|IMAGE...]
8
+**docker inspect**
9
+[**-f**|**--format**[=*FORMAT*]]
10
+CONTAINER|IMAGE [CONTAINER|IMAGE...]
10 11
 
11 12
 # DESCRIPTION
12 13
 
... ...
@@ -17,8 +18,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
21
-format. See examples section
20
+   Format the output using the given go template.
22 21
 
23 22
 # EXAMPLES
24 23
 
... ...
@@ -224,6 +224,6 @@ Use an image's ID or name (e.g., repository/name[:tag]) to get information
224 224
     }]
225 225
 
226 226
 # HISTORY
227
-
228 227
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
229 228
 based on docker.io source material and internal work.
229
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,11 +1,13 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-kill - Kill a running container (send SIGKILL, or specified signal)
5
+docker-kill - Kill a running container using SIGKILL or a specified signal
6 6
 
7 7
 # SYNOPSIS
8
-**docker kill** **--signal**[=*"KILL"*] CONTAINER [CONTAINER...]
8
+**docker kill**
9
+[**-s**|**--signal**[=*"KILL"*]]
10
+ CONTAINER [CONTAINER...]
9 11
 
10 12
 # DESCRIPTION
11 13
 
... ...
@@ -13,9 +15,10 @@ The main process inside each container specified will be sent SIGKILL,
13 13
  or any signal specified with option --signal.
14 14
 
15 15
 # OPTIONS
16
-**-s**, **--signal**=*"KILL"*
16
+**-s**, **--signal**="KILL"
17 17
    Signal to send to the container
18 18
 
19 19
 # HISTORY
20 20
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
21 21
  based on docker.io source material and internal work.
22
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,11 +1,13 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-load - Load an image from a tar archive on STDIN
6 6
 
7 7
 # SYNOPSIS
8
-**docker load**  **--input**=""
8
+**docker load**
9
+[**-i**|**--input**[=*INPUT*]]
10
+
9 11
 
10 12
 # DESCRIPTION
11 13
 
... ...
@@ -13,11 +15,10 @@ Loads a tarred repository from a file or the standard input stream.
13 13
 Restores both images and tags.
14 14
 
15 15
 # OPTIONS
16
-
17 16
 **-i**, **--input**=""
18 17
    Read from a tar archive file, instead of STDIN
19 18
 
20
-# EXAMPLE
19
+# EXAMPLES
21 20
 
22 21
     $ sudo docker images
23 22
     REPOSITORY          TAG                 IMAGE ID            CREATED             VIRTUAL SIZE
... ...
@@ -34,3 +35,4 @@ Restores both images and tags.
34 34
 # HISTORY
35 35
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
36 36
 based on docker.io source material and internal work.
37
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,12 +1,15 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-login - Register or Login to a docker registry server.
5
+docker-login - Register or log in to a Docker registry server, if no server is specified "https://index.docker.io/v1/" is the default.
6 6
 
7 7
 # SYNOPSIS
8
-**docker login** [**-e**|**-email**=""] [**-p**|**--password**=""]
9
- [**-u**|**--username**=""] [SERVER]
8
+**docker login**
9
+[**-e**|**--email**[=*EMAIL*]]
10
+[**-p**|**--password**[=*PASSWORD*]]
11
+[**-u**|**--username**[=*USERNAME*]]
12
+ [SERVER]
10 13
 
11 14
 # DESCRIPTION
12 15
 Register or Login to a docker registry server, if no server is
... ...
@@ -15,7 +18,7 @@ login to a private registry you can specify this by adding the server name.
15 15
 
16 16
 # OPTIONS
17 17
 **-e**, **--email**=""
18
-   Email address
18
+   Email
19 19
 
20 20
 **-p**, **--password**=""
21 21
    Password
... ...
@@ -23,7 +26,7 @@ login to a private registry you can specify this by adding the server name.
23 23
 **-u**, **--username**=""
24 24
    Username
25 25
 
26
-# EXAMPLE
26
+# EXAMPLES
27 27
 
28 28
 ## Login to a local registry
29 29
 
... ...
@@ -32,4 +35,4 @@ login to a private registry you can specify this by adding the server name.
32 32
 # HISTORY
33 33
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
34 34
 based on docker.io source material and internal work.
35
-
35
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,11 +1,14 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-logs - Fetch the logs of a container
6 6
 
7 7
 # SYNOPSIS
8
-**docker logs** **--follow**[=*false*] CONTAINER
8
+**docker logs**
9
+[**-f**|**--follow**[=*false*]]
10
+[**-t**|**--timestamps**[=*false*]]
11
+CONTAINER
9 12
 
10 13
 # DESCRIPTION
11 14
 The **docker logs** command batch-retrieves whatever logs are present for
... ...
@@ -18,9 +21,13 @@ The **docker logs --follow** command combines commands **docker logs** and
18 18
 then continue streaming new output from the container’s stdout and stderr.
19 19
 
20 20
 # OPTIONS
21
-**-f, --follow**=*true*|*false*
22
-   When *true*, follow log output. The default is false.
21
+**-f**, **--follow**=*true*|*false*
22
+   Follow log output. The default is *false*.
23
+
24
+**-t**, **--timestamps**=*true*|*false*
25
+   Show timestamps. The default is *false*.
23 26
 
24 27
 # HISTORY
25 28
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
26 29
 based on docker.io source material and internal work.
30
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
27 31
new file mode 100644
... ...
@@ -0,0 +1,15 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-pause - Pause all processes within a container
5
+
6
+# SYNOPSIS
7
+**docker pause**
8
+CONTAINER
9
+
10
+# OPTIONS
11
+There are no available options.
12
+
13
+# HISTORY
14
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,15 +1,17 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-port - Lookup the public-facing port which is NAT-ed to PRIVATE_PORT
5
+docker-port - Lookup the public-facing port that is NAT-ed to PRIVATE_PORT
6 6
 
7 7
 # SYNOPSIS
8
-**docker port** CONTAINER PRIVATE_PORT
8
+**docker port**
9
+CONTAINER PRIVATE_PORT
9 10
 
10
-# DESCRIPTION
11
-Lookup the public-facing port which is NAT-ed to PRIVATE_PORT
11
+# OPTIONS
12
+There are no available options.
12 13
 
13 14
 # HISTORY
14 15
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
15 16
 based on docker.io source material and internal work.
17
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,14 +1,20 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-ps - List containers
6 6
 
7 7
 # SYNOPSIS
8
-**docker ps** [**-a**|**--all**=*false*] [**--before**=""]
9
-[**-l**|**--latest**=*false*] [**-n**=*-1*] [**--no-trunc**=*false*]
10
-[**-q**|**--quiet**=*false*] [**-s**|**--size**=*false*]
11
-[**--since**=""]
8
+**docker ps**
9
+[**-a**|**--all**[=*false*]]
10
+[**--before**[=*BEFORE*]]
11
+[**-l**|**--latest**[=*false*]]
12
+[**-n**[=*-1*]]
13
+[**--no-trunc**[=*false*]]
14
+[**-q**|**--quiet**[=*false*]]
15
+[**-s**|**--size**[=*false*]]
16
+[**--since**[=*SINCE*]]
17
+
12 18
 
13 19
 # DESCRIPTION
14 20
 
... ...
@@ -16,36 +22,31 @@ List the containers in the local repository. By default this show only
16 16
 the running containers.
17 17
 
18 18
 # OPTIONS
19
-
20 19
 **-a**, **--all**=*true*|*false*
21
-   When true show all containers. Only running containers are shown by
22
-default. Default is false.
20
+   Show all containers. Only running containers are shown by default. The default is *false*.
23 21
 
24 22
 **--before**=""
25
-   Show only container created before Id or Name, include non-running
26
-ones.
23
+   Show only container created before Id or Name, include non-running ones.
27 24
 
28 25
 **-l**, **--latest**=*true*|*false*
29
-   When true show only the latest created container, include non-running
30
-ones. The default is false.
26
+   Show only the latest created container, include non-running ones. The default is *false*.
31 27
 
32
-**-n**=NUM
33
-   Show NUM (integer) last created containers, include non-running ones.
34
-The default is -1 (none)
28
+**-n**=-1
29
+   Show n last created containers, include non-running ones.
35 30
 
36 31
 **--no-trunc**=*true*|*false*
37
-   When true truncate output. Default is false.
32
+   Don't truncate output. The default is *false*.
38 33
 
39 34
 **-q**, **--quiet**=*true*|*false*
40
-   When false only display numeric IDs. Default is false.
35
+   Only display numeric IDs. The default is *false*.
41 36
 
42 37
 **-s**, **--size**=*true*|*false*
43
-   When true display container sizes. Default is false.
38
+   Display sizes. The default is *false*.
44 39
 
45 40
 **--since**=""
46 41
    Show only containers created since Id or Name, include non-running ones.
47 42
 
48
-# EXAMPLE
43
+# EXAMPLES
49 44
 # Display all containers, including non-running
50 45
 
51 46
     # docker ps -a
... ...
@@ -66,3 +67,4 @@ The default is -1 (none)
66 66
 # HISTORY
67 67
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
68 68
 based on docker.io source material and internal work.
69
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,11 +1,12 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-pull - Pull an image or a repository from the registry
6 6
 
7 7
 # SYNOPSIS
8
-**docker pull** [REGISTRY_PATH/]NAME[:TAG]
8
+**docker pull**
9
+NAME[:TAG]
9 10
 
10 11
 # DESCRIPTION
11 12
 
... ...
@@ -14,6 +15,9 @@ there is more than one image for a repository (e.g., fedora) then all
14 14
 images for that repository name are pulled down including any tags.
15 15
 It is also possible to specify a non-default registry to pull from.
16 16
 
17
+# OPTIONS
18
+There are no available options.
19
+
17 20
 # EXAMPLES
18 21
 
19 22
 # Pull a repository with multiple images
... ...
@@ -48,4 +52,4 @@ It is also possible to specify a non-default registry to pull from.
48 48
 # HISTORY
49 49
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
50 50
 based on docker.io source material and internal work.
51
-
51
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,11 +1,12 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-push - Push an image or a repository to the registry
6 6
 
7 7
 # SYNOPSIS
8
-**docker push** NAME[:TAG]
8
+**docker push**
9
+NAME[:TAG]
9 10
 
10 11
 # DESCRIPTION
11 12
 Push an image or a repository to a registry. The default registry is the Docker 
... ...
@@ -13,7 +14,10 @@ Index located at [index.docker.io](https://index.docker.io/v1/). However the
13 13
 image can be pushed to another, perhaps private, registry as demonstrated in 
14 14
 the example below.
15 15
 
16
-# EXAMPLE
16
+# OPTIONS
17
+There are no available options.
18
+
19
+# EXAMPLES
17 20
 
18 21
 # Pushing a new image to a registry
19 22
 
... ...
@@ -42,3 +46,4 @@ listed.
42 42
 # HISTORY
43 43
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
44 44
 based on docker.io source material and internal work.
45
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,21 +1,22 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-restart - Restart a running container
6 6
 
7 7
 # SYNOPSIS
8
-**docker restart** [**-t**|**--time**[=*10*]] CONTAINER [CONTAINER...]
8
+**docker restart**
9
+[**-t**|**--time**[=*10*]]
10
+ CONTAINER [CONTAINER...]
9 11
 
10 12
 # DESCRIPTION
11 13
 Restart each container listed.
12 14
 
13 15
 # OPTIONS
14
-**-t**, **--time**=NUM
15
-   Number of seconds to try to stop for before killing the container. Once
16
-killed it will then be restarted. Default=10
16
+**-t**, **--time**=10
17
+   Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default is 10 seconds.
17 18
 
18 19
 # HISTORY
19 20
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
20 21
 based on docker.io source material and internal work.
21
-
22
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,16 +1,15 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
4
-
2
+% Docker Community
3
+% JUNE 2014
5 4
 # NAME
6
-
7
-docker-rm - Remove one or more containers.
5
+docker-rm - Remove one or more containers
8 6
 
9 7
 # SYNOPSIS
10
-
11
-**docker rm** [**-f**|**--force**[=*false*] [**-l**|**--link**[=*false*] [**-v**|
12
-**--volumes**[=*false*]
13
-CONTAINER [CONTAINER...]
8
+**docker rm**
9
+[**-f**|**--force**[=*false*]]
10
+[**-l**|**--link**[=*false*]]
11
+[**-v**|**--volumes**[=*false*]]
12
+ CONTAINER [CONTAINER...]
14 13
 
15 14
 # DESCRIPTION
16 15
 
... ...
@@ -20,18 +19,14 @@ remove a running container unless you use the \fB-f\fR option. To see all
20 20
 containers on a host use the **docker ps -a** command.
21 21
 
22 22
 # OPTIONS
23
-
24 23
 **-f**, **--force**=*true*|*false*
25
-   When set to true, force the removal of the container. The default is
26
-*false*.
24
+   Force removal of running container. The default is *false*.
27 25
 
28 26
 **-l**, **--link**=*true*|*false*
29
-   When set to true, remove the specified link and not the underlying
30
-container. The default is *false*.
27
+   Remove the specified link and not the underlying container. The default is *false*.
31 28
 
32 29
 **-v**, **--volumes**=*true*|*false*
33
-   When set to true, remove the volumes associated to the container. The
34
-default is *false*.
30
+   Remove the volumes associated with the container. The default is *false*.
35 31
 
36 32
 # EXAMPLES
37 33
 
... ...
@@ -51,6 +46,6 @@ command. The use that name as follows:
51 51
     docker rm hopeful_morse
52 52
 
53 53
 # HISTORY
54
-
55 54
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
56 55
 based on docker.io source material and internal work.
56
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,12 +1,14 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-rmi \- Remove one or more images.
5
+docker-rmi - Remove one or more images
6 6
 
7 7
 # SYNOPSIS
8
-
9
-**docker rmi** [**-f**|**--force**[=*false*] IMAGE [IMAGE...]
8
+**docker rmi**
9
+[**-f**|**--force**[=*false*]]
10
+[**--no-prune**[=*false*]]
11
+IMAGE [IMAGE...]
10 12
 
11 13
 # DESCRIPTION
12 14
 
... ...
@@ -16,10 +18,11 @@ container unless you use the **-f** option. To see all images on a host
16 16
 use the **docker images** command.
17 17
 
18 18
 # OPTIONS
19
-
20 19
 **-f**, **--force**=*true*|*false*
21
-   When set to true, force the removal of the image. The default is
22
-*false*.
20
+   Force removal of the image. The default is *false*.
21
+
22
+**--no-prune**=*true*|*false*
23
+   Do not delete untagged parents. The default is *false*.
23 24
 
24 25
 # EXAMPLES
25 26
 
... ...
@@ -30,6 +33,6 @@ Here is an example of removing and image:
30 30
     docker rmi fedora/httpd
31 31
 
32 32
 # HISTORY
33
-
34 33
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
35 34
 based on docker.io source material and internal work.
35
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,26 +1,40 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-run - Run a process in an isolated container
5
+docker-run - Run a command in a new container
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker run**
9
-[**-a**|**--attach**[=]] [**-c**|**--cpu-shares**[=0]
10
-[**-m**|**--memory**=*memory-limit*]
11
-[**--cidfile**=*file*] [**-d**|**--detach**[=*false*]] [**--dns**=*IP-address*]
12
-[**--name**=*name*] [**-u**|**--user**=*username*|*uid*]
13
-[**--link**=*name*:*alias*]
14
-[**-e**|**--env**=*environment*] [**--entrypoint**=*command*]
15
-[**--expose**=*port*] [**-P**|**--publish-all**[=*false*]]
16
-[**-p**|**--publish**=*port-mapping*] [**-h**|**--hostname**=*hostname*]
17
-[**--rm**[=*false*]] [**--privileged**[=*false*]]
9
+[**-a**|**--attach**[=*[]*]]
10
+[**-c**|**--cpu-shares**[=*0*]]
11
+[**--cidfile**[=*CIDFILE*]]
12
+[**--cpuset**[=*CPUSET*]]
13
+[**-d**|**--detach**[=*false*]]
14
+[**--dns-search**[=*[]*]]
15
+[**--dns**[=*[]*]]
16
+[**-e**|**--env**[=*[]*]]
17
+[**--entrypoint**[=*ENTRYPOINT*]]
18
+[**--env-file**[=*[]*]]
19
+[**--expose**[=*[]*]]
20
+[**-h**|**--hostname**[=*HOSTNAME*]]
18 21
 [**-i**|**--interactive**[=*false*]]
19
-[**-t**|**--tty**[=*false*]] [**--lxc-conf**=*options*]
20
-[**-n**|**--networking**[=*true*]]
21
-[**-v**|**--volume**=*volume*] [**--volumes-from**=*container-id*]
22
-[**-w**|**--workdir**=*directory*] [**--sig-proxy**[=*true*]]
23
-IMAGE [COMMAND] [ARG...]
22
+[**--link**[=*[]*]]
23
+[**--lxc-conf**[=*[]*]]
24
+[**-m**|**--memory**[=*MEMORY*]]
25
+[**--name**[=*NAME*]]
26
+[**--net**[=*"bridge"*]]
27
+[**-P**|**--publish-all**[=*false*]]
28
+[**-p**|**--publish**[=*[]*]]
29
+[**--privileged**[=*false*]]
30
+[**--rm**[=*false*]]
31
+[**--sig-proxy**[=*true*]]
32
+[**-t**|**--tty**[=*false*]]
33
+[**-u**|**--user**[=*USER*]]
34
+[**-v**|**--volume**[=*[]*]]
35
+[**--volumes-from**[=*[]*]]
36
+[**-w**|**--workdir**[=*WORKDIR*]]
37
+ IMAGE [COMMAND] [ARG...]
24 38
 
25 39
 # DESCRIPTION
26 40
 
... ...
@@ -56,6 +70,8 @@ run**.
56 56
 **--cidfile**=*file*
57 57
    Write the container ID to the file specified.
58 58
 
59
+**--cpuset**=""
60
+   CPUs in which to allow execution (0-3, 0,1)
59 61
 
60 62
 **-d**, **-detach**=*true*|*false*
61 63
    Detached mode. This runs the container in the background. It outputs the new
... ...
@@ -67,6 +83,8 @@ the detached mode, then you cannot use the **-rm** option.
67 67
    When attached in the tty mode, you can detach from a running container without
68 68
 stopping the process by pressing the keys CTRL-P CTRL-Q.
69 69
 
70
+**--dns-search**=[]
71
+   Set custom dns search domains
70 72
 
71 73
 **--dns**=*IP-address*
72 74
    Set custom DNS servers. This option can be used to override the DNS
... ...
@@ -92,6 +110,8 @@ pass in more options via the COMMAND. But, sometimes an operator may want to run
92 92
 something else inside the container, so you can override the default ENTRYPOINT
93 93
 at runtime by using a **--entrypoint** and a string to specify the new
94 94
 ENTRYPOINT.
95
+**--env-file**=[]
96
+   Read in a line delimited file of ENV variables
95 97
 
96 98
 **--expose**=*port*
97 99
    Expose a port from the container without publishing it to your host. A
... ...
@@ -100,36 +120,12 @@ developer can expose the port using the EXPOSE parameter of the Dockerfile, 2)
100 100
 the operator can use the **--expose** option with **docker run**, or 3) the
101 101
 container can be started with the **--link**.
102 102
 
103
-**-m**, **-memory**=*memory-limit*
104
-   Allows you to constrain the memory available to a container. If the host
105
-supports swap memory, then the -m memory setting can be larger than physical
106
-RAM. If a limit of 0 is specified, the container's memory is not limited. The
107
-actual limit may be rounded up to a multiple of the operating system's page
108
-size, if it is not already. The memory limit should be formatted as follows:
109
-`<number><optional unit>`, where unit = b, k, m or g.
110
-
111
-**-P**, **-publish-all**=*true*|*false*
112
-   When set to true publish all exposed ports to the host interfaces. The
113
-default is false. If the operator uses -P (or -p) then Docker will make the
114
-exposed port accessible on the host and the ports will be available to any
115
-client that can reach the host. To find the map between the host ports and the
116
-exposed ports, use **docker port**.
117
-
118
-
119
-**-p**, **-publish**=[]
120
-   Publish a container's port to the host (format: ip:hostPort:containerPort |
121
-ip::containerPort | hostPort:containerPort) (use **docker port** to see the
122
-actual mapping)
123
-
124
-
125 103
 **-h**, **-hostname**=*hostname*
126 104
    Sets the container host name that is available inside the container.
127 105
 
128
-
129 106
 **-i**, **-interactive**=*true*|*false*
130 107
    When set to true, keep stdin open even if not attached. The default is false.
131 108
 
132
-
133 109
 **--link**=*name*:*alias*
134 110
    Add link to another container. The format is name:alias. If the operator
135 111
 uses **--link** when starting the new client container, then the client
... ...
@@ -137,16 +133,16 @@ container can access the exposed port via a private networking interface. Docker
137 137
 will set some environment variables in the client container to help indicate
138 138
 which interface and port to use.
139 139
 
140
+**--lxc-conf**=[]
141
+   (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
140 142
 
141
-**-n**, **-networking**=*true*|*false*
142
-   By default, all containers have networking enabled (true) and can make
143
-outgoing connections. The operator can disable networking with **--networking**
144
-to false. This disables all incoming and outgoing networking. In cases like this
145
-, I/O can only be performed through files or by using STDIN/STDOUT.
146
-
147
-Also by default, the container will use the same DNS servers as the host. The
148
-operator may override this with **-dns**.
149
-
143
+**-m**, **-memory**=*memory-limit*
144
+   Allows you to constrain the memory available to a container. If the host
145
+supports swap memory, then the -m memory setting can be larger than physical
146
+RAM. If a limit of 0 is specified, the container's memory is not limited. The
147
+actual limit may be rounded up to a multiple of the operating system's page
148
+size, if it is not already. The memory limit should be formatted as follows:
149
+`<number><optional unit>`, where unit = b, k, m or g.
150 150
 
151 151
 **--name**=*name*
152 152
    Assign a name to the container. The operator can identify a container in
... ...
@@ -162,6 +158,24 @@ string name. The name is useful when defining links (see **--link**) (or any
162 162
 other place you need to identify a container). This works for both background
163 163
 and foreground Docker containers.
164 164
 
165
+**--net**="bridge"
166
+   Set the Network mode for the container
167
+                               'bridge': creates a new network stack for the container on the docker bridge
168
+                               'none': no networking for this container
169
+                               'container:<name|id>': reuses another container network stack
170
+                               'host': use the host network stack inside the container.  Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
171
+
172
+**-P**, **-publish-all**=*true*|*false*
173
+   When set to true publish all exposed ports to the host interfaces. The
174
+default is false. If the operator uses -P (or -p) then Docker will make the
175
+exposed port accessible on the host and the ports will be available to any
176
+client that can reach the host. To find the map between the host ports and the
177
+exposed ports, use **docker port**.
178
+
179
+**-p**, **-publish**=[]
180
+   Publish a container's port to the host (format: ip:hostPort:containerPort |
181
+ip::containerPort | hostPort:containerPort) (use **docker port** to see the
182
+actual mapping)
165 183
 
166 184
 **--privileged**=*true*|*false*
167 185
    Give extended privileges to this container. By default, Docker containers are
... ...
@@ -356,3 +370,4 @@ changes will also be reflected on the host in /var/db.
356 356
 # HISTORY
357 357
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
358 358
 based on docker.io source material and internal work.
359
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,11 +1,13 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-save - Save an image to a tar archive (streamed to STDOUT by default)
6 6
 
7 7
 # SYNOPSIS
8
-**docker save** [**-o**|**--output**=""] IMAGE
8
+**docker save**
9
+[**-o**|**--output**[=*OUTPUT*]]
10
+IMAGE
9 11
 
10 12
 # DESCRIPTION
11 13
 Produces a tarred repository to the standard output stream. Contains all
... ...
@@ -17,7 +19,7 @@ Stream to a file instead of STDOUT by using **-o**.
17 17
 **-o**, **--output**=""
18 18
    Write to an file, instead of STDOUT
19 19
 
20
-# EXAMPLE
20
+# EXAMPLES
21 21
 
22 22
 Save all fedora repository images to a fedora-all.tar and save the latest
23 23
 fedora image to a fedora-latest.tar:
... ...
@@ -32,4 +34,4 @@ fedora image to a fedora-latest.tar:
32 32
 # HISTORY
33 33
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
34 34
 based on docker.io source material and internal work.
35
-
35
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,12 +1,15 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-search - Search the docker index for images
5
+docker-search - Search the Docker Hub for images
6 6
 
7 7
 # SYNOPSIS
8
-**docker search** **--no-trunc**[=*false*] **--automated**[=*false*]
9
- **-s**|**--stars**[=*0*] TERM
8
+**docker search**
9
+[**--automated**[=*false*]]
10
+[**--no-trunc**[=*false*]]
11
+[**-s**|**--stars**[=*0*]]
12
+TERM
10 13
 
11 14
 # DESCRIPTION
12 15
 
... ...
@@ -16,17 +19,16 @@ number of stars awarded, whether the image is official, and whether it
16 16
 is automated.
17 17
 
18 18
 # OPTIONS
19
-**--no-trunc**=*true*|*false*
20
-   When true display the complete description. The default is false.
19
+**--automated**=*true*|*false*
20
+   Only show automated builds. The default is *false*.
21 21
 
22
-**-s**, **--stars**=NUM
23
-   Only displays with at least NUM (integer) stars. I.e. only those images
24
-ranked >=NUM.
22
+**--no-trunc**=*true*|*false*
23
+   Don't truncate output. The default is *false*.
25 24
 
26
-**--automated**=*true*|*false*
27
-   When true only show automated builds. The default is false.
25
+**-s**, **--stars**=0
26
+   Only displays with at least x stars
28 27
 
29
-# EXAMPLE
28
+# EXAMPLES
30 29
 
31 30
 ## Search the registry for ranked images
32 31
 
... ...
@@ -53,3 +55,4 @@ ranked 1 or higher:
53 53
 # HISTORY
54 54
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
55 55
 based on docker.io source material and internal work.
56
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,29 +1,27 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-start - Restart a stopped container
6 6
 
7 7
 # SYNOPSIS
8
-**docker start** [**a**|**--attach**[=*false*]] [**-i**|**--interactive**
9
-[=*true*] CONTAINER [CONTAINER...]
8
+**docker start**
9
+[**-a**|**--attach**[=*false*]]
10
+[**-i**|**--interactive**[=*false*]]
11
+CONTAINER [CONTAINER...]
10 12
 
11 13
 # DESCRIPTION
12 14
 
13 15
 Start a stopped container.
14 16
 
15
-# OPTION
17
+# OPTIONS
16 18
 **-a**, **--attach**=*true*|*false*
17
-   When true attach to container's stdout/stderr and forward all signals to
18
-the process
19
+   Attach container's STDOUT and STDERR and forward all signals to the process. The default is *false*.
19 20
 
20 21
 **-i**, **--interactive**=*true*|*false*
21
-   When true attach to container's stdin
22
-
23
-# NOTES
24
-If run on a started container, start takes no action and succeeds
25
-unconditionally.
22
+   Attach container's STDIN. The default is *false*.
26 23
 
27 24
 # HISTORY
28 25
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
29 26
 based on docker.io source material and internal work.
27
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,22 +1,23 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-stop - Stop a running container
6
- grace period)
5
+docker-stop - Stop a running container by sending SIGTERM and then SIGKILL after a grace period
7 6
 
8 7
 # SYNOPSIS
9
-**docker stop** [**-t**|**--time**[=*10*]] CONTAINER [CONTAINER...]
8
+**docker stop**
9
+[**-t**|**--time**[=*10*]]
10
+ CONTAINER [CONTAINER...]
10 11
 
11 12
 # DESCRIPTION
12 13
 Stop a running container (Send SIGTERM, and then SIGKILL after
13 14
  grace period)
14 15
 
15 16
 # OPTIONS
16
-**-t**, **--time**=NUM
17
-   Wait NUM number of seconds for the container to stop before killing it.
18
-The default is 10 seconds.
17
+**-t**, **--time**=10
18
+   Number of seconds to wait for the container to stop before killing it. Default is 10 seconds.
19 19
 
20 20
 # HISTORY
21 21
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
22 22
 based on docker.io source material and internal work.
23
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,12 +1,13 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-tag - Tag an image in the repository
5
+docker-tag - Tag an image into a repository
6 6
 
7 7
 # SYNOPSIS
8
-**docker tag** [**-f**|**--force**[=*false*]
9
-IMAGE [REGISTRYHOST/][USERNAME/]NAME[:TAG]
8
+**docker tag**
9
+[**-f**|**--force**[=*false*]]
10
+ IMAGE [REGISTRYHOST/][USERNAME/]NAME[:TAG]
10 11
 
11 12
 # DESCRIPTION
12 13
 This will give a new alias to an image in the repository. This refers to the
... ...
@@ -31,6 +32,10 @@ separated by a ':'
31 31
 recommended to be used for a version to disinguish images with the same name.
32 32
 Note that here TAG is a part of the overall name or "tag".
33 33
 
34
+# OPTIONS
35
+**-f**, **--force**=*true*|*false*
36
+   Force. The default is *false*.
37
+
34 38
 # EXAMPLES
35 39
 
36 40
 ## Giving an image a new alias
... ...
@@ -50,3 +55,4 @@ registry you must tag it with the registry hostname and port (if needed).
50 50
 # HISTORY
51 51
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
52 52
 based on docker.io source material and internal work.
53
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,18 +1,22 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5
-docker-top - Lookup the running processes of a container
5
+docker-top - Display the running processes of a container
6 6
 
7 7
 # SYNOPSIS
8
-**docker top** CONTAINER [ps-OPTION]
8
+**docker top**
9
+CONTAINER [ps OPTIONS]
9 10
 
10 11
 # DESCRIPTION
11 12
 
12 13
 Look up the running process of the container. ps-OPTION can be any of the
13 14
  options you would pass to a Linux ps command.
14 15
 
15
-# EXAMPLE
16
+# OPTIONS
17
+There are no available options.
18
+
19
+# EXAMPLES
16 20
 
17 21
 Run **docker top** with the ps option of -x:
18 22
 
... ...
@@ -24,4 +28,4 @@ Run **docker top** with the ps option of -x:
24 24
 # HISTORY
25 25
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
26 26
 based on docker.io source material and internal work.
27
-
27
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
28 28
new file mode 100644
... ...
@@ -0,0 +1,15 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-unpause - Unpause all processes within a container
5
+
6
+# SYNOPSIS
7
+**docker unpause**
8
+CONTAINER
9
+
10
+# OPTIONS
11
+There are no available options.
12
+
13
+# HISTORY
14
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
0 15
new file mode 100644
... ...
@@ -0,0 +1,15 @@
0
+% DOCKER(1) Docker User Manuals
1
+% Docker Community
2
+% JUNE 2014
3
+# NAME
4
+docker-version - Show the Docker version information.
5
+
6
+# SYNOPSIS
7
+**docker version**
8
+
9
+
10
+# OPTIONS
11
+There are no available options.
12
+
13
+# HISTORY
14
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,16 +1,21 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% William Henry
3
-% APRIL 2014
2
+% Docker Community
3
+% JUNE 2014
4 4
 # NAME
5 5
 docker-wait - Block until a container stops, then print its exit code.
6 6
 
7 7
 # SYNOPSIS
8
-**docker wait** CONTAINER [CONTAINER...]
8
+**docker wait**
9
+CONTAINER [CONTAINER...]
9 10
 
10 11
 # DESCRIPTION
12
+
11 13
 Block until a container stops, then print its exit code.
12 14
 
13
-#EXAMPLE
15
+# OPTIONS
16
+There are no available options.
17
+
18
+# EXAMPLES
14 19
 
15 20
     $ sudo docker run -d fedora sleep 99
16 21
     079b83f558a2bc52ecad6b2a5de13622d584e6bb1aea058c11b36511e85e7622
... ...
@@ -20,4 +25,4 @@ Block until a container stops, then print its exit code.
20 20
 # HISTORY
21 21
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
22 22
 based on docker.io source material and internal work.
23
-
23
+June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -127,6 +127,9 @@ inside it)
127 127
 **docker-logs(1)**
128 128
   Fetch the logs of a container
129 129
 
130
+**docker-pause(1)**
131
+  Pause all processes within a container
132
+
130 133
 **docker-port(1)**
131 134
   Lookup the public-facing port which is NAT-ed to PRIVATE_PORT
132 135
 
... ...
@@ -169,7 +172,10 @@ inside it)
169 169
 **docker-top(1)**
170 170
   Lookup the running processes of a container
171 171
 
172
-**version**
172
+**docker-unpause(1)**
173
+  Unpause all processes within a container
174
+
175
+**docker-version(1)**
173 176
   Show the Docker version information
174 177
 
175 178
 **docker-wait(1)**
... ...
@@ -54,9 +54,9 @@ expect an integer, and they can only be specified once.
54 54
       -b, --bridge=""                            Attach containers to a pre-existing network bridge
55 55
                                                    use 'none' to disable container networking
56 56
       --bip=""                                   Use this CIDR notation address for the network bridge's IP, not compatible with -b
57
-      -d, --daemon=false                         Enable daemon mode
58 57
       -D, --debug=false                          Enable debug mode
59
-      --dns=[]                                   Force docker to use specific DNS servers
58
+      -d, --daemon=false                         Enable daemon mode
59
+      --dns=[]                                   Force Docker to use specific DNS servers
60 60
       --dns-search=[]                            Force Docker to use specific DNS search domains
61 61
       -e, --exec-driver="native"                 Force the Docker runtime to use a specific exec driver
62 62
       -G, --group="docker"                       Group to assign the unix socket specified by -H when running in daemon mode
... ...
@@ -73,8 +73,8 @@ expect an integer, and they can only be specified once.
73 73
       -p, --pidfile="/var/run/docker.pid"        Path to use for daemon PID file
74 74
       -r, --restart=true                         Restart previously running containers
75 75
       -s, --storage-driver=""                    Force the Docker runtime to use a specific storage driver
76
-      --storage-opt=[]                           Set storage driver options
77 76
       --selinux-enabled=false                    Enable selinux support
77
+      --storage-opt=[]                           Set storage driver options
78 78
       --tls=false                                Use TLS; implied by tls-verify flags
79 79
       --tlscacert="/home/sven/.docker/ca.pem"    Trust only remotes providing a certificate signed by the CA given here
80 80
       --tlscert="/home/sven/.docker/cert.pem"    Path to TLS certificate file
... ...
@@ -134,8 +134,8 @@ like this:
134 134
 
135 135
     Attach to a running container
136 136
 
137
-      --no-stdin=false    Do not attach stdin
138
-      --sig-proxy=true    Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied.
137
+      --no-stdin=false    Do not attach STDIN
138
+      --sig-proxy=true    Proxify all received signals to the process (even in non-TTY mode). SIGCHLD is not proxied.
139 139
 
140 140
 The `attach` command will allow you to view or
141 141
 interact with any running container, detached (`-d`)
... ...
@@ -481,7 +481,7 @@ To see how the `docker:latest` image was built:
481 481
     List images
482 482
 
483 483
       -a, --all=false      Show all images (by default filter out the intermediate image layers)
484
-      -f, --filter=[]:     Provide filter values (i.e. 'dangling=true')
484
+      -f, --filter=[]      Provide filter values (i.e. 'dangling=true')
485 485
       --no-trunc=false     Don't truncate output
486 486
       -q, --quiet=false    Only show numeric IDs
487 487
 
... ...
@@ -600,6 +600,8 @@ tar, then the ownerships might not get preserved.
600 600
 
601 601
     Usage: docker info
602 602
 
603
+    Display system-wide information
604
+
603 605
 For example:
604 606
 
605 607
     $ sudo docker -D info
... ...
@@ -627,7 +629,7 @@ ensure we know how your setup is configured.
627 627
 
628 628
     Usage: docker inspect CONTAINER|IMAGE [CONTAINER|IMAGE...]
629 629
 
630
-    Return low-level information on a container/image
630
+    Return low-level information on a container or image
631 631
 
632 632
       -f, --format=""    Format the output using the given go template.
633 633
 
... ...
@@ -681,7 +683,7 @@ contains complex json object, so to grab it as JSON, you use
681 681
 
682 682
     Usage: docker kill [OPTIONS] CONTAINER [CONTAINER...]
683 683
 
684
-    Kill a running container (send SIGKILL, or specified signal)
684
+    Kill a running container using SIGKILL or a specified signal
685 685
 
686 686
       -s, --signal="KILL"    Signal to send to the container
687 687
 
... ...
@@ -718,7 +720,7 @@ Restores both images and tags.
718 718
 
719 719
     Usage: docker login [OPTIONS] [SERVER]
720 720
 
721
-    Register or Login to a docker registry server, if no server is specified "https://index.docker.io/v1/" is the default.
721
+    Register or log in to a Docker registry server, if no server is specified "https://index.docker.io/v1/" is the default.
722 722
 
723 723
       -e, --email=""       Email
724 724
       -p, --password=""    Password
... ...
@@ -752,7 +754,7 @@ value is set to `all` in that case. This behavior may change in the future.
752 752
 
753 753
     Usage: docker port CONTAINER PRIVATE_PORT
754 754
 
755
-    Lookup the public-facing port which is NAT-ed to PRIVATE_PORT
755
+    Lookup the public-facing port that is NAT-ed to PRIVATE_PORT
756 756
 
757 757
 ## ps
758 758
 
... ...
@@ -781,7 +783,7 @@ Running `docker ps` showing 2 linked containers.
781 781
 
782 782
 ## pull
783 783
 
784
-    Usage: docker pull [REGISTRY_PATH/]NAME[:TAG]
784
+    Usage: docker pull NAME[:TAG]
785 785
 
786 786
     Pull an image or a repository from the registry
787 787
 
... ...
@@ -824,7 +826,7 @@ registry or to a self-hosted one.
824 824
 
825 825
     Restart a running container
826 826
 
827
-      -t, --time=10      Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default=10
827
+      -t, --time=10      Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default is 10 seconds.
828 828
 
829 829
 ## rm
830 830
 
... ...
@@ -834,7 +836,7 @@ registry or to a self-hosted one.
834 834
 
835 835
       -f, --force=false      Force removal of running container
836 836
       -l, --link=false       Remove the specified link and not the underlying container
837
-      -v, --volumes=false    Remove the volumes associated to the container
837
+      -v, --volumes=false    Remove the volumes associated with the container
838 838
 
839 839
 ### Known Issues (rm)
840 840
 
... ...
@@ -870,7 +872,7 @@ delete them. Any running containers will not be deleted.
870 870
 
871 871
     Remove one or more images
872 872
 
873
-      -f, --force=false    Force
873
+      -f, --force=false    Force removal of the image
874 874
       --no-prune=false     Do not delete untagged parents
875 875
 
876 876
 ### Removing tagged images
... ...
@@ -910,6 +912,7 @@ removed before the image is removed.
910 910
       -a, --attach=[]            Attach to stdin, stdout or stderr.
911 911
       -c, --cpu-shares=0         CPU shares (relative weight)
912 912
       --cidfile=""               Write the container ID to the file
913
+      --cpuset=""                CPUs in which to allow execution (0-3, 0,1)
913 914
       -d, --detach=false         Detached mode: Run container in the background, print new container id
914 915
       --dns=[]                   Set custom dns servers
915 916
       --dns-search=[]            Set custom dns search domains
... ...
@@ -927,11 +930,11 @@ removed before the image is removed.
927 927
                                    'bridge': creates a new network stack for the container on the docker bridge
928 928
                                    'none': no networking for this container
929 929
                                    'container:<name|id>': reuses another container network stack
930
-                                   'host': use the host network stack inside the container
930
+                                   'host': use the host network stack inside the container.  Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
931
+      -P, --publish-all=false    Publish all exposed ports to the host interfaces
931 932
       -p, --publish=[]           Publish a container's port to the host
932 933
                                    format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort
933 934
                                    (use 'docker port' to see the actual mapping)
934
-      -P, --publish-all=false    Publish all exposed ports to the host interfaces
935 935
       --privileged=false         Give extended privileges to this container
936 936
       --rm=false                 Automatically remove the container when it exits (incompatible with -d)
937 937
       --sig-proxy=true           Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied.
... ...
@@ -1150,7 +1153,7 @@ application change:
1150 1150
 
1151 1151
     Usage: docker save IMAGE
1152 1152
 
1153
-    Save an image to a tar archive (streamed to stdout by default)
1153
+    Save an image to a tar archive (streamed to STDOUT by default)
1154 1154
 
1155 1155
       -o, --output=""    Write to an file, instead of STDOUT
1156 1156
 
... ...
@@ -1175,11 +1178,11 @@ Search [Docker Hub](https://hub.docker.com) for images
1175 1175
 
1176 1176
     Usage: docker search TERM
1177 1177
 
1178
-    Search the docker index for images
1178
+    Search the Docker Hub for images
1179 1179
 
1180
-      --no-trunc=false       Don't truncate output
1181
-      -s, --stars=0          Only displays with at least xxx stars
1182
-      --automated=false      Only show automated builds
1180
+      --automated=false    Only show automated builds
1181
+      --no-trunc=false     Don't truncate output
1182
+      -s, --stars=0        Only displays with at least x stars
1183 1183
 
1184 1184
 See [*Find Public Images on Docker Hub*](
1185 1185
 /userguide/dockerrepos/#find-public-images-on-docker-hub) for
... ...
@@ -1191,8 +1194,8 @@ more details on finding shared images from the command line.
1191 1191
 
1192 1192
     Restart a stopped container
1193 1193
 
1194
-      -a, --attach=false         Attach container's stdout/stderr and forward all signals to the process
1195
-      -i, --interactive=false    Attach container's stdin
1194
+      -a, --attach=false         Attach container's STDOUT and STDERR and forward all signals to the process
1195
+      -i, --interactive=false    Attach container's STDIN
1196 1196
 
1197 1197
 When run on a container that has already been started, 
1198 1198
 takes no action and succeeds unconditionally.
... ...
@@ -1201,9 +1204,9 @@ takes no action and succeeds unconditionally.
1201 1201
 
1202 1202
     Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
1203 1203
 
1204
-    Stop a running container (Send SIGTERM, and then SIGKILL after grace period)
1204
+    Stop a running container by sending SIGTERM and then SIGKILL after a grace period
1205 1205
 
1206
-      -t, --time=10      Number of seconds to wait for the container to stop before killing it.
1206
+      -t, --time=10      Number of seconds to wait for the container to stop before killing it. Default is 10 seconds.
1207 1207
 
1208 1208
 The main process inside the container will receive SIGTERM, and after a
1209 1209
 grace period, SIGKILL
... ...
@@ -1224,13 +1227,13 @@ them to [*Share Images via Repositories*](
1224 1224
 
1225 1225
     Usage: docker top CONTAINER [ps OPTIONS]
1226 1226
 
1227
-    Lookup the running processes of a container
1227
+    Display the running processes of a container
1228 1228
 
1229 1229
 ## version
1230 1230
 
1231 1231
     Usage: docker version
1232 1232
 
1233
-    Show the docker version information.
1233
+    Show the Docker version information.
1234 1234
 
1235 1235
 Show the Docker version, API version, Git commit, and Go version of
1236 1236
 both Docker client and daemon.
... ...
@@ -1240,3 +1243,4 @@ both Docker client and daemon.
1240 1240
     Usage: docker wait CONTAINER [CONTAINER...]
1241 1241
 
1242 1242
     Block until a container stops, then print its exit code.
1243
+
... ...
@@ -72,7 +72,7 @@ func parseRun(cmd *flag.FlagSet, args []string, sysInfo *sysinfo.SysInfo) (*Conf
72 72
 	)
73 73
 
74 74
 	cmd.Var(&flAttach, []string{"a", "-attach"}, "Attach to stdin, stdout or stderr.")
75
-	cmd.Var(&flVolumes, []string{"v", "-volume"}, "Bind mount a volume (e.g. from the host: -v /host:/container, from docker: -v /container)")
75
+	cmd.Var(&flVolumes, []string{"v", "-volume"}, "Bind mount a volume (e.g., from the host: -v /host:/container, from docker: -v /container)")
76 76
 	cmd.Var(&flLinks, []string{"#link", "-link"}, "Add link to another container (name:alias)")
77 77
 	cmd.Var(&flEnv, []string{"e", "-env"}, "Set environment variables")
78 78
 	cmd.Var(&flEnvFile, []string{"-env-file"}, "Read in a line delimited file of ENV variables")