mirror of
https://github.com/docker/compose.git
synced 2025-07-22 13:14:29 +02:00
add volumes docs/reference/
Signed-off-by: Leonardo Peregrino <55335068+leoperegrino@users.noreply.github.com>
This commit is contained in:
parent
3a7982fe45
commit
63b441401e
@ -43,6 +43,7 @@ Define and run multi-container applications with Docker
|
|||||||
| [`unpause`](compose_unpause.md) | Unpause services |
|
| [`unpause`](compose_unpause.md) | Unpause services |
|
||||||
| [`up`](compose_up.md) | Create and start containers |
|
| [`up`](compose_up.md) | Create and start containers |
|
||||||
| [`version`](compose_version.md) | Show the Docker Compose version information |
|
| [`version`](compose_version.md) | Show the Docker Compose version information |
|
||||||
|
| [`volumes`](compose_volumes.md) | List volumes |
|
||||||
| [`wait`](compose_wait.md) | Block until containers of all (or specified) services stop. |
|
| [`wait`](compose_wait.md) | Block until containers of all (or specified) services stop. |
|
||||||
| [`watch`](compose_watch.md) | Watch build context for service and rebuild/refresh containers when files are updated |
|
| [`watch`](compose_watch.md) | Watch build context for service and rebuild/refresh containers when files are updated |
|
||||||
|
|
||||||
|
16
docs/reference/compose_volumes.md
Normal file
16
docs/reference/compose_volumes.md
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
# docker compose volumes
|
||||||
|
|
||||||
|
<!---MARKER_GEN_START-->
|
||||||
|
List volumes
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Name | Type | Default | Description |
|
||||||
|
|:----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| `--dry-run` | `bool` | | Execute command in dry run mode |
|
||||||
|
| `--format` | `string` | `table` | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
|
||||||
|
| `-q`, `--quiet` | `bool` | | Only display volume names |
|
||||||
|
|
||||||
|
|
||||||
|
<!---MARKER_GEN_END-->
|
||||||
|
|
@ -37,6 +37,7 @@ cname:
|
|||||||
- docker compose unpause
|
- docker compose unpause
|
||||||
- docker compose up
|
- docker compose up
|
||||||
- docker compose version
|
- docker compose version
|
||||||
|
- docker compose volumes
|
||||||
- docker compose wait
|
- docker compose wait
|
||||||
- docker compose watch
|
- docker compose watch
|
||||||
clink:
|
clink:
|
||||||
@ -72,6 +73,7 @@ clink:
|
|||||||
- docker_compose_unpause.yaml
|
- docker_compose_unpause.yaml
|
||||||
- docker_compose_up.yaml
|
- docker_compose_up.yaml
|
||||||
- docker_compose_version.yaml
|
- docker_compose_version.yaml
|
||||||
|
- docker_compose_volumes.yaml
|
||||||
- docker_compose_wait.yaml
|
- docker_compose_wait.yaml
|
||||||
- docker_compose_watch.yaml
|
- docker_compose_watch.yaml
|
||||||
options:
|
options:
|
||||||
|
52
docs/reference/docker_compose_volumes.yaml
Normal file
52
docs/reference/docker_compose_volumes.yaml
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
command: docker compose volumes
|
||||||
|
short: List volumes
|
||||||
|
long: List volumes
|
||||||
|
usage: docker compose volumes [OPTIONS] [SERVICE...]
|
||||||
|
pname: docker compose
|
||||||
|
plink: docker_compose.yaml
|
||||||
|
options:
|
||||||
|
- option: format
|
||||||
|
value_type: string
|
||||||
|
default_value: table
|
||||||
|
description: |-
|
||||||
|
Format output using a custom template:
|
||||||
|
'table': Print output in table format with column headers (default)
|
||||||
|
'table TEMPLATE': Print output in table format using the given Go template
|
||||||
|
'json': Print in JSON format
|
||||||
|
'TEMPLATE': Print output using the given Go template.
|
||||||
|
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates
|
||||||
|
deprecated: false
|
||||||
|
hidden: false
|
||||||
|
experimental: false
|
||||||
|
experimentalcli: false
|
||||||
|
kubernetes: false
|
||||||
|
swarm: false
|
||||||
|
- option: quiet
|
||||||
|
shorthand: q
|
||||||
|
value_type: bool
|
||||||
|
default_value: "false"
|
||||||
|
description: Only display volume names
|
||||||
|
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