Corrected description of --sig-proxy
Signal proxy does work only in non-TTY mode (--tty=false). Man pages and commands should not lie about it. Signed-off-by: Michal Minar <miminar@redhat.com>
This commit is contained in:
parent
42861f3b45
commit
e71f241c4b
|
@ -1867,7 +1867,7 @@ func (cli *DockerCli) CmdAttach(args ...string) error {
|
||||||
var (
|
var (
|
||||||
cmd = cli.Subcmd("attach", "CONTAINER", "Attach to a running container")
|
cmd = cli.Subcmd("attach", "CONTAINER", "Attach to a running container")
|
||||||
noStdin = cmd.Bool([]string{"#nostdin", "-no-stdin"}, false, "Do not attach STDIN")
|
noStdin = cmd.Bool([]string{"#nostdin", "-no-stdin"}, false, "Do not attach STDIN")
|
||||||
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.")
|
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.")
|
||||||
)
|
)
|
||||||
|
|
||||||
if err := cmd.Parse(args); err != nil {
|
if err := cmd.Parse(args); err != nil {
|
||||||
|
@ -2191,7 +2191,7 @@ func (cli *DockerCli) CmdRun(args ...string) error {
|
||||||
var (
|
var (
|
||||||
flAutoRemove = cmd.Bool([]string{"#rm", "-rm"}, false, "Automatically remove the container when it exits (incompatible with -d)")
|
flAutoRemove = cmd.Bool([]string{"#rm", "-rm"}, false, "Automatically remove the container when it exits (incompatible with -d)")
|
||||||
flDetach = cmd.Bool([]string{"d", "-detach"}, false, "Detached mode: run the container in the background and print the new container ID")
|
flDetach = cmd.Bool([]string{"d", "-detach"}, false, "Detached mode: run the container in the background and print the new container ID")
|
||||||
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.")
|
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.")
|
||||||
flName = cmd.String([]string{"#name", "-name"}, "", "Assign a name to the container")
|
flName = cmd.String([]string{"#name", "-name"}, "", "Assign a name to the container")
|
||||||
flAttach *opts.ListOpts
|
flAttach *opts.ListOpts
|
||||||
|
|
||||||
|
|
|
@ -67,7 +67,7 @@ complete -c docker -f -n '__fish_docker_no_subcommand' -s v -l version -d 'Print
|
||||||
# attach
|
# attach
|
||||||
complete -c docker -f -n '__fish_docker_no_subcommand' -a attach -d 'Attach to a running container'
|
complete -c docker -f -n '__fish_docker_no_subcommand' -a attach -d 'Attach to a running container'
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -l no-stdin -d 'Do not attach stdin'
|
complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -l no-stdin -d 'Do not attach stdin'
|
||||||
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)'
|
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)'
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -a '(__fish_print_docker_containers running)' -d "Container"
|
complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -a '(__fish_print_docker_containers running)' -d "Container"
|
||||||
|
|
||||||
# build
|
# build
|
||||||
|
@ -237,7 +237,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l name -d 'Assign
|
||||||
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)"
|
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)"
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l privileged -d 'Give extended privileges to this container'
|
complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l privileged -d 'Give extended privileges to this container'
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l rm -d 'Automatically remove the container when it exits (incompatible with -d)'
|
complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l rm -d 'Automatically remove the container when it exits (incompatible with -d)'
|
||||||
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)'
|
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)'
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s t -l tty -d 'Allocate a pseudo-tty'
|
complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s t -l tty -d 'Allocate a pseudo-tty'
|
||||||
complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s u -l user -d 'Username or UID'
|
complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s u -l user -d 'Username or UID'
|
||||||
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)'
|
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)'
|
||||||
|
|
|
@ -25,7 +25,7 @@ the client.
|
||||||
Do not attach STDIN. The default is *false*.
|
Do not attach STDIN. The default is *false*.
|
||||||
|
|
||||||
**--sig-proxy**=*true*|*false*
|
**--sig-proxy**=*true*|*false*
|
||||||
Proxy all received signals to the process (even in non-TTY mode). SIGCHLD, SIGKILL, and SIGSTOP are not proxied. The default is *true*.
|
Proxy all received signals to the process (non-TTY mode only). SIGCHLD, SIGKILL, and SIGSTOP are not proxied. The default is *true*.
|
||||||
|
|
||||||
# EXAMPLES
|
# EXAMPLES
|
||||||
|
|
||||||
|
|
|
@ -225,7 +225,7 @@ outside of a container on the host.
|
||||||
Automatically remove the container when it exits (incompatible with -d). The default is *false*.
|
Automatically remove the container when it exits (incompatible with -d). The default is *false*.
|
||||||
|
|
||||||
**--sig-proxy**=*true*|*false*
|
**--sig-proxy**=*true*|*false*
|
||||||
Proxy received signals to the process (even in non-TTY mode). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*.
|
Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*.
|
||||||
|
|
||||||
**-t**, **--tty**=*true*|*false*
|
**-t**, **--tty**=*true*|*false*
|
||||||
When set to true Docker can allocate a pseudo-tty and attach to the standard
|
When set to true Docker can allocate a pseudo-tty and attach to the standard
|
||||||
|
|
|
@ -227,7 +227,7 @@ Docker supports softlinks for the Docker data directory
|
||||||
Attach to a running container
|
Attach to a running container
|
||||||
|
|
||||||
--no-stdin=false Do not attach STDIN
|
--no-stdin=false Do not attach STDIN
|
||||||
--sig-proxy=true Proxy all received signals to the process (even in non-TTY mode). SIGCHLD, SIGKILL, and SIGSTOP are not proxied.
|
--sig-proxy=true Proxy all received signals to the process (non-TTY mode only). SIGCHLD, SIGKILL, and SIGSTOP are not proxied.
|
||||||
|
|
||||||
The `attach` command lets you view or interact with any running container's
|
The `attach` command lets you view or interact with any running container's
|
||||||
primary process (`pid 1`).
|
primary process (`pid 1`).
|
||||||
|
@ -1243,7 +1243,7 @@ removed before the image is removed.
|
||||||
--privileged=false Give extended privileges to this container
|
--privileged=false Give extended privileges to this container
|
||||||
--restart="" Restart policy to apply when a container exits (no, on-failure[:max-retry], always)
|
--restart="" Restart policy to apply when a container exits (no, on-failure[:max-retry], always)
|
||||||
--rm=false Automatically remove the container when it exits (incompatible with -d)
|
--rm=false Automatically remove the container when it exits (incompatible with -d)
|
||||||
--sig-proxy=true Proxy received signals to the process (even in non-TTY mode). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.
|
--sig-proxy=true Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.
|
||||||
-t, --tty=false Allocate a pseudo-TTY
|
-t, --tty=false Allocate a pseudo-TTY
|
||||||
-u, --user="" Username or UID
|
-u, --user="" Username or UID
|
||||||
-v, --volume=[] Bind mount a volume (e.g., from the host: -v /host:/container, from Docker: -v /container)
|
-v, --volume=[] Bind mount a volume (e.g., from the host: -v /host:/container, from Docker: -v /container)
|
||||||
|
|
|
@ -82,7 +82,7 @@ and pass along signals. All of that is configurable:
|
||||||
|
|
||||||
-a=[] : Attach to `STDIN`, `STDOUT` and/or `STDERR`
|
-a=[] : Attach to `STDIN`, `STDOUT` and/or `STDERR`
|
||||||
-t=false : Allocate a pseudo-tty
|
-t=false : Allocate a pseudo-tty
|
||||||
--sig-proxy=true: Proxify all received signal to the process (even in non-tty mode)
|
--sig-proxy=true: Proxify all received signal to the process (non-TTY mode only)
|
||||||
-i=false : Keep STDIN open even if not attached
|
-i=false : Keep STDIN open even if not attached
|
||||||
|
|
||||||
If you do not specify `-a` then Docker will [attach all standard
|
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:
|
||||||
Attach to a running container
|
Attach to a running container
|
||||||
|
|
||||||
--no-stdin=false: Do not attach stdin
|
--no-stdin=false: Do not attach stdin
|
||||||
--sig-proxy=true: Proxify all received signal to the process (even in non-tty mode)
|
--sig-proxy=true: Proxify all received signal to the process (non-TTY mode only)
|
||||||
|
|
||||||
> **Note:**
|
> **Note:**
|
||||||
> You can see a full list of Docker's commands
|
> You can see a full list of Docker's commands
|
||||||
|
|
Loading…
Reference in New Issue