From 45a61b38bf992b93548a3956e53ba2f6bf4224ba Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Mon, 26 Jun 2023 20:35:07 +0200 Subject: [PATCH] engine: refresh cli reference (24.0) Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- _data/engine-cli/docker_attach.yaml | 49 +++++++++++++++-------------- _data/engine-cli/docker_run.yaml | 31 ++++++++++++++++-- 2 files changed, 54 insertions(+), 26 deletions(-) diff --git a/_data/engine-cli/docker_attach.yaml b/_data/engine-cli/docker_attach.yaml index ef581befac..73e97b7936 100644 --- a/_data/engine-cli/docker_attach.yaml +++ b/_data/engine-cli/docker_attach.yaml @@ -38,30 +38,6 @@ long: |- performance critical applications that generate a lot of output in the foreground over a slow client connection. Instead, users should use the `docker logs` command to get access to the logs. - - ### Override the detach sequence - - If you want, you can configure an 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=""` flag with the `docker attach` command. The format of - the `` is either a letter [a-Z], or the `ctrl-` combined with any 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 [**Configuration file** section](cli.md#configuration-files). usage: docker attach [OPTIONS] CONTAINER pname: docker plink: docker.yaml @@ -69,6 +45,7 @@ options: - option: detach-keys value_type: string description: Override the key sequence for detaching a container + details_url: '#detach-keys' deprecated: false hidden: false experimental: false @@ -193,6 +170,30 @@ examples: |- CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES a2fe3fd886db alpine "/bin/sh" About a minute ago Exited (13) 40 seconds ago test ``` + + ### Override the detach sequence (--detach-keys) {#detach-keys} + + 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=""` flag with the `docker attach` command. The format of + the `` is either a letter [a-Z], or the `ctrl-` combined with any 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 [**Configuration file** section](cli.md#configuration-files). deprecated: false experimental: false experimentalcli: false diff --git a/_data/engine-cli/docker_run.yaml b/_data/engine-cli/docker_run.yaml index 8c63510574..a2cdde234d 100644 --- a/_data/engine-cli/docker_run.yaml +++ b/_data/engine-cli/docker_run.yaml @@ -233,6 +233,7 @@ options: - option: detach-keys value_type: string description: Override the key sequence for detaching a container + details_url: '#detach-keys' deprecated: false hidden: false experimental: false @@ -1428,10 +1429,12 @@ examples: |- ``` You can also choose the IP addresses for the container with `--ip` and `--ip6` - flags when you start the container on a user-defined network. + flags when you start the container on a user-defined network. To assign a + static IP to containers, you must specify subnet block for the network. ```console - $ docker run -itd --network=my-net --ip=10.10.9.75 busybox + $ docker network create --subnet 192.0.2.0/24 my-net + $ docker run -itd --network=my-net --ip=192.0.2.69 busybox ``` If you want to add a running container to a network use the `docker network connect` subcommand. @@ -1512,6 +1515,30 @@ examples: |- See also [the `docker cp` command](cp.md). + ### Override the detach sequence (--detach-keys) {#detach-keys} + + 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=""` flag with the `docker attach` command. The format of + the `` is either a letter [a-Z], or the `ctrl-` combined with any 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 [**Configuration file** section](cli.md#configuration-files). + ### Add host device to container (--device) {#device} ```console