瀏覽代碼

Unify docker commands' usage in man and help

Signed-off-by: Ma Shimiao <mashimiao.fnst@cn.fujitsu.com>
Ma Shimiao 10 年之前
父節點
當前提交
f38232b475

+ 1 - 1
api/client/cp.go

@@ -16,7 +16,7 @@ import (
 //
 // Usage: docker cp CONTAINER:PATH HOSTDIR
 func (cli *DockerCli) CmdCp(args ...string) error {
-	cmd := cli.Subcmd("cp", []string{"CONTAINER:PATH HOSTDIR|-"}, "Copy files/folders from a PATH on the container to a HOSTDIR on the host\nrunning the command. Use '-' to write the data as a tar file to STDOUT.", true)
+	cmd := cli.Subcmd("cp", []string{"CONTAINER:PATH HOSTDIR|-"}, "Copy files/folders from a container's PATH to a HOSTDIR on the host\nrunning the command. Use '-' to write the data as a tar file to STDOUT.", true)
 	cmd.Require(flag.Exact, 2)
 
 	cmd.ParseFlags(args, true)

+ 1 - 1
api/client/export.go

@@ -14,7 +14,7 @@ import (
 //
 // Usage: docker export [OPTIONS] CONTAINER
 func (cli *DockerCli) CmdExport(args ...string) error {
-	cmd := cli.Subcmd("export", []string{"CONTAINER"}, "Export a filesystem as a tar archive (streamed to STDOUT by default)", true)
+	cmd := cli.Subcmd("export", []string{"CONTAINER"}, "Export the contents of a container's filesystem as a tar archive", true)
 	outfile := cmd.String([]string{"o", "-output"}, "", "Write to a file, instead of STDOUT")
 	cmd.Require(flag.Exact, 1)
 

+ 1 - 1
api/client/pull.go

@@ -15,7 +15,7 @@ import (
 //
 // Usage: docker pull [OPTIONS] IMAGENAME[:TAG|@DIGEST]
 func (cli *DockerCli) CmdPull(args ...string) error {
-	cmd := cli.Subcmd("pull", []string{"NAME[:TAG|@DIGEST]"}, "Pull an image or a repository from the registry", true)
+	cmd := cli.Subcmd("pull", []string{"NAME[:TAG|@DIGEST]"}, "Pull an image or a repository from a registry", true)
 	allTags := cmd.Bool([]string{"a", "-all-tags"}, false, "Download all tagged images in the repository")
 	cmd.Require(flag.Exact, 1)
 

+ 1 - 1
api/client/push.go

@@ -13,7 +13,7 @@ import (
 //
 // Usage: docker push NAME[:TAG]
 func (cli *DockerCli) CmdPush(args ...string) error {
-	cmd := cli.Subcmd("push", []string{"NAME[:TAG]"}, "Push an image or a repository to the registry", true)
+	cmd := cli.Subcmd("push", []string{"NAME[:TAG]"}, "Push an image or a repository to a registry", true)
 	cmd.Require(flag.Exact, 1)
 
 	cmd.ParseFlags(args, true)

+ 16 - 16
docker/flags.go

@@ -32,40 +32,40 @@ var (
 		{"attach", "Attach to a running container"},
 		{"build", "Build an image from a Dockerfile"},
 		{"commit", "Create a new image from a container's changes"},
-		{"cp", "Copy files/folders from a container's filesystem to the host path"},
+		{"cp", "Copy files/folders from a container to a HOSTDIR or to STDOUT"},
 		{"create", "Create a new container"},
 		{"diff", "Inspect changes on a container's filesystem"},
 		{"events", "Get real time events from the server"},
 		{"exec", "Run a command in a running container"},
-		{"export", "Stream the contents of a container as a tar archive"},
+		{"export", "Export a container's filesystem as a tar archive"},
 		{"history", "Show the history of an image"},
 		{"images", "List images"},
-		{"import", "Create a new filesystem image from the contents of a tarball"},
+		{"import", "Import the contents from a tarball to create a filesystem image"},
 		{"info", "Display system-wide information"},
 		{"inspect", "Return low-level information on a container or image"},
 		{"kill", "Kill a running container"},
-		{"load", "Load an image from a tar archive"},
-		{"login", "Register or log in to a Docker registry server"},
-		{"logout", "Log out from a Docker registry server"},
+		{"load", "Load an image from a tar archive or STDIN"},
+		{"login", "Register or log in to a Docker registry"},
+		{"logout", "Log out from a Docker registry"},
 		{"logs", "Fetch the logs of a container"},
-		{"port", "Lookup the public-facing port that is NAT-ed to PRIVATE_PORT"},
+		{"port", "List port mappings or a specific mapping for the CONTAINER"},
 		{"pause", "Pause all processes within a container"},
 		{"ps", "List containers"},
-		{"pull", "Pull an image or a repository from a Docker registry server"},
-		{"push", "Push an image or a repository to a Docker registry server"},
-		{"rename", "Rename an existing container"},
+		{"pull", "Pull an image or a repository from a registry"},
+		{"push", "Push an image or a repository to a registry"},
+		{"rename", "Rename a container"},
 		{"restart", "Restart a running container"},
 		{"rm", "Remove one or more containers"},
 		{"rmi", "Remove one or more images"},
 		{"run", "Run a command in a new container"},
-		{"save", "Save an image to a tar archive"},
-		{"search", "Search for an image on the Docker Hub"},
-		{"start", "Start a stopped container"},
-		{"stats", "Display a stream of a containers' resource usage statistics"},
+		{"save", "Save an image(s) to a tar archive"},
+		{"search", "Search the Docker Hub for images"},
+		{"start", "Start one or more stopped containers"},
+		{"stats", "Display a live stream of container(s) resource usage statistics"},
 		{"stop", "Stop a running container"},
 		{"tag", "Tag an image into a repository"},
-		{"top", "Lookup the running processes of a container"},
-		{"unpause", "Unpause a paused container"},
+		{"top", "Display the running processes of a container"},
+		{"unpause", "Unpause all processes within a container"},
 		{"version", "Show the Docker version information"},
 		{"wait", "Block until a container stops, then print its exit code"},
 	}

+ 1 - 1
docs/reference/commandline/load.md

@@ -13,7 +13,7 @@ weight=1
 
     Usage: docker load [OPTIONS]
 
-    Load an image from a tar archive on STDIN
+    Load an image from a tar archive or STDIN
 
       -i, --input=""     Read from a tar archive file, instead of STDIN
 

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

@@ -2,7 +2,7 @@
 % Docker Community
 % JUNE 2014
 # NAME
-docker-export - Export the contents of a filesystem as a tar archive to STDOUT
+docker-export - Export the contents of a container's filesystem as a tar archive
 
 # SYNOPSIS
 **docker export**

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

@@ -2,7 +2,7 @@
 % Docker Community
 % JUNE 2014
 # NAME
-docker-load - Load an image from a tar archive on STDIN
+docker-load - Load an image from a tar archive or STDIN
 
 # SYNOPSIS
 **docker load**

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

@@ -2,7 +2,7 @@
 % Docker Community
 % JUNE 2014
 # NAME
-docker-logout - Log out from a Docker Registry.
+docker-logout - Log out from a Docker registry.
 
 # SYNOPSIS
 **docker logout**

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

@@ -11,7 +11,7 @@ CONTAINER [ps OPTIONS]
 
 # DESCRIPTION
 
-Look up the running process of the container. ps-OPTION can be any of the
+Display the running process of the container. ps-OPTION can be any of the
  options you would pass to a Linux ps command.
 
 # OPTIONS
@@ -31,3 +31,4 @@ Run **docker top** with the ps option of -x:
 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 <SvenDowideit@home.org.au>
+June 2015, updated by Ma Shimiao <mashimiao.fnst@cn.fujitsu.com>