Merge pull request #6544 from mheon/sigproxy_docs
Update --sig-proxy documentation
This commit is contained in:
commit
b4df555d27
|
@ -1733,7 +1733,7 @@ func (cli *DockerCli) CmdAttach(args ...string) error {
|
||||||
var (
|
var (
|
||||||
cmd = cli.Subcmd("attach", "[OPTIONS] CONTAINER", "Attach to a running container")
|
cmd = cli.Subcmd("attach", "[OPTIONS] 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, "Proxify all received signal to the process (even in non-tty mode)")
|
proxy = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied")
|
||||||
)
|
)
|
||||||
|
|
||||||
if err := cmd.Parse(args); err != nil {
|
if err := cmd.Parse(args); err != nil {
|
||||||
|
|
|
@ -22,8 +22,8 @@ the client.
|
||||||
When set to true, do not attach to stdin. The default is *false*.
|
When set to true, do not attach to stdin. The default is *false*.
|
||||||
|
|
||||||
**--sig-proxy**=*true*|*false*:
|
**--sig-proxy**=*true*|*false*:
|
||||||
When set to true, proxify all received signal to the process (even in non-tty
|
When set to true, proxify received signals to the process (even in non-tty
|
||||||
mode). The default is *true*.
|
mode). SIGCHLD is not proxied. The default is *true*.
|
||||||
|
|
||||||
# EXAMPLES
|
# EXAMPLES
|
||||||
|
|
||||||
|
|
|
@ -181,8 +181,8 @@ default is *false*. This option is incompatible with **-d**.
|
||||||
|
|
||||||
|
|
||||||
**--sig-proxy**=*true*|*false*
|
**--sig-proxy**=*true*|*false*
|
||||||
When set to true, proxify all received signals to the process (even in
|
When set to true, proxify received signals to the process (even in
|
||||||
non-tty mode). The default is true.
|
non-tty mode). SIGCHLD is not proxied. The default is *true*.
|
||||||
|
|
||||||
|
|
||||||
**-t**, **-tty**=*true*|*false*
|
**-t**, **-tty**=*true*|*false*
|
||||||
|
|
|
@ -135,7 +135,7 @@ like this:
|
||||||
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 received signals to the process (even in non-tty mode). SIGCHLD is not proxied.
|
||||||
|
|
||||||
The `attach` command will allow you to view or
|
The `attach` command will allow you to view or
|
||||||
interact with any running container, detached (`-d`)
|
interact with any running container, detached (`-d`)
|
||||||
|
@ -928,7 +928,7 @@ removed before the image is removed.
|
||||||
-P, --publish-all=false Publish all exposed ports to the host interfaces
|
-P, --publish-all=false Publish all exposed ports to the host interfaces
|
||||||
--privileged=false Give extended privileges to this container
|
--privileged=false Give extended privileges to this container
|
||||||
--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 Proxify all received signal to the process (even in non-tty mode)
|
--sig-proxy=true Proxify received signals to the process (even in non-tty mode). SIGCHLD is 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)
|
||||||
|
|
|
@ -67,7 +67,7 @@ func parseRun(cmd *flag.FlagSet, args []string, sysInfo *sysinfo.SysInfo) (*Conf
|
||||||
flCpuset = cmd.String([]string{"-cpuset"}, "", "CPUs in which to allow execution (0-3, 0,1)")
|
flCpuset = cmd.String([]string{"-cpuset"}, "", "CPUs in which to allow execution (0-3, 0,1)")
|
||||||
flNetMode = cmd.String([]string{"-net"}, "bridge", "Set the Network mode for the container\n'bridge': creates a new network stack for the container on the docker bridge\n'none': no networking for this container\n'container:<name|id>': reuses another container network stack\n'host': use the host network stack inside the container. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.")
|
flNetMode = cmd.String([]string{"-net"}, "bridge", "Set the Network mode for the container\n'bridge': creates a new network stack for the container on the docker bridge\n'none': no networking for this container\n'container:<name|id>': reuses another container network stack\n'host': use the host network stack inside the container. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.")
|
||||||
// For documentation purpose
|
// For documentation purpose
|
||||||
_ = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify all received signal to the process (even in non-tty mode)")
|
_ = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied.")
|
||||||
_ = cmd.String([]string{"#name", "-name"}, "", "Assign a name to the container")
|
_ = cmd.String([]string{"#name", "-name"}, "", "Assign a name to the container")
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue