From f29a765573ecd1ad31d50fc51ddf696da7d68705 Mon Sep 17 00:00:00 2001 From: Jhon Honce <jhonce@redhat.com> Date: Wed, 13 Mar 2019 14:16:37 -0700 Subject: Corrected detach man pages and code comments * Updated documentation to match code Signed-off-by: Jhon Honce <jhonce@redhat.com> --- docs/podman-attach.1.md | 7 +++---- docs/podman-create.1.md | 4 ++-- docs/podman-run.1.md | 2 +- docs/podman-start.1.md | 3 +-- 4 files changed, 7 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/podman-attach.1.md b/docs/podman-attach.1.md index ceb945a0e..11cecc16c 100644 --- a/docs/podman-attach.1.md +++ b/docs/podman-attach.1.md @@ -11,13 +11,12 @@ The attach command allows you to attach to a running container using the contain 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 +sequence is `ctrl-p,ctrl-q`. You configure the key sequence using the --detach-keys option ## OPTIONS -**--detach-keys** +**--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 _. +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** diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md index b4f097348..2e176db76 100644 --- a/docs/podman-create.1.md +++ b/docs/podman-create.1.md @@ -167,13 +167,13 @@ the other shell to view a list of the running containers. You can reattach to a detached container with **podman attach**. When attached in the tty mode, you can detach from the container (and leave it -running) using a configurable key sequence. The default sequence is `CTRL-p CTRL-q`. +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. **--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 `_`. +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 `_`. **--device**=[] diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md index 1eb866773..fe98e43ca 100644 --- a/docs/podman-run.1.md +++ b/docs/podman-run.1.md @@ -173,7 +173,7 @@ the other shell to view a list of the running containers. You can reattach to a detached container with **podman attach**. When attached in the tty mode, you can detach from the container (and leave it -running) using a configurable key sequence. The default sequence is `CTRL-p CTRL-q`. +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. diff --git a/docs/podman-start.1.md b/docs/podman-start.1.md index b0167003e..aa5362046 100644 --- a/docs/podman-start.1.md +++ b/docs/podman-start.1.md @@ -21,8 +21,7 @@ starting multiple containers. **--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 _. +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 `_`. **--interactive, -i** -- cgit v1.2.3-54-g00ecf