make docs
Signed-off-by: Wes Higbee <wes.mcclure@gmail.com>
This commit is contained in:
Wes Higbee
parent
dcf6bd779f
commit
5f4b22ed7c
@ -5,37 +5,38 @@ Define and run multi-container applications with Docker.
|
|||||||
|
|
||||||
### Subcommands
|
### Subcommands
|
||||||
|
|
||||||
| Name | Description |
|
| Name | Description |
|
||||||
|:--------------------------------|:--------------------------------------------------------------------------------------|
|
|:--------------------------------|:-----------------------------------------------------------------------------------------|
|
||||||
| [`build`](compose_build.md) | Build or rebuild services |
|
| [`attach`](compose_attach.md) | Attach local standard input, output, and error streams to a service's running container. |
|
||||||
| [`config`](compose_config.md) | Parse, resolve and render compose file in canonical format |
|
| [`build`](compose_build.md) | Build or rebuild services |
|
||||||
| [`cp`](compose_cp.md) | Copy files/folders between a service container and the local filesystem |
|
| [`config`](compose_config.md) | Parse, resolve and render compose file in canonical format |
|
||||||
| [`create`](compose_create.md) | Creates containers for a service. |
|
| [`cp`](compose_cp.md) | Copy files/folders between a service container and the local filesystem |
|
||||||
| [`down`](compose_down.md) | Stop and remove containers, networks |
|
| [`create`](compose_create.md) | Creates containers for a service. |
|
||||||
| [`events`](compose_events.md) | Receive real time events from containers. |
|
| [`down`](compose_down.md) | Stop and remove containers, networks |
|
||||||
| [`exec`](compose_exec.md) | Execute a command in a running container. |
|
| [`events`](compose_events.md) | Receive real time events from containers. |
|
||||||
| [`images`](compose_images.md) | List images used by the created containers |
|
| [`exec`](compose_exec.md) | Execute a command in a running container. |
|
||||||
| [`kill`](compose_kill.md) | Force stop service containers. |
|
| [`images`](compose_images.md) | List images used by the created containers |
|
||||||
| [`logs`](compose_logs.md) | View output from containers |
|
| [`kill`](compose_kill.md) | Force stop service containers. |
|
||||||
| [`ls`](compose_ls.md) | List running compose projects |
|
| [`logs`](compose_logs.md) | View output from containers |
|
||||||
| [`pause`](compose_pause.md) | Pause services |
|
| [`ls`](compose_ls.md) | List running compose projects |
|
||||||
| [`port`](compose_port.md) | Print the public port for a port binding. |
|
| [`pause`](compose_pause.md) | Pause services |
|
||||||
| [`ps`](compose_ps.md) | List containers |
|
| [`port`](compose_port.md) | Print the public port for a port binding. |
|
||||||
| [`pull`](compose_pull.md) | Pull service images |
|
| [`ps`](compose_ps.md) | List containers |
|
||||||
| [`push`](compose_push.md) | Push service images |
|
| [`pull`](compose_pull.md) | Pull service images |
|
||||||
| [`restart`](compose_restart.md) | Restart service containers |
|
| [`push`](compose_push.md) | Push service images |
|
||||||
| [`rm`](compose_rm.md) | Removes stopped service containers |
|
| [`restart`](compose_restart.md) | Restart service containers |
|
||||||
| [`run`](compose_run.md) | Run a one-off command on a service. |
|
| [`rm`](compose_rm.md) | Removes stopped service containers |
|
||||||
| [`scale`](compose_scale.md) | Scale services |
|
| [`run`](compose_run.md) | Run a one-off command on a service. |
|
||||||
| [`start`](compose_start.md) | Start services |
|
| [`scale`](compose_scale.md) | Scale services |
|
||||||
| [`stats`](compose_stats.md) | Display a live stream of container(s) resource usage statistics |
|
| [`start`](compose_start.md) | Start services |
|
||||||
| [`stop`](compose_stop.md) | Stop services |
|
| [`stats`](compose_stats.md) | Display a live stream of container(s) resource usage statistics |
|
||||||
| [`top`](compose_top.md) | Display the running processes |
|
| [`stop`](compose_stop.md) | Stop services |
|
||||||
| [`unpause`](compose_unpause.md) | Unpause services |
|
| [`top`](compose_top.md) | Display the running processes |
|
||||||
| [`up`](compose_up.md) | Create and start containers |
|
| [`unpause`](compose_unpause.md) | Unpause services |
|
||||||
| [`version`](compose_version.md) | Show the Docker Compose version information |
|
| [`up`](compose_up.md) | Create and start containers |
|
||||||
| [`wait`](compose_wait.md) | Block until the first service container stops |
|
| [`version`](compose_version.md) | Show the Docker Compose version information |
|
||||||
| [`watch`](compose_watch.md) | Watch build context for service and rebuild/refresh containers when files are updated |
|
| [`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
|
### Options
|
||||||
|
|||||||
18
docs/reference/compose_attach.md
Normal file
18
docs/reference/compose_attach.md
Normal file
@ -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-->
|
||||||
|
|
||||||
@ -146,6 +146,7 @@ usage: docker compose
|
|||||||
pname: docker
|
pname: docker
|
||||||
plink: docker.yaml
|
plink: docker.yaml
|
||||||
cname:
|
cname:
|
||||||
|
- docker compose attach
|
||||||
- docker compose build
|
- docker compose build
|
||||||
- docker compose config
|
- docker compose config
|
||||||
- docker compose cp
|
- docker compose cp
|
||||||
@ -176,6 +177,7 @@ cname:
|
|||||||
- docker compose wait
|
- docker compose wait
|
||||||
- docker compose watch
|
- docker compose watch
|
||||||
clink:
|
clink:
|
||||||
|
- docker_compose_attach.yaml
|
||||||
- docker_compose_build.yaml
|
- docker_compose_build.yaml
|
||||||
- docker_compose_config.yaml
|
- docker_compose_config.yaml
|
||||||
- docker_compose_cp.yaml
|
- docker_compose_cp.yaml
|
||||||
|
|||||||
66
docs/reference/docker_compose_attach.yaml
Normal file
66
docs/reference/docker_compose_attach.yaml
Normal file
@ -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
|
||||||
|
|
||||||
Loading…
x
Reference in New Issue
Block a user