Skip to content

Commit 5f4b22e

Browse files
g0t4g0t4
committed
make docs
Signed-off-by: Wes Higbee <[email protected]>
1 parent dcf6bd7 commit 5f4b22e

File tree

4 files changed

+118
-31
lines changed

4 files changed

+118
-31
lines changed

‎docs/reference/compose.md

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,38 @@ Define and run multi-container applications with Docker.
55

66
### Subcommands
77

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

4041

4142
### Options

‎docs/reference/compose_attach.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# docker compose attach
2+
3+
<!---MARKER_GEN_START-->
4+
Attach local standard input, output, and error streams to a service's running container.
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
|:----------------|:---------|:--------|:----------------------------------------------------------|
10+
| `--detach-keys` | `string` | | Override the key sequence for detaching from a container. |
11+
| `--dry-run` | | | Execute command in dry run mode |
12+
| `--index` | `int` | `0` | index of the container if service has multiple replicas. |
13+
| `--no-stdin` | | | Do not attach STDIN |
14+
| `--sig-proxy` | | | Proxy all received signals to the process |
15+
16+
17+
<!---MARKER_GEN_END-->
18+

‎docs/reference/docker_compose.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ usage: docker compose
146146
pname: docker
147147
plink: docker.yaml
148148
cname:
149+
- docker compose attach
149150
- docker compose build
150151
- docker compose config
151152
- docker compose cp
@@ -176,6 +177,7 @@ cname:
176177
- docker compose wait
177178
- docker compose watch
178179
clink:
180+
- docker_compose_attach.yaml
179181
- docker_compose_build.yaml
180182
- docker_compose_config.yaml
181183
- docker_compose_cp.yaml

‎docs/reference/docker_compose_attach.yaml

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
command: docker compose attach
2+
short: |
3+
Attach local standard input, output, and error streams to a service's running container.
4+
long: |
5+
Attach local standard input, output, and error streams to a service's running container.
6+
usage: docker compose attach [OPTIONS] SERVICE
7+
pname: docker compose
8+
plink: docker_compose.yaml
9+
options:
10+
- option: detach-keys
11+
value_type: string
12+
description: Override the key sequence for detaching from a container.
13+
deprecated: false
14+
hidden: false
15+
experimental: false
16+
experimentalcli: false
17+
kubernetes: false
18+
swarm: false
19+
- option: index
20+
value_type: int
21+
default_value: "0"
22+
description: index of the container if service has multiple replicas.
23+
deprecated: false
24+
hidden: false
25+
experimental: false
26+
experimentalcli: false
27+
kubernetes: false
28+
swarm: false
29+
- option: no-stdin
30+
value_type: bool
31+
default_value: "false"
32+
description: Do not attach STDIN
33+
deprecated: false
34+
hidden: false
35+
experimental: false
36+
experimentalcli: false
37+
kubernetes: false
38+
swarm: false
39+
- option: sig-proxy
40+
value_type: bool
41+
default_value: "true"
42+
description: Proxy all received signals to the process
43+
deprecated: false
44+
hidden: false
45+
experimental: false
46+
experimentalcli: false
47+
kubernetes: false
48+
swarm: false
49+
inherited_options:
50+
- option: dry-run
51+
value_type: bool
52+
default_value: "false"
53+
description: Execute command in dry run mode
54+
deprecated: false
55+
hidden: false
56+
experimental: false
57+
experimentalcli: false
58+
kubernetes: false
59+
swarm: false
60+
deprecated: false
61+
hidden: false
62+
experimental: false
63+
experimentalcli: false
64+
kubernetes: false
65+
swarm: false
66+

0 commit comments

Comments
 (0)