Browse Source

various man page typos

Signed-off-by: Sally O'Malley <somalley@redhat.com>
Sally O'Malley 9 years ago
parent
commit
d79860af87

+ 1 - 1
man/docker-attach.1.md

@@ -6,7 +6,7 @@ docker-attach - Attach to a running container
 
 
 # SYNOPSIS
 # SYNOPSIS
 **docker attach**
 **docker attach**
-[**--help**]/
+[**--help**]
 [**--no-stdin**[=*false*]]
 [**--no-stdin**[=*false*]]
 [**--sig-proxy**[=*true*]]
 [**--sig-proxy**[=*true*]]
 CONTAINER
 CONTAINER

+ 3 - 1
man/docker-export.1.md

@@ -7,6 +7,7 @@ docker-export - Export the contents of a container's filesystem as a tar archive
 # SYNOPSIS
 # SYNOPSIS
 **docker export**
 **docker export**
 [**--help**]
 [**--help**]
+[**-o**|**--output**[=*""*]]
 CONTAINER
 CONTAINER
 
 
 # DESCRIPTION
 # DESCRIPTION
@@ -19,8 +20,9 @@ Stream to a file instead of STDOUT by using **-o**.
 # OPTIONS
 # OPTIONS
 **--help**
 **--help**
   Print usage statement
   Print usage statement
+  
 **-o**, **--output**=""
 **-o**, **--output**=""
-   Write to a file, instead of STDOUT
+  Write to a file, instead of STDOUT
 
 
 # EXAMPLES
 # EXAMPLES
 Export the contents of the container called angry_bell to a tar file
 Export the contents of the container called angry_bell to a tar file

+ 5 - 5
man/docker-import.1.md

@@ -6,16 +6,19 @@ docker-import - Create an empty filesystem image and import the contents of the
 
 
 # SYNOPSIS
 # SYNOPSIS
 **docker import**
 **docker import**
-[**-c**|**--change**[= []**]]
+[**-c**|**--change**[=*[]*]]
 [**-m**|**--message**[=*MESSAGE*]]
 [**-m**|**--message**[=*MESSAGE*]]
 [**--help**]
 [**--help**]
-file|URL|- [REPOSITORY[:TAG]]
+file|URL|**-**[REPOSITORY[:TAG]]
 
 
 # OPTIONS
 # OPTIONS
 **-c**, **--change**=[]
 **-c**, **--change**=[]
    Apply specified Dockerfile instructions while importing the image
    Apply specified Dockerfile instructions while importing the image
    Supported Dockerfile instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
    Supported Dockerfile instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
 
 
+**--help**
+  Print usage statement
+
 **-m**, **--message**=""
 **-m**, **--message**=""
    Set commit message for imported image
    Set commit message for imported image
 
 
@@ -23,9 +26,6 @@ file|URL|- [REPOSITORY[:TAG]]
 Create a new filesystem image from the contents of a tarball (`.tar`,
 Create a new filesystem image from the contents of a tarball (`.tar`,
 `.tar.gz`, `.tgz`, `.bzip`, `.tar.xz`, `.txz`) into it, then optionally tag it.
 `.tar.gz`, `.tgz`, `.bzip`, `.tar.xz`, `.txz`) into it, then optionally tag it.
 
 
-# OPTIONS
-**--help**
-  Print usage statement
 
 
 # EXAMPLES
 # EXAMPLES
 
 

+ 4 - 3
man/docker-inspect.1.md

@@ -30,8 +30,8 @@ each result.
 
 
 # EXAMPLES
 # EXAMPLES
 
 
-Getting information on an image where image name conflict with the container name,
-e,g both image and container are named rhel7.
+Get information about an image when image name conflicts with the container name,
+e.g. both image and container are named rhel7:
 
 
     $ docker inspect --type=image rhel7
     $ docker inspect --type=image rhel7
     [
     [
@@ -208,7 +208,7 @@ https://golang.org/pkg/text/template/.
 ## Getting information on an image
 ## Getting information on an image
 
 
 Use an image's ID or name (e.g., repository/name[:tag]) to get information
 Use an image's ID or name (e.g., repository/name[:tag]) to get information
-on it.
+about the image:
 
 
     $ docker inspect ded7cd95e059
     $ docker inspect ded7cd95e059
     [{
     [{
@@ -289,3 +289,4 @@ April 2014, originally compiled by William Henry (whenry at redhat dot com)
 based on docker.com source material and internal work.
 based on docker.com source material and internal work.
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
 April 2015, updated by Qiang Huang <h.huangqiang@huawei.com>
 April 2015, updated by Qiang Huang <h.huangqiang@huawei.com>
+October 2015, updated by Sally O'Malley <somalley@redhat.com>

+ 2 - 0
man/docker-rename.1.md

@@ -11,3 +11,5 @@ OLD_NAME NEW_NAME
 # OPTIONS
 # OPTIONS
 There are no available options.
 There are no available options.
 
 
+# DESCRIPTION
+Rename a container.  Container may be running, paused or stopped.

+ 2 - 2
man/docker-rm.1.md

@@ -33,7 +33,7 @@ containers on a host use the **docker ps -a** command.
 
 
 # EXAMPLES
 # EXAMPLES
 
 
-##Removing a container using its ID##
+## Removing a container using its ID
 
 
 To remove a container using its ID, find either from a **docker ps -a**
 To remove a container using its ID, find either from a **docker ps -a**
 command, or use the ID returned from the **docker run** command, or retrieve
 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**:
 
 
     docker rm abebf7571666
     docker rm abebf7571666
 
 
-##Removing a container using the container name##
+## Removing a container using the container name
 
 
 The name of the container can be found using the **docker ps -a**
 The name of the container can be found using the **docker ps -a**
 command. The use that name as follows:
 command. The use that name as follows:

+ 1 - 0
man/docker-stats.1.md

@@ -7,6 +7,7 @@ docker-stats - Display a live stream of one or more containers' resource usage s
 # SYNOPSIS
 # SYNOPSIS
 **docker stats**
 **docker stats**
 [**--help**]
 [**--help**]
+[**--no-stream**[=*false*]]
 CONTAINER [CONTAINER...]
 CONTAINER [CONTAINER...]
 
 
 # DESCRIPTION
 # DESCRIPTION