podman/docs/podman-attach.1.md
W. Trevor King f2462ca59e docs: Follow man-pages(7) suggestions for SYNOPSIS
man-pages(7) has [1]:

> For commands, this shows the syntax of the command and its arguments
> (including options); boldface is used for as-is text and italics are
> used to indicate replaceable arguments. Brackets ([]) surround
> optional arguments, vertical bars (|) separate choices, and ellipses
> (...) can be repeated.

I've adjusted our SYNOPSIS entries to match that formatting, and
generally tried to make them more consistent with the precedent set by
the man-pages project.  Outside of the SYNOPSIS entry, I prefer using
backticks for literals, although in some places I've left the **
bolding to keep things visually similar to a nearby SYNOPSIS entry.

[1]: http://man7.org/linux/man-pages/man7/man-pages.7.html

Signed-off-by: W. Trevor King <wking@tremily.us>

Closes: #1027
Approved by: rhatdan
2018-07-04 09:40:37 +00:00

1.4 KiB

% podman-attach "1"

NAME

podman-attach - Attach to a running container

SYNOPSIS

podman attach [options] container

DESCRIPTION

The 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 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

OPTIONS

--detach-keys

Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-[value] where [value] is one of: a-z, @, ^, [, , or _.

--latest, -l

Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods.

--no-stdin

Do not attach STDIN. The default is false.

--sig-proxy=true|false

Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is true.

EXAMPLES

podman attach foobar
[root@localhost /]#
podman attach --latest
[root@localhost /]#
podman attach 1234
[root@localhost /]#
podman attach --no-stdin foobar

SEE ALSO

podman(1), podman-exec(1), podman-run(1)