Update docs on command help (#11341)

* Update docs on command help

This is change is based on the output of the script proposed by @smola
in: https://github.com/docker/docker.github.io/pull/11173


Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>

* Formatting updates

* Minor style update

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
This commit is contained in:
Ulysses Souza 2020-09-08 12:57:19 +02:00 committed by GitHub
parent 4236ca0914
commit 411bf944cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 34 additions and 29 deletions

View File

@ -6,17 +6,22 @@ notoc: true
--- ---
``` ```none
Usage: build [options] [--build-arg key=val...] [SERVICE...] Usage: build [options] [--build-arg key=val...] [SERVICE...]
Options: Options:
--build-arg key=val Set build-time variables for services.
--compress Compress the build context using gzip. --compress Compress the build context using gzip.
--force-rm Always remove intermediate containers. --force-rm Always remove intermediate containers.
-m, --memory MEM Set memory limit for the build container.
--no-cache Do not use cache when building the image. --no-cache Do not use cache when building the image.
--pull Always attempt to pull a newer version of the image. --no-rm Do not remove intermediate containers after a successful build.
-m, --memory MEM Sets memory limit for the build container.
--build-arg key=val Set build-time variables for services.
--parallel Build images in parallel. --parallel Build images in parallel.
--progress string Set type of progress output (`auto`, `plain`, `tty`).
`EXPERIMENTAL` flag for native builder.
To enable, run with `COMPOSE_DOCKER_CLI_BUILD=1`)
--pull Always attempt to pull a newer version of the image.
-q, --quiet Don't print anything to `STDOUT`.
``` ```
Services are built once and then tagged, by default as `project_service`. For Services are built once and then tagged, by default as `project_service`. For

View File

@ -7,13 +7,14 @@ redirect_from:
- /compose/reference/bundle/ - /compose/reference/bundle/
--- ---
``` ```none
Usage: config [options] Usage: config [options]
Options: Options:
--resolve-image-digests Pin image tags to digests. --resolve-image-digests Pin image tags to digests.
--no-interpolate Don't interpolate environment variables. --no-interpolate Don't interpolate environment variables.
-q, --quiet Only validate the configuration, don't print anything. -q, --quiet Only validate the configuration, don't print
anything.
--services Print the service names, one per line. --services Print the service names, one per line.
--volumes Print the volume names, one per line. --volumes Print the volume names, one per line.
--hash="*" Print the service config hash, one per line. --hash="*" Print the service config hash, one per line.

View File

@ -9,9 +9,7 @@ notoc: true
instead. instead.
{: .warning } {: .warning }
``` ```none
Creates containers for a service.
Usage: create [options] [SERVICE...] Usage: create [options] [SERVICE...]
Options: Options:

View File

@ -5,7 +5,7 @@ title: docker-compose down
notoc: true notoc: true
--- ---
``` ```none
Usage: down [options] Usage: down [options]
Options: Options:

View File

@ -5,7 +5,7 @@ title: docker-compose events
notoc: true notoc: true
--- ---
``` ```none
Usage: events [options] [SERVICE...] Usage: events [options] [SERVICE...]
Options: Options:

View File

@ -5,7 +5,7 @@ title: docker-compose exec
notoc: true notoc: true
--- ---
``` ```none
Usage: exec [options] [-e KEY=VAL...] SERVICE COMMAND [ARGS...] Usage: exec [options] [-e KEY=VAL...] SERVICE COMMAND [ARGS...]
Options: Options:

View File

@ -5,8 +5,8 @@ title: docker-compose help
notoc: true notoc: true
--- ---
``` ```none
Usage: help COMMAND Usage: help [COMMAND]
``` ```
Displays help and usage instructions for a command. Displays help and usage instructions for a command.

View File

@ -5,7 +5,7 @@ title: docker-compose images
notoc: true notoc: true
--- ---
``` ```none
Usage: images [options] [SERVICE...] Usage: images [options] [SERVICE...]
Options: Options:

View File

@ -5,7 +5,7 @@ title: docker-compose kill
notoc: true notoc: true
--- ---
``` ```none
Usage: kill [options] [SERVICE...] Usage: kill [options] [SERVICE...]
Options: Options:

View File

