Ver Fonte

make docs

Signed-off-by: Wes Higbee <[email protected]>
Wes Higbee há 1 ano atrás
pai
commit
5f4b22ed7c

+ 32 - 31
docs/reference/compose.md

@@ -5,37 +5,38 @@ Define and run multi-container applications with Docker.
 
 ### Subcommands
 
-| Name                            | Description                                                                           |
-|:--------------------------------|:--------------------------------------------------------------------------------------|
-| [`build`](compose_build.md)     | Build or rebuild services                                                             |
-| [`config`](compose_config.md)   | Parse, resolve and render compose file in canonical format                            |
-| [`cp`](compose_cp.md)           | Copy files/folders between a service container and the local filesystem               |
-| [`create`](compose_create.md)   | Creates containers for a service.                                                     |
-| [`down`](compose_down.md)       | Stop and remove containers, networks                                                  |
-| [`events`](compose_events.md)   | Receive real time events from containers.                                             |
-| [`exec`](compose_exec.md)       | Execute a command in a running container.                                             |
-| [`images`](compose_images.md)   | List images used by the created containers                                            |
-| [`kill`](compose_kill.md)       | Force stop service containers.                                                        |
-| [`logs`](compose_logs.md)       | View output from containers                                                           |
-| [`ls`](compose_ls.md)           | List running compose projects                                                         |
-| [`pause`](compose_pause.md)     | Pause services                                                                        |
-| [`port`](compose_port.md)       | Print the public port for a port binding.                                             |
-| [`ps`](compose_ps.md)           | List containers                                                                       |
-| [`pull`](compose_pull.md)       | Pull service images                                                                   |
-| [`push`](compose_push.md)       | Push service images                                                                   |
-| [`restart`](compose_restart.md) | Restart service containers                                                            |
-| [`rm`](compose_rm.md)           | Removes stopped service containers                                                    |
-| [`run`](compose_run.md)         | Run a one-off command on a service.                                                   |
-| [`scale`](compose_scale.md)     | Scale services                                                                        |
-| [`start`](compose_start.md)     | Start services                                                                        |
-| [`stats`](compose_stats.md)     | Display a live stream of container(s) resource usage statistics                       |
-| [`stop`](compose_stop.md)       | Stop services                                                                         |
-| [`top`](compose_top.md)         | Display the running processes                                                         |
-| [`unpause`](compose_unpause.md) | Unpause services                                                                      |
-| [`up`](compose_up.md)           | Create and start containers                                                           |
-| [`version`](compose_version.md) | Show the Docker Compose version information                                           |
-| [`wait`](compose_wait.md)       | Block until the first service container stops                                         |
-| [`watch`](compose_watch.md)     | Watch build context for service and rebuild/refresh containers when files are updated |
+| Name                            | Description                                                                              |
+|:--------------------------------|:-----------------------------------------------------------------------------------------|
+| [`attach`](compose_attach.md)   | Attach local standard input, output, and error streams to a service's running container. |
+| [`build`](compose_build.md)     | Build or rebuild services                                                                |
+| [`config`](compose_config.md)   | Parse, resolve and render compose file in canonical format                               |
+| [`cp`](compose_cp.md)           | Copy files/folders between a service container and the local filesystem                  |
+| [`create`](compose_create.md)   | Creates containers for a service.                                                        |
+| [`down`](compose_down.md)       | Stop and remove containers, networks                                                     |
+| [`events`](compose_events.md)   | Receive real time events from containers.                                                |
+| [`exec`](compose_exec.md)       | Execute a command in a running container.                                                |
+| [`images`](compose_images.md)   | List images used by the created containers                                               |
+| [`kill`](compose_kill.md)       | Force stop service containers.                                                           |
+| [`logs`](compose_logs.md)       | View output from containers                                                              |
+| [`ls`](compose_ls.md)           | List running compose projects                                                            |
+| [`pause`](compose_pause.md)     | Pause services                                                                           |
+| [`port`](compose_port.md)       | Print the public port for a port binding.                                                |
+| [`ps`](compose_ps.md)           | List containers                                                                          |
+| [`pull`](compose_pull.md)       | Pull service images                                                                      |
+| [`push`](compose_push.md)       | Push service images                                                                      |
+| [`restart`](compose_restart.md) | Restart service containers                                                               |
+| [`rm`](compose_rm.md)           | Removes stopped service containers                                                       |
+| [`run`](compose_run.md)         | Run a one-off command on a service.                                                      |
+| [`scale`](compose_scale.md)     | Scale services                                                                           |
+| [`start`](compose_start.md)     | Start services                                                                           |
+| [`stats`](compose_stats.md)     | Display a live stream of container(s) resource usage statistics                          |
+| [`stop`](compose_stop.md)       | Stop services                                                                            |
+| [`top`](compose_top.md)         | Display the running processes                                                            |
+| [`unpause`](compose_unpause.md) | Unpause services                                                                         |
+| [`up`](compose_up.md)           | Create and start containers                                                              |
+| [`version`](compose_version.md) | Show the Docker Compose version information                                              |
+| [`wait`](compose_wait.md)       | Block until the first service container stops                                            |
+| [`watch`](compose_watch.md)     | Watch build context for service and rebuild/refresh containers when files are updated    |
 
 
 ### Options

+ 18 - 0
docs/reference/compose_attach.md

@@ -0,0 +1,18 @@
+# docker compose attach
+
+<!---MARKER_GEN_START-->
+Attach local standard input, output, and error streams to a service's running container.
+
+### Options
+
+| Name            | Type     | Default | Description                                               |
+|:----------------|:---------|:--------|:----------------------------------------------------------|
+| `--detach-keys` | `string` |         | Override the key sequence for detaching from a container. |
+| `--dry-run`     |          |         | Execute command in dry run mode                           |
+| `--index`       | `int`    | `0`     | index of the container if service has multiple replicas.  |
+| `--no-stdin`    |          |         | Do not attach STDIN                                       |
+| `--sig-proxy`   |          |         | Proxy all received signals to the process                 |
+
+
+<!---MARKER_GEN_END-->
+

+ 2 - 0
docs/reference/docker_compose.yaml

@@ -146,6 +146,7 @@ usage: docker compose
 pname: docker
 plink: docker.yaml
 cname:
+    - docker compose attach
     - docker compose build
     - docker compose config
     - docker compose cp
@@ -176,6 +177,7 @@ cname:
     - docker compose wait
     - docker compose watch
 clink:
+    - docker_compose_attach.yaml
     - docker_compose_build.yaml
     - docker_compose_config.yaml
     - docker_compose_cp.yaml

+ 66 - 0
docs/reference/docker_compose_attach.yaml

@@ -0,0 +1,66 @@
+command: docker compose attach
+short: |
+    Attach local standard input, output, and error streams to a service's running container.
+long: |
+    Attach local standard input, output, and error streams to a service's running container.
+usage: docker compose attach [OPTIONS] SERVICE
+pname: docker compose
+plink: docker_compose.yaml
+options:
+    - option: detach-keys
+      value_type: string
+      description: Override the key sequence for detaching from a container.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: index
+      value_type: int
+      default_value: "0"
+      description: index of the container if service has multiple replicas.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-stdin
+      value_type: bool
+      default_value: "false"
+      description: Do not attach STDIN
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: sig-proxy
+      value_type: bool
+      default_value: "true"
+      description: Proxy all received signals to the process
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+inherited_options:
+    - option: dry-run
+      value_type: bool
+      default_value: "false"
+      description: Execute command in dry run mode
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+deprecated: false
+hidden: false
+experimental: false
+experimentalcli: false
+kubernetes: false
+swarm: false
+