Browse code

user facing documentation changes in master atm

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

SvenDowideit authored on 2014/07/23 11:40:10
Showing 8 changed files
... ...
@@ -7,6 +7,7 @@
7 7
 #       ./docs/update.py /usr/bin/docker
8 8
 #
9 9
 
10
+import datetime
10 11
 import re
11 12
 from sys import argv
12 13
 import subprocess
... ...
@@ -15,6 +16,9 @@ import os.path
15 15
 
16 16
 script, docker_cmd = argv
17 17
 
18
+# date "+%B %Y"
19
+date_string = datetime.date.today().strftime('%B %Y')
20
+
18 21
 def print_usage(outtext, docker_cmd, command):
19 22
     help = ""
20 23
     try:
... ...
@@ -204,9 +208,9 @@ def update_man_pages():
204 204
         outtext.write("# HISTORY\n")
205 205
         if history != "":
206 206
            outtext.write(history+"\n")
207
-        recent_history_re = re.compile(".*June 2014.*", re.MULTILINE|re.DOTALL)
207
+        recent_history_re = re.compile(".*"+date_string+".*", re.MULTILINE|re.DOTALL)
208 208
         if not recent_history_re.match(history):
209
-            outtext.write("June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>\n")
209
+            outtext.write(date_string+", updated by Sven Dowideit <SvenDowideit@home.org.au>\n")
210 210
         outtext.close()
211 211
 
212 212
 # main
... ...
@@ -8,6 +8,7 @@ docker-commit - Create a new image from a container's changes
8 8
 **docker commit**
9 9
 [**-a**|**--author**[=*AUTHOR*]]
10 10
 [**-m**|**--message**[=*MESSAGE*]]
11
+[**-p**|**--pause**[=*true*]]
11 12
  CONTAINER [REPOSITORY[:TAG]]
12 13
 
13 14
 # DESCRIPTION
... ...
@@ -20,8 +21,8 @@ Using an existing container's name or ID you can create a new image.
20 20
 **-m**, **--message**=""
21 21
    Commit message
22 22
 
23
-**-p, --pause**=true
24
-   Pause container during commit
23
+**-p**, **--pause**=*true*|*false*
24
+   Pause container during commit. The default is *true*.
25 25
 
26 26
 # EXAMPLES
27 27
 
... ...
@@ -37,3 +38,4 @@ create a new image run docker ps to find the container's ID and then run:
37 37
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
38 38
 based on docker.com source material and in
39 39
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
40
+July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -1,18 +1,22 @@
1 1
 % DOCKER(1) Docker User Manuals
2
-% Daniel, Dao Quang Minh
2
+% Docker Community
3 3
 % JUNE 2014
4 4
 # NAME
5
-docker-logout - Log out from a Docker registry
5
+docker-logout - Log out from a Docker registry, if no server is specified "https://index.docker.io/v1/" is the default.
6 6
 
7 7
 # SYNOPSIS
8
-**docker logout** [SERVER]
8
+**docker logout**
9
+[SERVER]
9 10
 
10 11
 # DESCRIPTION
11 12
 Log the user out from a Docker registry, if no server is
12 13
 specified "https://index.docker.io/v1/" is the default. If you want to
13 14
 log out from a private registry you can specify this by adding the server name.
14 15
 
15
-# EXAMPLE
16
+# OPTIONS
17
+There are no available options.
18
+
19
+# EXAMPLES
16 20
 
17 21
 ## Log out from a local registry
18 22
 
... ...
@@ -20,4 +24,4 @@ log out from a private registry you can specify this by adding the server name.
20 20
 
21 21
 # HISTORY
22 22
 June 2014, Originally compiled by Daniel, Dao Quang Minh (daniel at nitrous dot io)
23
-
23
+July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -8,6 +8,7 @@ docker-logs - Fetch the logs of a container
8 8
 **docker logs**
9 9
 [**-f**|**--follow**[=*false*]]
10 10
 [**-t**|**--timestamps**[=*false*]]
11
+[**--tail**[=*"all"*]]
11 12
 CONTAINER
