Browse code

improve docker man page

fix issue #12708:
"docker man page is misleading about format of commands"

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

Zhang Wei authored on 2015/04/27 21:54:51
Showing 1 changed files
... ...
@@ -128,120 +128,158 @@ unix://[/path/to/socket] to use.
128 128
   Enable selinux support. Default is false. SELinux does not presently support the BTRFS storage driver.
129 129
 
130 130
 # COMMANDS
131
-**docker-attach(1)**
131
+**attach**
132 132
   Attach to a running container
133
+  See **docker-attach(1)** for full documentation on the **attach** command.
133 134
 
134
-**docker-build(1)**
135
+**build**
135 136
   Build an image from a Dockerfile
137
+  See **docker-build(1)** for full documentation on the **build** command.
136 138
 
137
-**docker-commit(1)**
139
+**commit**
138 140
   Create a new image from a container's changes
141
+  See **docker-commit(1)** for full documentation on the **commit** command.
139 142
 
140
-**docker-cp(1)**
143
+**cp**
141 144
   Copy files/folders from a container's filesystem to the host
145
+  See **docker-cp(1)** for full documentation on the **cp** command.
142 146
 
143
-**docker-create(1)**
147
+**create**
144 148
   Create a new container
149
+  See **docker-create(1)** for full documentation on the **create** command.
145 150
 
146
-**docker-diff(1)**
151
+**diff**
147 152
   Inspect changes on a container's filesystem
153
+  See **docker-diff(1)** for full documentation on the **diff** command.
148 154
 
149
-**docker-events(1)**
155
+**events**
150 156
   Get real time events from the server
157
+  See **docker-events(1)** for full documentation on the **events** command.
151 158
 
152
-**docker-exec(1)**
159
+**exec**
153 160
   Run a command in a running container
161
+  See **docker-exec(1)** for full documentation on the **exec** command.
154 162
 
155
-**docker-export(1)**
163
+**export**
156 164
   Stream the contents of a container as a tar archive
165
+  See **docker-export(1)** for full documentation on the **export** command.
157 166
 
158
-**docker-history(1)**
167
+**history**
159 168
   Show the history of an image
169
+  See **docker-history(1)** for full documentation on the **history** command.
160 170
 
161
-**docker-images(1)**
171
+**images**
162 172
   List images
173
+  See **docker-images(1)** for full documentation on the **images** command.
163 174
 
164
-**docker-import(1)**
175
+**import**
165 176
   Create a new filesystem image from the contents of a tarball
177
+  See **docker-import(1)** for full documentation on the **import** command.
166 178
 
167
-**docker-info(1)**
179
+**info**
168 180
   Display system-wide information
181
+  See **docker-info(1)** for full documentation on the **info** command.
169 182
 
170
-**docker-inspect(1)**
183
+**inspect**
171 184
   Return low-level information on a container or image
185
+  See **docker-inspect(1)** for full documentation on the **inspect** command.
172 186
 
173
-**docker-kill(1)**
187
+**kill**
174 188
   Kill a running container (which includes the wrapper process and everything
175 189
 inside it)
190
+  See **docker-kill(1)** for full documentation on the **kill** command.
176 191
 
177
-**docker-load(1)**
192
+**load**
178 193
   Load an image from a tar archive
194
+  See **docker-load(1)** for full documentation on the **load** command.
179 195
 
180
-**docker-login(1)**
196
+**login**
181 197
   Register or login to a Docker Registry
198
+  See **docker-login(1)** for full documentation on the **login** command.
182 199
 
183
-**docker-logout(1)**
200
+**logout**
184 201
   Log the user out of a Docker Registry
202
+  See **docker-logout(1)** for full documentation on the **logout** command.
185 203
 
186
-**docker-logs(1)**
204
+**logs**
187 205
   Fetch the logs of a container
206
+  See **docker-logs(1)** for full documentation on the **logs** command.
188 207
 
189
-**docker-pause(1)**
208
+**pause**
190 209
   Pause all processes within a container
210
+  See **docker-pause(1)** for full documentation on the **pause** command.
191 211
 
192
-**docker-port(1)**
212
+**port**
193 213
   Lookup the public-facing port which is NAT-ed to PRIVATE_PORT
214
+  See **docker-port(1)** for full documentation on the **port** command.
194 215
 
195
-**docker-ps(1)**
216
+**ps**
196 217
   List containers
218
+  See **docker-ps(1)** for full documentation on the **ps** command.
197 219
 
198
-**docker-pull(1)**
220
+**pull**
199 221
   Pull an image or a repository from a Docker Registry
222
+  See **docker-pull(1)** for full documentation on the **pull** command.
200 223
 
201
-**docker-push(1)**
224
+**push**
202 225
   Push an image or a repository to a Docker Registry
226
+  See **docker-push(1)** for full documentation on the **push** command.
203 227
 
204
-**docker-restart(1)**
228
+**restart**
205 229
   Restart a running container
230
+  See **docker-restart(1)** for full documentation on the **restart** command.
206 231
 
207
-**docker-rm(1)**
232
+**rm**
208 233
   Remove one or more containers
234
+  See **docker-rm(1)** for full documentation on the **rm** command.
209 235
 
210
-**docker-rmi(1)**
236
+**rmi**
211 237
   Remove one or more images
238
+  See **docker-rmi(1)** for full documentation on the **rmi** command.
212 239
 
213
-**docker-run(1)**
240
+**run**
214 241
   Run a command in a new container
242
+  See **docker-run(1)** for full documentation on the **run** command.
215 243
 
216
-**docker-save(1)**
244
+**save**
217 245
   Save an image to a tar archive
246
+  See **docker-save(1)** for full documentation on the **save** command.
218 247
 
219
-**docker-search(1)**
248
+**search**
220 249
   Search for an image in the Docker index
250
+  See **docker-search(1)** for full documentation on the **search** command.
221 251
 
222
-**docker-start(1)**
252
+**start**
223 253
   Start a stopped container
254
+  See **docker-start(1)** for full documentation on the **start** command.
224 255
 
225
-**docker-stats(1)**
256
+**stats**
226 257
   Display a live stream of one or more containers' resource usage statistics
258
+  See **docker-stats(1)** for full documentation on the **stats** command.
227 259
 
228
-**docker-stop(1)**
260
+**stop**
229 261
   Stop a running container
262
+  See **docker-stop(1)** for full documentation on the **stop** command.
230 263
 
231
-**docker-tag(1)**
264
+**tag**
232 265
   Tag an image into a repository
266
+  See **docker-tag(1)** for full documentation on the **tag** command.
233 267
 
234
-**docker-top(1)**
268
+**top**
235 269
   Lookup the running processes of a container
270
+  See **docker-top(1)** for full documentation on the **top** command.
236 271
 
237
-**docker-unpause(1)**
272
+**unpause**
238 273
   Unpause all processes within a container
274
+  See **docker-unpause(1)** for full documentation on the **unpause** command.
239 275
 
240
-**docker-version(1)**
276
+**version**
241 277
   Show the Docker version information
278
+  See **docker-version(1)** for full documentation on the **version** command.
242 279
 
243
-**docker-wait(1)**
280
+**wait**
244 281
   Block until a container stops, then print its exit code
282
+  See **docker-wait(1)** for full documentation on the **wait** command.
245 283
 
246 284
 # STORAGE DRIVER OPTIONS
247 285