Browse code

various man page typos

Signed-off-by: Sally O'Malley <somalley@redhat.com>

Sally O'Malley authored on 2015/10/14 00:12:30
Showing 7 changed files
... ...
@@ -6,7 +6,7 @@ docker-attach - Attach to a running container
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker attach**
9
-[**--help**]/
9
+[**--help**]
10 10
 [**--no-stdin**[=*false*]]
11 11
 [**--sig-proxy**[=*true*]]
12 12
 CONTAINER
... ...
@@ -7,6 +7,7 @@ docker-export - Export the contents of a container's filesystem as a tar archive
7 7
 # SYNOPSIS
8 8
 **docker export**
9 9
 [**--help**]
10
+[**-o**|**--output**[=*""*]]
10 11
 CONTAINER
11 12
 
12 13
 # DESCRIPTION
... ...
@@ -19,8 +20,9 @@ Stream to a file instead of STDOUT by using **-o**.
19 19
 # OPTIONS
20 20
 **--help**
21 21
   Print usage statement
22
+  
22 23
 **-o**, **--output**=""
23
-   Write to a file, instead of STDOUT
24
+  Write to a file, instead of STDOUT
24 25
 
25 26
 # EXAMPLES
26 27
 Export the contents of the container called angry_bell to a tar file
... ...
@@ -6,16 +6,19 @@ docker-import - Create an empty filesystem image and import the contents of the
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker import**
9
-[**-c**|**--change**[= []**]]
9
+[**-c**|**--change**[=*[]*]]
10 10
 [**-m**|**--message**[=*MESSAGE*]]
11 11
 [**--help**]
12
-file|URL|- [REPOSITORY[:TAG]]
12
+file|URL|**-**[REPOSITORY[:TAG]]
13 13
 
14 14
 # OPTIONS
15 15
 **-c**, **--change**=[]
16 16
    Apply specified Dockerfile instructions while importing the image
17 17
    Supported Dockerfile instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
18 18
 
19
+**--help**
20
+  Print usage statement
21
+
19 22
 **-m**, **--message**=""
20 23
    Set commit message for imported image
21 24
 
... ...
@@ -23,9 +26,6 @@ file|URL|- [REPOSITORY[:TAG]]
23 23
 Create a new filesystem image from the contents of a tarball (`.tar`,
24 24
 `.tar.gz`, `.tgz`, `.bzip`, `.tar.xz`, `.txz`) into it, then optionally tag it.
25 25
 
26
-# OPTIONS
27
-**--help**
28
-  Print usage statement
29 26
 
30 27
 # EXAMPLES
31 28
 
... ...
@@ -30,8 +30,8 @@ each result.
30 30
 
31 31
 # EXAMPLES
32 32
 
33
-Getting information on an image where image name conflict with the container name,
34
-e,g both image and container are named rhel7.
33
+Get information about an image when image name conflicts with the container name,
34
+e.g. both image and container are named rhel7:
35 35
 
36 36
     $ docker inspect --type=image rhel7
37 37
     [
... ...
@@ -208,7 +208,7 @@ https://golang.org/pkg/text/template/.
208 208
 ## Getting information on an image
209 209
 
210 210
 Use an image's ID or name (e.g., repository/name[:tag]) to get information
211
-on it.
211
+about the image:
212 212
 
213 213
     $ docker inspect ded7cd95e059
214 214
     [{
... ...
@@ -289,3 +289,4 @@ April 2014, originally compiled by William Henry (whenry at redhat dot com)
289 289
 based on docker.com source material and internal work.
290 290
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
291 291
 April 2015, updated by Qiang Huang <h.huangqiang@huawei.com>
292
+October 2015, updated by Sally O'Malley <somalley@redhat.com>
... ...
@@ -11,3 +11,5 @@ OLD_NAME NEW_NAME
11 11
 # OPTIONS
12 12
 There are no available options.
13 13
 
14
+# DESCRIPTION
15
+Rename a container.  Container may be running, paused or stopped.
... ...
@@ -33,7 +33,7 @@ containers on a host use the **docker ps -a** command.
33 33
 
34 34
 # EXAMPLES
35 35
 
36
-##Removing a container using its ID##
36
+## Removing a container using its ID
37 37
 
38 38
 To remove a container using its ID, find either from a **docker ps -a**
39 39
 command, or use the ID returned from the **docker run** command, or retrieve
... ...
@@ -41,7 +41,7 @@ it from a file used to store it using the **docker run --cidfile**:
41 41
 
42 42
     docker rm abebf7571666
43 43
 
44
-##Removing a container using the container name##
44
+## Removing a container using the container name
45 45
 
46 46
 The name of the container can be found using the **docker ps -a**
47 47
 command. The use that name as follows:
... ...
@@ -7,6 +7,7 @@ docker-stats - Display a live stream of one or more containers' resource usage s
7 7
 # SYNOPSIS
8 8
 **docker stats**
9 9
 [**--help**]
10
+[**--no-stream**[=*false*]]
10 11
 CONTAINER [CONTAINER...]
11 12
 
12 13
 # DESCRIPTION