Sebastiaan van Stijn
f118c05e87
Also adds a named anchor, so that the section gets linked from the
options table.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit c17b0df2a5)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
60 lines
2.6 KiB
Markdown
60 lines
2.6 KiB
Markdown
The **docker attach** command allows you to attach to a running container using
|
|
the container's ID or name, either to view its ongoing output or to control it
|
|
interactively. You can attach to the same contained process multiple times
|
|
simultaneously, screen sharing style, or quickly view the progress of your
|
|
detached process.
|
|
|
|
To stop a container, use `CTRL-c`. This key sequence sends **SIGKILL** to the
|
|
container. You can detach from the container (and leave it running) using a
|
|
configurable key sequence. The default sequence is `CTRL-p CTRL-q`. You
|
|
configure the key sequence using the **--detach-keys** option or a configuration
|
|
file. See **config-json(5)** for documentation on using a configuration file.
|
|
|
|
It is forbidden to redirect the standard input of a **docker attach** command while
|
|
attaching to a TTY-enabled container (i.e., launched with `-i` and `-t`).
|
|
|
|
# EXAMPLES
|
|
|
|
## Attaching to a container
|
|
|
|
In this example the top command is run inside a container from an ubuntu image,
|
|
in detached mode, then attaches to it, and then terminates the container
|
|
with `CTRL-c`:
|
|
|
|
$ docker run -d --name topdemo ubuntu:20.04 /usr/bin/top -b
|
|
$ docker attach topdemo
|
|
top - 00:07:01 up 4:54, 0 users, load average: 0.83, 0.91, 0.82
|
|
Tasks: 1 total, 1 running, 0 sleeping, 0 stopped, 0 zombie
|
|
%Cpu(s): 2.3 us, 1.6 sy, 0.0 ni, 95.9 id, 0.0 wa, 0.1 hi, 0.1 si, 0.0 st
|
|
MiB Mem : 15846.2 total, 5729.2 free, 2592.5 used, 7524.4 buff/cache
|
|
MiB Swap: 16384.0 total, 16384.0 free, 0.0 used. 12097.3 avail Mem
|
|
|
|
PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND
|
|
1 root 20 0 5976 3256 2828 R 0.0 0.0 0:00.04 top
|
|
^C
|
|
|
|
## Override the detach sequence
|
|
|
|
Use the **--detach-keys** option to override the Docker key sequence for detach.
|
|
This is useful if the Docker default sequence conflicts with key sequence you
|
|
use for other applications. There are two ways to define your own detach key
|
|
sequence, as a per-container override or as a configuration property on your
|
|
entire configuration.
|
|
|
|
To override the sequence for an individual container, use the
|
|
**--detach-keys**=*key* flag with the **docker attach** command. The format of
|
|
the *key* is either a letter [a-Z], or the **ctrl**-*value*, where *value* is one
|
|
of the following:
|
|
|
|
* **a-z** (a single lowercase alpha character )
|
|
* **@** (at sign)
|
|
* **[** (left bracket)
|
|
* **\\\\** (two backward slashes)
|
|
* **_** (underscore)
|
|
* **^** (caret)
|
|
|
|
These **a**, **ctrl-a**, **X**, or **ctrl-\\** values are all examples of valid key
|
|
sequences. To configure a different configuration default key sequence for all
|
|
containers, see **docker(1)**.
|
|
|