From f7a88ba8a84d76f3f08089f7cfaad7bd89e28594 Mon Sep 17 00:00:00 2001 From: Sally O'Malley Date: Tue, 13 Oct 2015 11:12:30 -0400 Subject: [PATCH] various man page typos Signed-off-by: Sally O'Malley --- man/docker-attach.1.md | 2 +- man/docker-export.1.md | 4 +++- man/docker-import.1.md | 10 +++++----- man/docker-inspect.1.md | 7 ++++--- man/docker-rename.1.md | 2 ++ man/docker-rm.1.md | 4 ++-- man/docker-stats.1.md | 1 + 7 files changed, 18 insertions(+), 12 deletions(-) diff --git a/man/docker-attach.1.md b/man/docker-attach.1.md index 1f73d8c9bb..658228cddb 100644 --- a/man/docker-attach.1.md +++ b/man/docker-attach.1.md @@ -6,7 +6,7 @@ docker-attach - Attach to a running container # SYNOPSIS **docker attach** -[**--help**]/ +[**--help**] [**--no-stdin**[=*false*]] [**--sig-proxy**[=*true*]] CONTAINER diff --git a/man/docker-export.1.md b/man/docker-export.1.md index f3096eacfc..3d59e4788e 100644 --- a/man/docker-export.1.md +++ b/man/docker-export.1.md @@ -7,6 +7,7 @@ docker-export - Export the contents of a container's filesystem as a tar archive # SYNOPSIS **docker export** [**--help**] +[**-o**|**--output**[=*""*]] CONTAINER # DESCRIPTION @@ -19,8 +20,9 @@ Stream to a file instead of STDOUT by using **-o**. # OPTIONS **--help** Print usage statement + **-o**, **--output**="" - Write to a file, instead of STDOUT + Write to a file, instead of STDOUT # EXAMPLES Export the contents of the container called angry_bell to a tar file diff --git a/man/docker-import.1.md b/man/docker-import.1.md index b812b83068..0509dd0d67 100644 --- a/man/docker-import.1.md +++ b/man/docker-import.1.md @@ -6,16 +6,19 @@ docker-import - Create an empty filesystem image and import the contents of the # SYNOPSIS **docker import** -[**-c**|**--change**[= []**]] +[**-c**|**--change**[=*[]*]] [**-m**|**--message**[=*MESSAGE*]] [**--help**] -file|URL|- [REPOSITORY[:TAG]] +file|URL|**-**[REPOSITORY[:TAG]] # OPTIONS **-c**, **--change**=[] Apply specified Dockerfile instructions while importing the image Supported Dockerfile instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` +**--help** + Print usage statement + **-m**, **--message**="" 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`, `.tar.gz`, `.tgz`, `.bzip`, `.tar.xz`, `.txz`) into it, then optionally tag it. -# OPTIONS -**--help** - Print usage statement # EXAMPLES diff --git a/man/docker-inspect.1.md b/man/docker-inspect.1.md index 3d1db2ed3e..18961a86f2 100644 --- a/man/docker-inspect.1.md +++ b/man/docker-inspect.1.md @@ -30,8 +30,8 @@ each result. # 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 [ @@ -208,7 +208,7 @@ https://golang.org/pkg/text/template/. ## Getting information on an image Use an image's ID or name (e.g., repository/name[:tag]) to get information -on it. +about the image: $ 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. June 2014, updated by Sven Dowideit April 2015, updated by Qiang Huang +October 2015, updated by Sally O'Malley diff --git a/man/docker-rename.1.md b/man/docker-rename.1.md index f741a15b47..aa19a03ae7 100644 --- a/man/docker-rename.1.md +++ b/man/docker-rename.1.md @@ -11,3 +11,5 @@ OLD_NAME NEW_NAME # OPTIONS There are no available options. +# DESCRIPTION +Rename a container. Container may be running, paused or stopped. diff --git a/man/docker-rm.1.md b/man/docker-rm.1.md index 5753cb1cd7..af73b804c9 100644 --- a/man/docker-rm.1.md +++ b/man/docker-rm.1.md @@ -33,7 +33,7 @@ containers on a host use the **docker ps -a** command. # 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** 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 -##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** command. The use that name as follows: diff --git a/man/docker-stats.1.md b/man/docker-stats.1.md index b8dd119138..6bfa59e40f 100644 --- a/man/docker-stats.1.md +++ b/man/docker-stats.1.md @@ -7,6 +7,7 @@ docker-stats - Display a live stream of one or more containers' resource usage s # SYNOPSIS **docker stats** [**--help**] +[**--no-stream**[=*false*]] CONTAINER [CONTAINER...] # DESCRIPTION