Browse code

Clarify meaning of docker attach

Signed-off-by: Misty Stanley-Jones <misty@docker.com>

Misty Stanley-Jones authored on 2017/04/01 05:22:21
Showing 2 changed files
... ...
@@ -28,7 +28,7 @@ func NewAttachCommand(dockerCli *command.DockerCli) *cobra.Command {
28 28
 
29 29
 	cmd := &cobra.Command{
30 30
 		Use:   "attach [OPTIONS] CONTAINER",
31
-		Short: "Attach to a running container",
31
+		Short: "Attach local standard input, output, and error streams to a running container",
32 32
 		Args:  cli.ExactArgs(1),
33 33
 		RunE: func(cmd *cobra.Command, args []string) error {
34 34
 			opts.container = args[0]
... ...
@@ -18,7 +18,7 @@ keywords: "attach, running, container"
18 18
 ```markdown
19 19
 Usage: docker attach [OPTIONS] CONTAINER
20 20
 
21
-Attach to a running container
21
+Attach local standard input, output, and error streams to a running container
22 22
 
23 23
 Options:
24 24
       --detach-keys string   Override the key sequence for detaching a container
... ...
@@ -29,10 +29,13 @@ Options:
29 29
 
30 30
 ## Description
31 31
 
32
-Use `docker attach` to attach to a running container using the container's ID
33
-or name, either to view its ongoing output or to control it interactively.
32
+Use `docker attach` to attach your terminal's standard input, output, and error
33
+(or any combination of the three) to a running container using the container's
34
+ID or name. This allows you to view its ongoing output or to control it
35
+interactively, as though the commands were running directly in your terminal.
36
+
34 37
 You can attach to the same contained process multiple times simultaneously,
35
-screen sharing style, or quickly view the progress of your detached process.
38
+even as a different user with the appropriate permissions.
36 39
 
37 40
 To stop a container, use `CTRL-c`. This key sequence sends `SIGKILL` to the
38 41
 container. If `--sig-proxy` is true (the default),`CTRL-c` sends a `SIGINT` to