Skip to content

Commit 42710b7

Browse files
thaJeztahndeloof
thaJeztah
authored and
ndeloof
committed
docs: also generate "usage" in MarkDown files
Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent b9b3a3d commit 42710b7

28 files changed

+461
-5
lines changed

‎docs/reference/compose.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,54 @@
1-
1+
# docker compose
2+
3+
<!---MARKER_GEN_START-->
4+
Docker Compose
5+
6+
### Subcommands
7+
8+
| Name | Description |
9+
| --- | --- |
10+
| [`build`](compose_build.md) | Build or rebuild services |
11+
| [`convert`](compose_convert.md) | Converts the compose file to platform's 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 containers |
27+
| [`rm`](compose_rm.md) | Removes stopped service containers |
28+
| [`run`](compose_run.md) | Run a one-off command on a service. |
29+
| [`start`](compose_start.md) | Start services |
30+
| [`stop`](compose_stop.md) | Stop services |
31+
| [`top`](compose_top.md) | Display the running processes |
32+
| [`unpause`](compose_unpause.md) | Unpause services |
33+
| [`up`](compose_up.md) | Create and start containers |
34+
| [`version`](compose_version.md) | Show the Docker Compose version information |
35+
36+
37+
### Options
38+
39+
| Name | Type | Default | Description |
40+
| --- | --- | --- | --- |
41+
| `--ansi` | `string` | `auto` | Control when to print ANSI control characters ("never"\|"always"\|"auto") |
42+
| `--compatibility` | | | Run compose in backward compatibility mode |
43+
| `--env-file` | `string` | | Specify an alternate environment file. |
44+
| `-f`, `--file` | `stringArray` | | Compose configuration files |
45+
| `--profile` | `stringArray` | | Specify a profile to enable |
46+
| `--project-directory` | `string` | | Specify an alternate working directory
47+
(default: the path of the Compose file) |
48+
| `-p`, `--project-name` | `string` | | Project name |
49+
50+
51+
<!---MARKER_GEN_END-->
252

353
## Description
454

‎docs/reference/compose_build.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
# docker compose build
2+
3+
<!---MARKER_GEN_START-->
4+
Build or rebuild services
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
| --- | --- | --- | --- |
10+
| `--build-arg` | `stringArray` | | Set build-time variables for services. |
11+
| `--no-cache` | | | Do not use cache when building the image |
12+
| `--progress` | `string` | `auto` | Set type of progress output (auto, tty, plain, quiet) |
13+
| `--pull` | | | Always attempt to pull a newer version of the image. |
14+
| `-q`, `--quiet` | | | Don't print anything to STDOUT |
15+
16+
17+
<!---MARKER_GEN_END-->
118

219
## Description
320

‎docs/reference/compose_convert.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,30 @@
1+
# docker compose convert
12

3+
<!---MARKER_GEN_START-->
4+
Converts the compose file to platform's canonical format
5+
6+
### Aliases
7+
8+
`convert`, `config`
9+
10+
### Options
11+
12+
| Name | Type | Default | Description |
13+
| --- | --- | --- | --- |
14+
| `--format` | `string` | `yaml` | Format the output. Values: [yaml \| json] |
15+
| `--hash` | `string` | | Print the service config hash, one per line. |
16+
| `--images` | | | Print the image names, one per line. |
17+
| `--no-interpolate` | | | Don't interpolate environment variables. |
18+
| `--no-normalize` | | | Don't normalize compose model. |
19+
| `-o`, `--output` | `string` | | Save to file (default to stdout) |
20+
| `--profiles` | | | Print the profile names, one per line. |
21+
| `-q`, `--quiet` | | | Only validate the configuration, don't print anything. |
22+
| `--resolve-image-digests` | | | Pin image tags to digests. |
23+
| `--services` | | | Print the service names, one per line. |
24+
| `--volumes` | | | Print the volume names, one per line. |
25+
26+
27+
<!---MARKER_GEN_END-->
228

329
## Description
430

‎docs/reference/compose_cp.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# docker compose cp
2+
3+
<!---MARKER_GEN_START-->
4+
Copy files/folders between a service container and the local filesystem
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
| --- | --- | --- | --- |
10+
| `--all` | | | Copy to all the containers of the service. |
11+
| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) |
12+
| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH |
13+
| `--index` | `int` | `1` | Index of the container if there are multiple instances of a service [default: 1]. |
14+
15+
16+
<!---MARKER_GEN_END-->
17+

‎docs/reference/compose_create.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# docker compose create
2+
3+
<!---MARKER_GEN_START-->
4+
Creates containers for a service.
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
| --- | --- | --- | --- |
10+
| `--build` | | | Build images before starting containers. |
11+
| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. |
12+
| `--no-build` | | | Don't build an image, even if it's missing. |
13+
| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. |
14+
15+
16+
<!---MARKER_GEN_END-->
17+

‎docs/reference/compose_down.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
1+
# docker compose down
12

3+
<!---MARKER_GEN_START-->
4+
Stop and remove containers, networks
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
| --- | --- | --- | --- |
10+
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. |
11+
| `--rmi` | `string` | | Remove images used by services. "local" remove only images that don't have a custom tag ("local"\|"all") |
12+
| `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds |
13+
| `-v`, `--volumes` | | | Remove named volumes declared in the `volumes` section of the Compose file and anonymous volumes attached to containers. |
14+
15+
16+
<!---MARKER_GEN_END-->
217

318
## Description
419

‎docs/reference/compose_events.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
# docker compose events
2+
3+
<!---MARKER_GEN_START-->
4+
Receive real time events from containers.
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
| --- | --- | --- | --- |
10+
| `--json` | | | Output events as a stream of json objects |
11+
12+
13+
<!---MARKER_GEN_END-->
114

215
## Description
316

‎docs/reference/compose_exec.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
# docker compose exec
2+
3+
<!---MARKER_GEN_START-->
4+
Execute a command in a running container.
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
| --- | --- | --- | --- |
10+
| `-d`, `--detach` | | | Detached mode: Run command in the background. |
11+
| `-e`, `--env` | `stringArray` | | Set environment variables |
12+
| `--index` | `int` | `1` | index of the container if there are multiple instances of a service [default: 1]. |
13+
| `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. |
14+
| `--privileged` | | | Give extended privileges to the process. |
15+
| `-u`, `--user` | `string` | | Run the command as this user. |
16+
| `-w`, `--workdir` | `string` | | Path to workdir directory for this command. |
17+
18+
19+
<!---MARKER_GEN_END-->
120

221
## Description
322

‎docs/reference/compose_images.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# docker compose images
2+
3+
<!---MARKER_GEN_START-->
4+
List images used by the created containers
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
| --- | --- | --- | --- |
10+
| `-q`, `--quiet` | | | Only display IDs |
11+
12+
13+
<!---MARKER_GEN_END-->
14+

‎docs/reference/compose_kill.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
# docker compose kill
2+
3+
<!---MARKER_GEN_START-->
4+
Force stop service containers.
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
| --- | --- | --- | --- |
10+
| `-s`, `--signal` | `string` | `SIGKILL` | SIGNAL to send to the container. |
11+
12+
13+
<!---MARKER_GEN_END-->
114

215
## Description
316

0 commit comments

Comments
 (0)