Browse code

Add missing "--default-runtime" flag in manpage

Add missing flag and more descriptions in manpage.

Signed-off-by: Zhang Wei <zhangwei555@huawei.com>

Zhang Wei authored on 2016/12/17 23:01:59
Showing 2 changed files
... ...
@@ -684,16 +684,18 @@ configuration file or using the `--add-runtime` command line argument.
684 684
 The following is an example adding 2 runtimes via the configuration:
685 685
 
686 686
 ```json
687
-"default-runtime": "runc",
688
-"runtimes": {
689
-	"runc": {
690
-		"path": "runc"
691
-	},
692
-	"custom": {
693
-		"path": "/usr/local/bin/my-runc-replacement",
694
-		"runtimeArgs": [
695
-			"--debug"
696
-		]
687
+{
688
+	"default-runtime": "runc",
689
+	"runtimes": {
690
+		"runc": {
691
+			"path": "runc"
692
+		},
693
+		"custom": {
694
+			"path": "/usr/local/bin/my-runc-replacement",
695
+			"runtimeArgs": [
696
+				"--debug"
697
+			]
698
+		}
697 699
 	}
698 700
 }
699 701
 ```
... ...
@@ -20,6 +20,7 @@ dockerd - Enable daemon mode
20 20
 [**-D**|**--debug**]
21 21
 [**--default-gateway**[=*DEFAULT-GATEWAY*]]
22 22
 [**--default-gateway-v6**[=*DEFAULT-GATEWAY-V6*]]
23
+[**--default-runtime**[=*runc*]]
23 24
 [**--default-ulimit**[=*[]*]]
24 25
 [**--disable-legacy-registry**]
25 26
 [**--dns**[=*[]*]]
... ...
@@ -84,7 +85,35 @@ following format.
84 84
 # OPTIONS
85 85
 
86 86
 **--add-runtime**=[]
87
-  Set additional OCI compatible runtime.
87
+  Runtimes can be registered with the daemon either via the
88
+configuration file or using the `--add-runtime` command line argument.
89
+
90
+  The following is an example adding 2 runtimes via the configuration:
91
+
92
+```json
93
+{
94
+	"default-runtime": "runc",
95
+	"runtimes": {
96
+		"runc": {
97
+			"path": "runc"
98
+		},
99
+		"custom": {
100
+			"path": "/usr/local/bin/my-runc-replacement",
101
+			"runtimeArgs": [
102
+				"--debug"
103
+			]
104
+		}
105
+	}
106
+}
107
+```
108
+
109
+  This is the same example via the command line:
110
+
111
+```bash
112
+$ sudo dockerd --add-runtime runc=runc --add-runtime custom=/usr/local/bin/my-runc-replacement
113
+```
114
+
115
+  **Note**: defining runtime arguments via the command line is not supported.
88 116
 
89 117
 **--api-cors-header**=""
90 118
   Set CORS headers in the Engine API. Default is cors disabled. Give urls like
... ...
@@ -132,6 +161,9 @@ following format.
132 132
 **--default-gateway-v6**=""
133 133
   IPv6 address of the container default gateway
134 134
 
135
+**--default-runtime**="runc"
136
+  Set default runtime if there're more than one specified by `--add-runtime`.
137
+
135 138
 **--default-ulimit**=[]
136 139
   Default ulimits for containers.
137 140