Browse code

Add 2 missing cli commands to docs (events + insert) and alphabetically order docker output

Thijs Terlouw authored on 2013/09/03 23:35:22
Showing 5 changed files
... ...
@@ -104,6 +104,7 @@ Solomon Hykes <solomon@dotcloud.com>
104 104
 Sridhar Ratnakumar <sridharr@activestate.com>
105 105
 Stefan Praszalowicz <stefan@greplin.com>
106 106
 Thatcher Peskens <thatcher@dotcloud.com>
107
+Thijs Terlouw <thijsterlouw@gmail.com>
107 108
 Thomas Bikeev <thomas.bikeev@mac.com>
108 109
 Thomas Hansen <thomas.hansen@gmail.com>
109 110
 Tianon Gravi <admwiggin@gmail.com>
... ...
@@ -91,7 +91,6 @@ func (cli *DockerCli) CmdHelp(args ...string) error {
91 91
 		{"login", "Register or Login to the docker registry server"},
92 92
 		{"logs", "Fetch the logs of a container"},
93 93
 		{"port", "Lookup the public-facing port which is NAT-ed to PRIVATE_PORT"},
94
-		{"top", "Lookup the running processes of a container"},
95 94
 		{"ps", "List containers"},
96 95
 		{"pull", "Pull an image or a repository from the docker registry server"},
97 96
 		{"push", "Push an image or a repository to the docker registry server"},
... ...
@@ -103,6 +102,7 @@ func (cli *DockerCli) CmdHelp(args ...string) error {
103 103
 		{"start", "Start a stopped container"},
104 104
 		{"stop", "Stop a running container"},
105 105
 		{"tag", "Tag an image into a repository"},
106
+		{"top", "Lookup the running processes of a container"},
106 107
 		{"version", "Show the docker version information"},
107 108
 		{"wait", "Block until a container stops, then print its exit code"},
108 109
 	} {
109 110
new file mode 100644
... ...
@@ -0,0 +1,34 @@
0
+:title: Events Command
1
+:description: Get real time events from the server
2
+:keywords: events, docker, documentation
3
+
4
+=================================================================
5
+``events`` -- Get real time events from the server
6
+=================================================================
7
+
8
+::
9
+
10
+    Usage: docker events
11
+
12
+    Get real time events from the server
13
+
14
+Examples
15
+--------
16
+
17
+Starting and stopping a container
18
+.................................
19
+
20
+.. code-block:: bash
21
+
22
+    $ sudo docker start 4386fb97867d
23
+    $ sudo docker stop 4386fb97867d
24
+
25
+In another shell
26
+
27
+.. code-block:: bash
28
+    
29
+    $ sudo docker events
30
+    [2013-09-03 15:49:26 +0200 CEST] 4386fb97867d: (from 12de384bfb10) start
31
+    [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) die
32
+    [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) stop
33
+
0 34
new file mode 100644
... ...
@@ -0,0 +1,23 @@
0
+:title: Insert Command
1
+:description: Insert a file in an image
2
+:keywords: insert, image, docker, documentation
3
+
4
+==========================================================================
5
+``insert`` -- Insert a file in an image
6
+==========================================================================
7
+
8
+::
9
+
10
+    Usage: docker insert IMAGE URL PATH
11
+
12
+    Insert a file from URL in the IMAGE at PATH
13
+
14
+Examples
15
+--------
16
+
17
+Insert file from github
18
+.......................
19
+
20
+.. code-block:: bash
21
+
22
+    $ sudo docker insert 8283e18b24bc https://raw.github.com/metalivedev/django/master/postinstall /tmp/postinstall.sh
... ...
@@ -17,11 +17,13 @@ Contents:
17 17
   commit  <command/commit>
18 18
   cp      <command/cp>
19 19
   diff    <command/diff>
20
+  events  <command/events>
20 21
   export  <command/export>
21 22
   history <command/history>
22 23
   images  <command/images>
23 24
   import  <command/import>
24 25
   info    <command/info>
26
+  insert  <command/insert>
25 27
   inspect <command/inspect>
26 28
   kill    <command/kill>
27 29
   login   <command/login>