Browse code

Merge pull request #9144 from miminar/sigproxy_tty

Corrected description of --sig-proxy

Sven Dowideit authored on 2014/11/20 07:52:01
Showing 8 changed files
... ...
@@ -1886,7 +1886,7 @@ func (cli *DockerCli) CmdAttach(args ...string) error {
1886 1886
 	var (
1887 1887
 		cmd     = cli.Subcmd("attach", "CONTAINER", "Attach to a running container")
1888 1888
 		noStdin = cmd.Bool([]string{"#nostdin", "-no-stdin"}, false, "Do not attach STDIN")
1889
-		proxy   = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxy all received signals to the process (even in non-TTY mode). SIGCHLD, SIGKILL, and SIGSTOP are not proxied.")
1889
+		proxy   = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxy all received signals to the process (non-TTY mode only). SIGCHLD, SIGKILL, and SIGSTOP are not proxied.")
1890 1890
 	)
1891 1891
 
1892 1892
 	if err := cmd.Parse(args); err != nil {
... ...
@@ -2210,7 +2210,7 @@ func (cli *DockerCli) CmdRun(args ...string) error {
2210 2210
 	var (
2211 2211
 		flAutoRemove = cmd.Bool([]string{"#rm", "-rm"}, false, "Automatically remove the container when it exits (incompatible with -d)")
2212 2212
 		flDetach     = cmd.Bool([]string{"d", "-detach"}, false, "Detached mode: run the container in the background and print the new container ID")
2213
-		flSigProxy   = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxy received signals to the process (even in non-TTY mode). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.")
2213
+		flSigProxy   = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.")
2214 2214
 		flName       = cmd.String([]string{"#name", "-name"}, "", "Assign a name to the container")
2215 2215
 		flAttach     *opts.ListOpts
2216 2216
 
... ...
@@ -67,7 +67,7 @@ complete -c docker -f -n '__fish_docker_no_subcommand' -s v -l version -d 'Print
67 67
 # attach
68 68
 complete -c docker -f -n '__fish_docker_no_subcommand' -a attach -d 'Attach to a running container'
69 69
 complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -l no-stdin -d 'Do not attach stdin'
70
-complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -l sig-proxy -d 'Proxify all received signal to the process (even in non-tty mode)'
70
+complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -l sig-proxy -d 'Proxify all received signal to the process (non-TTY mode only)'
71 71
 complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -a '(__fish_print_docker_containers running)' -d "Container"
72 72
 
73 73
 # build
... ...
@@ -237,7 +237,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l name -d 'Assign
237 237
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s p -l publish -d "Publish a container's port to the host (format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort) (use 'docker port' to see the actual mapping)"
238 238
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l privileged -d 'Give extended privileges to this container'
239 239
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l rm -d 'Automatically remove the container when it exits (incompatible with -d)'
240
-complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l sig-proxy -d 'Proxify all received signal to the process (even in non-tty mode)'
240
+complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l sig-proxy -d 'Proxify all received signal to the process (non-TTY mode only)'
241 241
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s t -l tty -d 'Allocate a pseudo-tty'
242 242
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s u -l user -d 'Username or UID'
243 243
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s v -l volume -d 'Bind mount a volume (e.g. from the host: -v /host:/container, from docker: -v /container)'
... ...
@@ -190,7 +190,7 @@ __docker_subcommand () {
190 190
         (attach)
191 191
             _arguments \
192 192
                 '--no-stdin[Do not attach stdin]' \
193
-                '--sig-proxy[Proxify all received signal]' \
193
+                '--sig-proxy[Proxy all received signals to the process (non-TTY mode only)]' \
194 194
                 ':containers:__docker_runningcontainers'
195 195
             ;;
196 196
         (build)
... ...
@@ -396,7 +396,7 @@ __docker_subcommand () {
396 396
                 '--restart=-[Restart policy]:restart policy:(no on-failure always)' \
397 397
                 '--rm[Remove intermediate containers when it exits]' \
398 398
                 '*--security-opt=-[Security options]:security option: ' \
399
-                '--sig-proxy[Proxify all received signal]' \
399
+                '--sig-proxy[Proxy all received signals to the process (non-TTY mode only)]' \
400 400
                 {-t,--tty}'[Allocate a pseudo-tty]' \
401 401
                 {-u,--user=-}'[Username or UID]:user:_users' \
402 402
                 '*-v[Bind mount a volume]:volume: '\
... ...
@@ -25,7 +25,7 @@ the client.
25 25
    Do not attach STDIN. The default is *false*.
26 26
 
27 27
 **--sig-proxy**=*true*|*false*
28
-   Proxy all received signals to the process (even in non-TTY mode). SIGCHLD, SIGKILL, and SIGSTOP are not proxied. The default is *true*.
28
+   Proxy all received signals to the process (non-TTY mode only). SIGCHLD, SIGKILL, and SIGSTOP are not proxied. The default is *true*.
29 29
 
30 30
 # EXAMPLES
31 31
 
... ...
@@ -233,7 +233,7 @@ outside of a container on the host.
233 233
    Automatically remove the container when it exits (incompatible with -d). The default is *false*.
234 234
 
235 235
 **--sig-proxy**=*true*|*false*
236
-   Proxy received signals to the process (even in non-TTY mode). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*.
236
+   Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*.
237 237
 
238 238
 **-t**, **--tty**=*true*|*false*
239 239
    When set to true Docker can allocate a pseudo-tty and attach to the standard
... ...
@@ -249,7 +249,7 @@ Docker supports softlinks for the Docker data directory
249 249
     Attach to a running container
250 250
 
251 251
       --no-stdin=false    Do not attach STDIN
252
-      --sig-proxy=true    Proxy all received signals to the process (even in non-TTY mode). SIGCHLD, SIGKILL, and SIGSTOP are not proxied.
252
+      --sig-proxy=true    Proxy all received signals to the process (non-TTY mode only). SIGCHLD, SIGKILL, and SIGSTOP are not proxied.
253 253
 
254 254
 The `attach` command lets you view or interact with any running container's
255 255
 primary process (`pid 1`).
... ...
@@ -1265,7 +1265,7 @@ removed before the image is removed.
1265 1265
       --privileged=false         Give extended privileges to this container
1266 1266
       --restart=""               Restart policy to apply when a container exits (no, on-failure[:max-retry], always)
1267 1267
       --rm=false                 Automatically remove the container when it exits (incompatible with -d)
1268
-      --sig-proxy=true           Proxy received signals to the process (even in non-TTY mode). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.
1268
+      --sig-proxy=true           Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.
1269 1269
       -t, --tty=false            Allocate a pseudo-TTY
1270 1270
       -u, --user=""              Username or UID
1271 1271
       -v, --volume=[]            Bind mount a volume (e.g., from the host: -v /host:/container, from Docker: -v /container)
... ...
@@ -83,7 +83,7 @@ and pass along signals. All of that is configurable:
83 83
 
84 84
     -a=[]           : Attach to `STDIN`, `STDOUT` and/or `STDERR`
85 85
     -t=false        : Allocate a pseudo-tty
86
-    --sig-proxy=true: Proxify all received signal to the process (even in non-tty mode)
86
+    --sig-proxy=true: Proxify all received signal to the process (non-TTY mode only)
87 87
     -i=false        : Keep STDIN open even if not attached
88 88
 
89 89
 If you do not specify `-a` then Docker will [attach all standard
... ...
@@ -85,7 +85,7 @@ This will display the help text and all available flags:
85 85
     Attach to a running container
86 86
 
87 87
       --no-stdin=false: Do not attach stdin
88
-      --sig-proxy=true: Proxify all received signal to the process (even in non-tty mode)
88
+      --sig-proxy=true: Proxify all received signal to the process (non-TTY mode only)
89 89
 
90 90
 > **Note:** 
91 91
 > You can see a full list of Docker's commands