summaryrefslogtreecommitdiff
path: root/docs/podman-attach.1.md
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2017-12-15 16:58:36 -0500
committerAtomic Bot <atomic-devel@projectatomic.io>2017-12-18 16:46:05 +0000
commit5770dc2640c216525ab84031e3712fcc46b3b087 (patch)
tree8a1c5c4e4a6ce6a35a3767247623a62bfd698f77 /docs/podman-attach.1.md
parentde3468e120d489d046c08dad72ba2262e222ccb1 (diff)
downloadpodman-5770dc2640c216525ab84031e3712fcc46b3b087.tar.gz
podman-5770dc2640c216525ab84031e3712fcc46b3b087.tar.bz2
podman-5770dc2640c216525ab84031e3712fcc46b3b087.zip
Rename all references to kpod to podman
The decision is in, kpod is going to be named podman. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #145 Approved by: umohnani8
Diffstat (limited to 'docs/podman-attach.1.md')
-rw-r--r--docs/podman-attach.1.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/podman-attach.1.md b/docs/podman-attach.1.md
new file mode 100644
index 000000000..ddb59e553
--- /dev/null
+++ b/docs/podman-attach.1.md
@@ -0,0 +1,40 @@
+% podman(1) podman-attach - See the output of pid 1 of a container or enter the container
+% Dan Walsh
+# podman-attach "1" "December 2017" "podman"
+
+## 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 _.
+
+**--no-stdin**
+Do not attach STDIN. The default is false.
+
+## EXAMPLES ##
+
+```
+podman attach foobar
+[root@localhost /]#
+```
+```
+podman attach 1234
+[root@localhost /]#
+```
+```
+podman attach --no-stdin foobar
+```
+## SEE ALSO
+podman(1), podman-exec(1), podman-run(1)