@ -5,7 +5,7 @@ title: docker-compose logs
notoc: true notoc: true
--- ---
``` ```none
Usage: logs [options] [SERVICE...] Usage: logs [options] [SERVICE...]
Options: Options:

View File

@ -5,7 +5,7 @@ title: docker-compose pause
notoc: true notoc: true
--- ---
``` ```none
Usage: pause [SERVICE...] Usage: pause [SERVICE...]
``` ```

View File

@ -5,7 +5,7 @@ title: docker-compose port
notoc: true notoc: true
--- ---
``` ```none
Usage: port [options] SERVICE PRIVATE_PORT Usage: port [options] SERVICE PRIVATE_PORT
Options: Options:

View File

@ -5,7 +5,7 @@ title: docker-compose pull
notoc: true notoc: true
--- ---
``` ```none
Usage: pull [options] [SERVICE...] Usage: pull [options] [SERVICE...]
Options: Options:

View File

@ -5,7 +5,7 @@ title: docker-compose push
notoc: true notoc: true
--- ---
``` ```none
Usage: push [options] [SERVICE...] Usage: push [options] [SERVICE...]
Options: Options:

View File

@ -5,7 +5,7 @@ title: docker-compose restart
notoc: true notoc: true
--- ---
``` ```none
Usage: restart [options] [SERVICE...] Usage: restart [options] [SERVICE...]
Options: Options:

View File

@ -12,6 +12,7 @@ Options:
-f, --force Don't ask to confirm removal -f, --force Don't ask to confirm removal
-s, --stop Stop the containers, if required, before removing -s, --stop Stop the containers, if required, before removing
-v Remove any anonymous volumes attached to containers -v Remove any anonymous volumes attached to containers
-a, --all Deprecated - no effect.
``` ```
Removes stopped service containers. Removes stopped service containers.

View File

@ -5,7 +5,7 @@ title: docker-compose run
notoc: true notoc: true
--- ---
``` ```none
Usage: Usage:
run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] [-l KEY=VALUE...] run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] [-l KEY=VALUE...]
SERVICE [COMMAND] [ARGS...] SERVICE [COMMAND] [ARGS...]

View File

@ -11,7 +11,7 @@ notoc: true
the `scale` command, as it incorporates the behaviour of the `up` command. the `scale` command, as it incorporates the behaviour of the `up` command.
{: .warning } {: .warning }
``` ```none
Usage: scale [options] [SERVICE=NUM...] Usage: scale [options] [SERVICE=NUM...]
Options: Options:

View File

@ -5,7 +5,7 @@ title: docker-compose start
notoc: true notoc: true
--- ---
``` ```none
Usage: start [SERVICE...] Usage: start [SERVICE...]
``` ```

View File

@ -5,7 +5,7 @@ title: docker-compose stop
notoc: true notoc: true
--- ---
``` ```none
Usage: stop [options] [SERVICE...] Usage: stop [options] [SERVICE...]
Options: Options:

View File

@ -7,7 +7,6 @@ notoc: true
```none ```none
Usage: top [SERVICE...] Usage: top [SERVICE...]
``` ```
Displays the running processes. Displays the running processes.

View File

@ -5,7 +5,7 @@ title: docker-compose unpause
notoc: true notoc: true
--- ---
``` ```none
Usage: unpause [SERVICE...] Usage: unpause [SERVICE...]
``` ```

View File

@ -5,7 +5,7 @@ title: docker-compose up
notoc: true notoc: true
--- ---
``` ```none
Usage: up [options] [--scale SERVICE=NUM...] [SERVICE...] Usage: up [options] [--scale SERVICE=NUM...] [SERVICE...]
Options: Options:
@ -26,6 +26,7 @@ Options:
--build Build images before starting containers. --build Build images before starting containers.
--abort-on-container-exit Stops all containers if any container was --abort-on-container-exit Stops all containers if any container was
stopped. Incompatible with -d. stopped. Incompatible with -d.
--attach-dependencies Attach to dependent containers.
-t, --timeout TIMEOUT Use this timeout in seconds for container -t, --timeout TIMEOUT Use this timeout in seconds for container
shutdown when attached or when containers are shutdown when attached or when containers are
already running. (default: 10) already running. (default: 10)