12 13
 
13 14
 # DESCRIPTION
... ...
@@ -27,7 +28,11 @@ then continue streaming new output from the container’s stdout and stderr.
27 27
 **-t**, **--timestamps**=*true*|*false*
28 28
    Show timestamps. The default is *false*.
29 29
 
30
+**--tail**="all"
31
+   Output the specified number of lines at the end of logs (defaults to all logs)
32
+
30 33
 # HISTORY
31 34
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
32 35
 based on docker.com source material and internal work.
33 36
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
37
+July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -6,9 +6,9 @@ docker-rm - Remove one or more containers
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker rm**
9
-[**-s**|**--stop**[=*false*]]
10 9
 [**-k**|**--kill**[=*false*]]
11 10
 [**-l**|**--link**[=*false*]]
11
+[**-s**|**--stop**[=*false*]]
12 12
 [**-v**|**--volumes**[=*false*]]
13 13
  CONTAINER [CONTAINER...]
14 14
 
... ...
@@ -20,15 +20,15 @@ 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
-**-s**, **--stop**=*true*|*false*
24
-   Stop then remove a running container. The default is *false*.
25
-
26 23
 **-k**, **--kill**=*true*|*false*
27
-   Kill then remove a running container. The default is *false*.
24
+   Kill and remove a running container. The default is *false*.
28 25
 
29 26
 **-l**, **--link**=*true*|*false*
30 27
    Remove the specified link and not the underlying container. The default is *false*.
31 28
 
29
+**-s**, **--stop**=*true*|*false*
30
+   Stop and remove a running container. The default is *false*.
31
+
32 32
 **-v**, **--volumes**=*true*|*false*
33 33
    Remove the volumes associated with the container. The default is *false*.
34 34
 
... ...
@@ -53,3 +53,4 @@ command. The use that name as follows:
53 53
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
54 54
 based on docker.com source material and internal work.
55 55
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
56
+July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -8,9 +8,12 @@ docker-run - Run a command in a new container
8 8
 **docker run**
9 9
 [**-a**|**--attach**[=*[]*]]
10 10
 [**-c**|**--cpu-shares**[=*0*]]
11
+[**--cap-add**[=*[]*]]
12
+[**--cap-drop**[=*[]*]]
11 13
 [**--cidfile**[=*CIDFILE*]]
12 14
 [**--cpuset**[=*CPUSET*]]
13 15
 [**-d**|**--detach**[=*false*]]
16
+[**--device**[=*[]*]]
14 17
 [**--dns-search**[=*[]*]]
15 18
 [**--dns**[=*[]*]]
16 19
 [**-e**|**--env**[=*[]*]]
... ...
@@ -34,7 +37,7 @@ docker-run - Run a command in a new container
34 34
 [**-v**|**--volume**[=*[]*]]
35 35
 [**--volumes-from**[=*[]*]]
36 36
 [**-w**|**--workdir**[=*WORKDIR*]]
37
- IMAGE[:TAG] [COMMAND] [ARG...]
37
+ IMAGE [COMMAND] [ARG...]
38 38
 
39 39
 # DESCRIPTION
40 40
 
... ...
@@ -67,8 +70,14 @@ the same proportion of CPU cycles, but you can tell the kernel to give more
67 67
 shares of CPU time to one or more containers when you start them via **docker
68 68
 run**.
69 69
 
70
-**--cidfile**=*file*
71
-   Write the container ID to the file specified.
70
+**--cap-add**=[]
71
+   Add Linux capabilities
72
+
73
+**--cap-drop**=[]
74
+   Drop Linux capabilities
75
+
76
+**--cidfile**=""
77
+   Write the container ID to the file
72 78
 
73 79
 **--cpuset**=""
74 80
    CPUs in which to allow execution (0-3, 0,1)
... ...
@@ -82,9 +91,11 @@ the detached mode, then you cannot use the **-rm** option.
82 82
 
83 83
    When attached in the tty mode, you can detach from a running container without
