diff options
Diffstat (limited to 'docs/source/markdown/podman-attach.1.md.in')
| -rw-r--r-- | docs/source/markdown/podman-attach.1.md.in | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-attach.1.md.in b/docs/source/markdown/podman-attach.1.md.in new file mode 100644 index 000000000..427f764dc --- /dev/null +++ b/docs/source/markdown/podman-attach.1.md.in @@ -0,0 +1,57 @@ +% podman-attach 1 + +## NAME +podman\-attach - Attach to a running container + +## SYNOPSIS +**podman attach** [*options*] *container* + +**podman container attach** [*options*] *container* + +## DESCRIPTION +**podman attach** attaches to a running *container* using the *container's name* or *ID*, to either view its ongoing output or to control it interactively.\ +The *container* can be detached from (and leave it running) using a configurable key sequence. The default sequence is `ctrl-p,ctrl-q`. Configure the keys sequence using the **--detach-keys** OPTION, or specifying it in the `containers.conf` file: see **[containers.conf(5)](https://github.com/containers/common/blob/master/docs/containers.conf.5.md)** for more information. + +## OPTIONS +#### **--detach-keys**=**sequence** + +Specify the key **sequence** for detaching a *container*. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature.\ +The default is `ctrl-p,ctrl-q`. + +#### **--latest**, **-l** + +Instead of providing the *container ID* or *name*, use the last created *container*. If other methods than Podman are used to run *containers* such as `CRI-O`, the last started *container* could be from either of those methods.\ +The default is **false**.\ +*IMPORTANT: This OPTION is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines. This OPTION does not need a container name or ID as input argument.* + +#### **--no-stdin** + +Do not attach STDIN. The default is **false**. + +@@option sig-proxy + +The default is **true**. + +## EXAMPLES +Attach to a container called "foobar". +``` +$ podman attach foobar +``` + +Attach to the latest created container. +``` +$ podman attach --latest +``` + +Attach to a container that start with the ID "1234". +``` +$ podman attach 1234 +``` + +Attach to a container without attaching STDIN. +``` +$ podman attach --no-stdin foobar +``` + +## SEE ALSO +**[podman(1)](podman.1.md)**, **[podman-exec(1)](podman-exec.1.md)**, **[podman-run(1)](podman-run.1.md)**, **[containers.conf(5)](https://github.com/containers/common/blob/master/docs/containers.conf.5.md)** |