Skip to content

Commit 63b4414

Browse files
leoperegrinondeloof
authored andcommitted
add volumes docs/reference/
Signed-off-by: Leonardo Peregrino <[email protected]>
1 parent 3a7982f commit 63b4414

File tree

4 files changed

+71
-0
lines changed

4 files changed

+71
-0
lines changed

docs/reference/compose.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Define and run multi-container applications with Docker
4343
| [`unpause`](compose_unpause.md) | Unpause services |
4444
| [`up`](compose_up.md) | Create and start containers |
4545
| [`version`](compose_version.md) | Show the Docker Compose version information |
46+
| [`volumes`](compose_volumes.md) | List volumes |
4647
| [`wait`](compose_wait.md) | Block until containers of all (or specified) services stop. |
4748
| [`watch`](compose_watch.md) | Watch build context for service and rebuild/refresh containers when files are updated |
4849

docs/reference/compose_volumes.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# docker compose volumes
2+
3+
<!---MARKER_GEN_START-->
4+
List volumes
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
|:----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
10+
| `--dry-run` | `bool` | | Execute command in dry run mode |
11+
| `--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 |
12+
| `-q`, `--quiet` | `bool` | | Only display volume names |
13+
14+
15+
<!---MARKER_GEN_END-->
16+

docs/reference/docker_compose.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ cname:
3737
- docker compose unpause
3838
- docker compose up
3939
- docker compose version
40+
- docker compose volumes
4041
- docker compose wait
4142
- docker compose watch
4243
clink:
@@ -72,6 +73,7 @@ clink:
7273
- docker_compose_unpause.yaml
7374
- docker_compose_up.yaml
7475
- docker_compose_version.yaml
76+
- docker_compose_volumes.yaml
7577
- docker_compose_wait.yaml
7678
- docker_compose_watch.yaml
7779
options:
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
command: docker compose volumes
2+
short: List volumes
3+
long: List volumes
4+
usage: docker compose volumes [OPTIONS] [SERVICE...]
5+
pname: docker compose
6+
plink: docker_compose.yaml
7+
options:
8+
- option: format
9+
value_type: string
10+
default_value: table
11+
description: |-
12+
Format output using a custom template:
13+
'table': Print output in table format with column headers (default)
14+
'table TEMPLATE': Print output in table format using the given Go template
15+
'json': Print in JSON format
16+
'TEMPLATE': Print output using the given Go template.
17+
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates
18+
deprecated: false
19+
hidden: false
20+
experimental: false
21+
experimentalcli: false
22+
kubernetes: false
23+
swarm: false
24+
- option: quiet
25+
shorthand: q
26+
value_type: bool
27+
default_value: "false"
28+
description: Only display volume names
29+
deprecated: false
30+
hidden: false
31+
experimental: false
32+
experimentalcli: false
33+
kubernetes: false
34+
swarm: false
35+
inherited_options:
36+
- option: dry-run
37+
value_type: bool
38+
default_value: "false"
39+
description: Execute command in dry run mode
40+
deprecated: false
41+
hidden: false
42+
experimental: false
43+
experimentalcli: false
44+
kubernetes: false
45+
swarm: false
46+
deprecated: false
47+
hidden: false
48+
experimental: false
49+
experimentalcli: false
50+
kubernetes: false
51+
swarm: false
52+

0 commit comments

Comments
 (0)