84 84
 stopping the process by pressing the keys CTRL-P CTRL-Q.
85
+**--device**=[]
86
+   Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc)
85 87
 
86 88
 **--dns-search**=[]
87
-   Set custom dns search domains
89
+   Set custom DNS search domains
88 90
 
89 91
 **--dns**=*IP-address*
90 92
    Set custom DNS servers. This option can be used to override the DNS
... ...
@@ -92,6 +103,8 @@ configuration passed to the container. Typically this is necessary when the
92 92
 host DNS configuration is invalid for the container (e.g., 127.0.0.1). When this
93 93
 is the case the **-dns** flags is necessary for every run.
94 94
 
95
+**-e**, **--env**=[]
96
+   Set environment variables
95 97
 
96 98
 **-e**, **-env**=*environment*
97 99
    Set environment variables. This option allows you to specify arbitrary
... ...
@@ -111,7 +124,7 @@ something else inside the container, so you can override the default ENTRYPOINT
111 111
 at runtime by using a **--entrypoint** and a string to specify the new
112 112
 ENTRYPOINT.
113 113
 **--env-file**=[]
114
-   Read in a line delimited file of ENV variables
114
+   Read in a line delimited file of environment variables
115 115
 
116 116
 **--expose**=*port*
117 117
    Expose a port from the container without publishing it to your host. A
... ...
@@ -190,23 +203,18 @@ outside of a container on the host.
190 190
 
191 191
 
192 192
 **--rm**=*true*|*false*
193
-   If set to *true* the container is automatically removed when it exits. The
194
-default is *false*. This option is incompatible with **-d**.
195
-
193
+   Automatically remove the container when it exits (incompatible with -d). The default is *false*.
196 194
 
197 195
 **--sig-proxy**=*true*|*false*
198
-   When set to true, proxy received signals to the process (even in
199
-non-tty mode). SIGCHLD, SIGKILL, and SIGSTOP are not proxied. The default is *true*.
196
+   Proxy received signals to the process (even in non-TTY mode). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*.
200 197
 
201
-
202
-**-t**, **-tty**=*true*|*false*
198
+**-t**, **--tty**=*true*|*false*
203 199
    When set to true Docker can allocate a pseudo-tty and attach to the standard
204 200
 input of any container. This can be used, for example, to run a throwaway
205 201
 interactive shell. The default is value is false.
206 202
 
207
-
208
-**-u**, **-user**=*username*,*uid*
209
-   Set a username or UID for the container.
203
+**-u**, **--user**=""
204
+   Username or UID
210 205
 
211 206
 
212 207
 **-v**, **-volume**=*volume*[:ro|:rw]
... ...
@@ -374,3 +382,4 @@ changes will also be reflected on the host in /var/db.
374 374
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
375 375
 based on docker.com source material and internal work.
376 376
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
377
+July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -7,7 +7,7 @@ docker-tag - Tag an image into a repository
7 7
 # SYNOPSIS
8 8
 **docker tag**
9 9
 [**-f**|**--force**[=*false*]]
10
- IMAGE [REGISTRYHOST/][USERNAME/]NAME[:TAG]
10
+ IMAGE[:TAG] [REGISTRYHOST/][USERNAME/]NAME[:TAG]
11 11
 
12 12
 # DESCRIPTION
13 13
 This will give a new alias to an image in the repository. This refers to the
... ...
@@ -56,3 +56,4 @@ registry you must tag it with the registry hostname and port (if needed).
56 56
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
57 57
 based on docker.com source material and internal work.
58 58
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
59
+July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -738,7 +738,8 @@ specify this by adding the server name.
738 738
 
739 739
     Log out from a Docker registry, if no server is specified "https://index.docker.io/v1/" is the default.
740 740
 
741
-    example:
741
+For example:
742
+
742 743
     $ docker logout localhost:8080
743 744
 
744 745
 ## logs
... ...
@@ -953,20 +954,23 @@ removed before the image is removed.
953 953
 
954 954
     Run a command in a new container
955 955
 
