* Replaced docker with Docker.
* Consistently used STDIN, STDOUT, STDERR.
* Consistently used TTY.
* Fixed some grammar and spelling issues.
* Fixed references to the index.
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: SvenDowideit)
| ... | ... |
@@ -67,25 +67,25 @@ func (cli *DockerCli) CmdHelp(args ...string) error {
|
| 67 | 67 |
{"inspect", "Return low-level information on a container"},
|
| 68 | 68 |
{"kill", "Kill a running container"},
|
| 69 | 69 |
{"load", "Load an image from a tar archive"},
|
| 70 |
- {"login", "Register or Login to the docker registry server"},
|
|
| 70 |
+ {"login", "Register or log in to the Docker registry server"},
|
|
| 71 | 71 |
{"logs", "Fetch the logs of a container"},
|
| 72 |
- {"port", "Lookup the public-facing port which is NAT-ed to PRIVATE_PORT"},
|
|
| 72 |
+ {"port", "Lookup the public-facing port that is NAT-ed to PRIVATE_PORT"},
|
|
| 73 | 73 |
{"pause", "Pause all processes within a container"},
|
| 74 | 74 |
{"ps", "List containers"},
|
| 75 |
- {"pull", "Pull an image or a repository from the docker registry server"},
|
|
| 76 |
- {"push", "Push an image or a repository to the docker registry server"},
|
|
| 75 |
+ {"pull", "Pull an image or a repository from a Docker registry server"},
|
|
| 76 |
+ {"push", "Push an image or a repository to a Docker registry server"},
|
|
| 77 | 77 |
{"restart", "Restart a running container"},
|
| 78 | 78 |
{"rm", "Remove one or more containers"},
|
| 79 | 79 |
{"rmi", "Remove one or more images"},
|
| 80 | 80 |
{"run", "Run a command in a new container"},
|
| 81 | 81 |
{"save", "Save an image to a tar archive"},
|
| 82 |
- {"search", "Search for an image in the docker index"},
|
|
| 82 |
+ {"search", "Search for an image on the Docker Hub"},
|
|
| 83 | 83 |
{"start", "Start a stopped container"},
|
| 84 | 84 |
{"stop", "Stop a running container"},
|
| 85 | 85 |
{"tag", "Tag an image into a repository"},
|
| 86 | 86 |
{"top", "Lookup the running processes of a container"},
|
| 87 | 87 |
{"unpause", "Unpause a paused container"},
|
| 88 |
- {"version", "Show the docker version information"},
|
|
| 88 |
+ {"version", "Show the Docker version information"},
|
|
| 89 | 89 |
{"wait", "Block until a container stops, then print its exit code"},
|
| 90 | 90 |
} {
|
| 91 | 91 |
help += fmt.Sprintf(" %-10.10s%s\n", command[0], command[1])
|
| ... | ... |
@@ -123,12 +123,12 @@ func (cli *DockerCli) CmdBuild(args ...string) error {
|
| 123 | 123 |
buf := bufio.NewReader(cli.in) |
| 124 | 124 |
magic, err := buf.Peek(tarHeaderSize) |
| 125 | 125 |
if err != nil && err != io.EOF {
|
| 126 |
- return fmt.Errorf("failed to peek context header from stdin: %v", err)
|
|
| 126 |
+ return fmt.Errorf("failed to peek context header from STDIN: %v", err)
|
|
| 127 | 127 |
} |
| 128 | 128 |
if !archive.IsArchive(magic) {
|
| 129 | 129 |
dockerfile, err := ioutil.ReadAll(buf) |
| 130 | 130 |
if err != nil {
|
| 131 |
- return fmt.Errorf("failed to read Dockerfile from stdin: %v", err)
|
|
| 131 |
+ return fmt.Errorf("failed to read Dockerfile from STDIN: %v", err)
|
|
| 132 | 132 |
} |
| 133 | 133 |
context, err = archive.Generate("Dockerfile", string(dockerfile))
|
| 134 | 134 |
} else {
|
| ... | ... |
@@ -248,7 +248,7 @@ func (cli *DockerCli) CmdBuild(args ...string) error {
|
| 248 | 248 |
|
| 249 | 249 |
// 'docker login': login / register a user to registry service. |
| 250 | 250 |
func (cli *DockerCli) CmdLogin(args ...string) error {
|
| 251 |
- cmd := cli.Subcmd("login", "[OPTIONS] [SERVER]", "Register or Login to a docker registry server, if no server is specified \""+registry.IndexServerAddress()+"\" is the default.")
|
|
| 251 |
+ cmd := cli.Subcmd("login", "[OPTIONS] [SERVER]", "Register or log in to a Docker registry server, if no server is specified \""+registry.IndexServerAddress()+"\" is the default.")
|
|
| 252 | 252 |
|
| 253 | 253 |
var username, password, email string |
| 254 | 254 |
|
| ... | ... |
@@ -374,7 +374,7 @@ func (cli *DockerCli) CmdWait(args ...string) error {
|
| 374 | 374 |
|
| 375 | 375 |
// 'docker version': show version information |
| 376 | 376 |
func (cli *DockerCli) CmdVersion(args ...string) error {
|
| 377 |
- cmd := cli.Subcmd("version", "", "Show the docker version information.")
|
|
| 377 |
+ cmd := cli.Subcmd("version", "", "Show the Docker version information.")
|
|
| 378 | 378 |
if err := cmd.Parse(args); err != nil {
|
| 379 | 379 |
return nil |
| 380 | 380 |
} |
| ... | ... |
@@ -497,8 +497,8 @@ func (cli *DockerCli) CmdInfo(args ...string) error {
|
| 497 | 497 |
} |
| 498 | 498 |
|
| 499 | 499 |
func (cli *DockerCli) CmdStop(args ...string) error {
|
| 500 |
- cmd := cli.Subcmd("stop", "[OPTIONS] CONTAINER [CONTAINER...]", "Stop a running container (Send SIGTERM, and then SIGKILL after grace period)")
|
|
| 501 |
- nSeconds := cmd.Int([]string{"t", "-time"}, 10, "Number of seconds to wait for the container to stop before killing it.")
|
|
| 500 |
+ cmd := cli.Subcmd("stop", "[OPTIONS] CONTAINER [CONTAINER...]", "Stop a running container by sending SIGTERM and then SIGKILL after a grace period")
|
|
| 501 |
+ nSeconds := cmd.Int([]string{"t", "-time"}, 10, "Number of seconds to wait for the container to stop before killing it. Default is 10 seconds.")
|
|
| 502 | 502 |
if err := cmd.Parse(args); err != nil {
|
| 503 | 503 |
return nil |
| 504 | 504 |
} |
| ... | ... |
@@ -525,7 +525,7 @@ func (cli *DockerCli) CmdStop(args ...string) error {
|
| 525 | 525 |
|
| 526 | 526 |
func (cli *DockerCli) CmdRestart(args ...string) error {
|
| 527 | 527 |
cmd := cli.Subcmd("restart", "[OPTIONS] CONTAINER [CONTAINER...]", "Restart a running container")
|
| 528 |
- nSeconds := cmd.Int([]string{"t", "-time"}, 10, "Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default=10")
|
|
| 528 |
+ nSeconds := cmd.Int([]string{"t", "-time"}, 10, "Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default is 10 seconds.")
|
|
| 529 | 529 |
if err := cmd.Parse(args); err != nil {
|
| 530 | 530 |
return nil |
| 531 | 531 |
} |
| ... | ... |
@@ -582,8 +582,8 @@ func (cli *DockerCli) CmdStart(args ...string) error {
|
| 582 | 582 |
tty bool |
| 583 | 583 |
|
| 584 | 584 |
cmd = cli.Subcmd("start", "CONTAINER [CONTAINER...]", "Restart a stopped container")
|
| 585 |
- attach = cmd.Bool([]string{"a", "-attach"}, false, "Attach container's stdout/stderr and forward all signals to the process")
|
|
| 586 |
- openStdin = cmd.Bool([]string{"i", "-interactive"}, false, "Attach container's stdin")
|
|
| 585 |
+ attach = cmd.Bool([]string{"a", "-attach"}, false, "Attach container's STDOUT and STDERR and forward all signals to the process")
|
|
| 586 |
+ openStdin = cmd.Bool([]string{"i", "-interactive"}, false, "Attach container's STDIN")
|
|
| 587 | 587 |
) |
| 588 | 588 |
|
| 589 | 589 |
if err := cmd.Parse(args); err != nil {
|
| ... | ... |
@@ -714,7 +714,7 @@ func (cli *DockerCli) CmdPause(args ...string) error {
|
| 714 | 714 |
} |
| 715 | 715 |
|
| 716 | 716 |
func (cli *DockerCli) CmdInspect(args ...string) error {
|
| 717 |
- cmd := cli.Subcmd("inspect", "CONTAINER|IMAGE [CONTAINER|IMAGE...]", "Return low-level information on a container/image")
|
|
| 717 |
+ cmd := cli.Subcmd("inspect", "CONTAINER|IMAGE [CONTAINER|IMAGE...]", "Return low-level information on a container or image")
|
|
| 718 | 718 |
tmplStr := cmd.String([]string{"f", "#format", "-format"}, "", "Format the output using the given go template.")
|
| 719 | 719 |
if err := cmd.Parse(args); err != nil {
|
| 720 | 720 |
return nil |
| ... | ... |
@@ -794,7 +794,7 @@ func (cli *DockerCli) CmdInspect(args ...string) error {
|
| 794 | 794 |
} |
| 795 | 795 |
|
| 796 | 796 |
func (cli *DockerCli) CmdTop(args ...string) error {
|
| 797 |
- cmd := cli.Subcmd("top", "CONTAINER [ps OPTIONS]", "Lookup the running processes of a container")
|
|
| 797 |
+ cmd := cli.Subcmd("top", "CONTAINER [ps OPTIONS]", "Display the running processes of a container")
|
|
| 798 | 798 |
if err := cmd.Parse(args); err != nil {
|
| 799 | 799 |
return nil |
| 800 | 800 |
} |
| ... | ... |
@@ -829,7 +829,7 @@ func (cli *DockerCli) CmdTop(args ...string) error {
|
| 829 | 829 |
} |
| 830 | 830 |
|
| 831 | 831 |
func (cli *DockerCli) CmdPort(args ...string) error {
|
| 832 |
- cmd := cli.Subcmd("port", "CONTAINER PRIVATE_PORT", "Lookup the public-facing port which is NAT-ed to PRIVATE_PORT")
|
|
| 832 |
+ cmd := cli.Subcmd("port", "CONTAINER PRIVATE_PORT", "Lookup the public-facing port that is NAT-ed to PRIVATE_PORT")
|
|
| 833 | 833 |
if err := cmd.Parse(args); err != nil {
|
| 834 | 834 |
return nil |
| 835 | 835 |
} |
| ... | ... |
@@ -877,7 +877,7 @@ func (cli *DockerCli) CmdPort(args ...string) error {
|
| 877 | 877 |
func (cli *DockerCli) CmdRmi(args ...string) error {
|
| 878 | 878 |
var ( |
| 879 | 879 |
cmd = cli.Subcmd("rmi", "IMAGE [IMAGE...]", "Remove one or more images")
|
| 880 |
- force = cmd.Bool([]string{"f", "-force"}, false, "Force")
|
|
| 880 |
+ force = cmd.Bool([]string{"f", "-force"}, false, "Force removal of the image")
|
|
| 881 | 881 |
noprune = cmd.Bool([]string{"-no-prune"}, false, "Do not delete untagged parents")
|
| 882 | 882 |
) |
| 883 | 883 |
if err := cmd.Parse(args); err != nil {
|
| ... | ... |
@@ -980,7 +980,7 @@ func (cli *DockerCli) CmdHistory(args ...string) error {
|
| 980 | 980 |
|
| 981 | 981 |
func (cli *DockerCli) CmdRm(args ...string) error {
|
| 982 | 982 |
cmd := cli.Subcmd("rm", "[OPTIONS] CONTAINER [CONTAINER...]", "Remove one or more containers")
|
| 983 |
- v := cmd.Bool([]string{"v", "-volumes"}, false, "Remove the volumes associated to the container")
|
|
| 983 |
+ v := cmd.Bool([]string{"v", "-volumes"}, false, "Remove the volumes associated with the container")
|
|
| 984 | 984 |
link := cmd.Bool([]string{"l", "#link", "-link"}, false, "Remove the specified link and not the underlying container")
|
| 985 | 985 |
force := cmd.Bool([]string{"f", "-force"}, false, "Force removal of running container")
|
| 986 | 986 |
|
| ... | ... |
@@ -1017,7 +1017,7 @@ func (cli *DockerCli) CmdRm(args ...string) error {
|
| 1017 | 1017 |
|
| 1018 | 1018 |
// 'docker kill NAME' kills a running container |
| 1019 | 1019 |
func (cli *DockerCli) CmdKill(args ...string) error {
|
| 1020 |
- cmd := cli.Subcmd("kill", "[OPTIONS] CONTAINER [CONTAINER...]", "Kill a running container (send SIGKILL, or specified signal)")
|
|
| 1020 |
+ cmd := cli.Subcmd("kill", "[OPTIONS] CONTAINER [CONTAINER...]", "Kill a running container using SIGKILL or a specified signal")
|
|
| 1021 | 1021 |
signal := cmd.String([]string{"s", "-signal"}, "KILL", "Signal to send to the container")
|
| 1022 | 1022 |
|
| 1023 | 1023 |
if err := cmd.Parse(args); err != nil {
|
| ... | ... |
@@ -1149,7 +1149,7 @@ func (cli *DockerCli) CmdPush(args ...string) error {
|
| 1149 | 1149 |
|
| 1150 | 1150 |
func (cli *DockerCli) CmdPull(args ...string) error {
|
| 1151 | 1151 |
cmd := cli.Subcmd("pull", "NAME[:TAG]", "Pull an image or a repository from the registry")
|
| 1152 |
- tag := cmd.String([]string{"#t", "#-tag"}, "", "Download tagged image in repository")
|
|
| 1152 |
+ tag := cmd.String([]string{"#t", "#-tag"}, "", "Download tagged image in a repository")
|
|
| 1153 | 1153 |
if err := cmd.Parse(args); err != nil {
|
| 1154 | 1154 |
return nil |
| 1155 | 1155 |
} |
| ... | ... |
@@ -1542,7 +1542,7 @@ func (cli *DockerCli) CmdCommit(args ...string) error {
|
| 1542 | 1542 |
flComment := cmd.String([]string{"m", "-message"}, "", "Commit message")
|
| 1543 | 1543 |
flAuthor := cmd.String([]string{"a", "#author", "-author"}, "", "Author (eg. \"John Hannibal Smith <hannibal@a-team.com>\")")
|
| 1544 | 1544 |
// FIXME: --run is deprecated, it will be replaced with inline Dockerfile commands. |
| 1545 |
- flConfig := cmd.String([]string{"#run", "#-run"}, "", "this option is deprecated and will be removed in a future version in favor of inline Dockerfile-compatible commands")
|
|
| 1545 |
+ flConfig := cmd.String([]string{"#run", "#-run"}, "", "This option is deprecated and will be removed in a future version in favor of inline Dockerfile-compatible commands")
|
|
| 1546 | 1546 |
if err := cmd.Parse(args); err != nil {
|
| 1547 | 1547 |
return nil |
| 1548 | 1548 |
} |
| ... | ... |
@@ -1735,8 +1735,8 @@ func (cli *DockerCli) CmdLogs(args ...string) error {
|
| 1735 | 1735 |
func (cli *DockerCli) CmdAttach(args ...string) error {
|
| 1736 | 1736 |
var ( |
| 1737 | 1737 |
cmd = cli.Subcmd("attach", "[OPTIONS] CONTAINER", "Attach to a running container")
|
| 1738 |
- noStdin = cmd.Bool([]string{"#nostdin", "-no-stdin"}, false, "Do not attach stdin")
|
|
| 1739 |
- proxy = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied")
|
|
| 1738 |
+ noStdin = cmd.Bool([]string{"#nostdin", "-no-stdin"}, false, "Do not attach STDIN")
|
|
| 1739 |
+ proxy = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify all received signals to the process (even in non-TTY mode). SIGCHLD is not proxied.")
|
|
| 1740 | 1740 |
) |
| 1741 | 1741 |
|
| 1742 | 1742 |
if err := cmd.Parse(args); err != nil {
|
| ... | ... |
@@ -1807,11 +1807,11 @@ func (cli *DockerCli) CmdAttach(args ...string) error {
|
| 1807 | 1807 |
} |
| 1808 | 1808 |
|
| 1809 | 1809 |
func (cli *DockerCli) CmdSearch(args ...string) error {
|
| 1810 |
- cmd := cli.Subcmd("search", "TERM", "Search the docker index for images")
|
|
| 1810 |
+ cmd := cli.Subcmd("search", "TERM", "Search the Docker Hub for images")
|
|
| 1811 | 1811 |
noTrunc := cmd.Bool([]string{"#notrunc", "-no-trunc"}, false, "Don't truncate output")
|
| 1812 | 1812 |
trusted := cmd.Bool([]string{"#t", "#trusted", "#-trusted"}, false, "Only show trusted builds")
|
| 1813 | 1813 |
automated := cmd.Bool([]string{"-automated"}, false, "Only show automated builds")
|
| 1814 |
- stars := cmd.Int([]string{"s", "#stars", "-stars"}, 0, "Only displays with at least xxx stars")
|
|
| 1814 |
+ stars := cmd.Int([]string{"s", "#stars", "-stars"}, 0, "Only displays with at least x stars")
|
|
| 1815 | 1815 |
if err := cmd.Parse(args); err != nil {
|
| 1816 | 1816 |
return nil |
| 1817 | 1817 |
} |
| ... | ... |
@@ -1938,7 +1938,7 @@ func (cli *DockerCli) CmdRun(args ...string) error {
|
| 1938 | 1938 |
} |
| 1939 | 1939 |
if cidFileInfo.Size() == 0 {
|
| 1940 | 1940 |
if err := os.Remove(hostConfig.ContainerIDFile); err != nil {
|
| 1941 |
- fmt.Printf("failed to remove CID file '%s': %s \n", hostConfig.ContainerIDFile, err)
|
|
| 1941 |
+ fmt.Printf("failed to remove Container ID file '%s': %s \n", hostConfig.ContainerIDFile, err)
|
|
| 1942 | 1942 |
} |
| 1943 | 1943 |
} |
| 1944 | 1944 |
}() |
| ... | ... |
@@ -2188,7 +2188,7 @@ func (cli *DockerCli) CmdCp(args ...string) error {
|
| 2188 | 2188 |
} |
| 2189 | 2189 |
|
| 2190 | 2190 |
func (cli *DockerCli) CmdSave(args ...string) error {
|
| 2191 |
- cmd := cli.Subcmd("save", "IMAGE", "Save an image to a tar archive (streamed to stdout by default)")
|
|
| 2191 |
+ cmd := cli.Subcmd("save", "IMAGE", "Save an image to a tar archive (streamed to STDOUT by default)")
|
|
| 2192 | 2192 |
outfile := cmd.String([]string{"o", "-output"}, "", "Write to an file, instead of STDOUT")
|
| 2193 | 2193 |
|
| 2194 | 2194 |
if err := cmd.Parse(args); err != nil {
|