956
-      -a, --attach=[]            Attach to stdin, stdout or stderr.
956
+      -a, --attach=[]            Attach to STDIN, STDOUT or STDERR.
957 957
       -c, --cpu-shares=0         CPU shares (relative weight)
958
+      --cap-add=[]               Add Linux capabilities
959
+      --cap-drop=[]              Drop Linux capabilities
958 960
       --cidfile=""               Write the container ID to the file
959 961
       --cpuset=""                CPUs in which to allow execution (0-3, 0,1)
960
-      -d, --detach=false         Detached mode: Run container in the background, print new container id
961
-      --dns=[]                   Set custom dns servers
962
-      --dns-search=[]            Set custom dns search domains
962
+      -d, --detach=false         Detached mode: run container in the background and print new container ID
963
+      --device=[]                Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc)
964
+      --dns=[]                   Set custom DNS servers
965
+      --dns-search=[]            Set custom DNS search domains
963 966
       -e, --env=[]               Set environment variables
964
-      --entrypoint=""            Overwrite the default entrypoint of the image
965
-      --env-file=[]              Read in a line delimited file of ENV variables
967
+      --entrypoint=""            Overwrite the default ENTRYPOINT of the image
968
+      --env-file=[]              Read in a line delimited file of environment variables
966 969
       --expose=[]                Expose a port from the container without publishing it to your host
967 970
       -h, --hostname=""          Container host name
968
-      -i, --interactive=false    Keep stdin open even if not attached
969
-      --link=[]                  Add link to another container (name:alias)
971
+      -i, --interactive=false    Keep STDIN open even if not attached
972
+      --link=[]                  Add link to another container in the form of name:alias
970 973
       --lxc-conf=[]              (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
971 974
       -m, --memory=""            Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
972 975
       --name=""                  Assign a name to the container
... ...
@@ -981,12 +985,11 @@ removed before the image is removed.
981 981
                                    (use 'docker port' to see the actual mapping)
982 982
       --privileged=false         Give extended privileges to this container
983 983
       --rm=false                 Automatically remove the container when it exits (incompatible with -d)
984
-      --sig-proxy=true           Proxy received signals to the process (even in non-tty mode). SIGCHLD, SIGKILL, and SIGSTOP are not proxied.
985
-      -t, --tty=false            Allocate a pseudo-tty
984
+      --sig-proxy=true           Proxy received signals to the process (even in non-TTY mode). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.
985
+      -t, --tty=false            Allocate a pseudo-TTY
986 986
       -u, --user=""              Username or UID
987
-      -v, --volume=[]            Bind mount a volume (e.g., from the host: -v /host:/container, from docker: -v /container)
987
+      -v, --volume=[]            Bind mount a volume (e.g., from the host: -v /host:/container, from Docker: -v /container)
988 988
       --volumes-from=[]          Mount volumes from the specified container(s)
989
-      --device=[]                Add a host device to the container (e.g. --device=/dev/sdc[:/dev/xvdc[:rwm]])
990 989
       -w, --workdir=""           Working directory inside the container
991 990
 
992 991
 The `docker run` command first `creates` a writeable container layer over the
... ...
@@ -1272,7 +1275,7 @@ grace period, SIGKILL
1272 1272
 
1273 1273
 ## tag
1274 1274
 
1275
-    Usage: docker tag [OPTIONS] IMAGE [REGISTRYHOST/][USERNAME/]NAME[:TAG]
1275
+    Usage: docker tag [OPTIONS] IMAGE[:TAG] [REGISTRYHOST/][USERNAME/]NAME[:TAG]
1276 1276
 
1277 1277
     Tag an image into a repository
1278 1278
 
... ...
@@ -1292,7 +1295,7 @@ them to [*Share Images via Repositories*](
1292 1292
 
1293 1293
     Usage: docker unpause CONTAINER
1294 1294
 
1295
-    Resumes a paused container.
1295
+    Unpause all processes within a container
1296 1296
 
1297 1297
 The `docker unpause` command uses the cgroups freezer to un-suspend all
1298 1298
 processes in a container.