Add documentation for new top command (#1534) (#1601)

Update command lists to include recent additions

Signed-off-by: Joffrey F <joffrey@docker.com>
This commit is contained in:
John Mulhausen 2017-02-10 13:59:06 -08:00 committed by GitHub
parent 03550be339
commit 9abc9e9f41
4 changed files with 37 additions and 2 deletions

View File

@ -859,6 +859,8 @@ toc:
title: start
- path: /compose/reference/stop/
title: stop
- path: /compose/reference/top
title: top
- path: /compose/reference/unpause/
title: unpause
- path: /compose/reference/up/

View File

@ -8,10 +8,12 @@ The following pages describe the usage information for the [docker-compose](over
* [docker-compose](overview.md)
* [build](build.md)
* [bundle](bundle.md)
* [config](config.md)
* [create](create.md)
* [down](down.md)
* [events](events.md)
* [exec](exec.md)
* [help](help.md)
* [kill](kill.md)
* [logs](logs.md)
@ -19,12 +21,14 @@ The following pages describe the usage information for the [docker-compose](over
* [port](port.md)
* [ps](ps.md)
* [pull](pull.md)
* [push](push.md)
* [restart](restart.md)
* [rm](rm.md)
* [run](run.md)
* [scale](scale.md)
* [start](start.md)
* [stop](stop.md)
* [top](top.md)
* [unpause](unpause.md)
* [up](up.md)

View File

@ -14,7 +14,7 @@ command line.
Define and run multi-container applications with Docker.
Usage:
docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]
docker-compose [-f <arg>...] [options] [COMMAND] [ARGS...]
docker-compose -h|--help
Options:
@ -35,23 +35,27 @@ Options:
Commands:
build Build or rebuild services
bundle Generate a Docker bundle from the Compose file
config Validate and view the compose file
create Create services
down Stop and remove containers, networks, images, and volumes
events Receive real time events from containers
exec Execute a command in a running container
help Get help on a command
kill Kill containers
logs View output from containers
pause Pause services
port Print the public port for a port binding
ps List containers
pull Pulls service images
pull Pull service images
push Push service images
restart Restart services
rm Remove stopped containers
run Run a one-off command
scale Set number of containers for a service
start Start services
stop Stop services
top Display the running processes
unpause Unpause services
up Create and start containers
version Show the Docker-Compose version information

25
compose/reference/top.md Normal file
View File

@ -0,0 +1,25 @@
---
description: Displays the running processes.
keywords: fig, composition, compose, docker, orchestration, cli, top
title: docker-compose top
---
```none
Usage: top [SERVICE...]
```
Displays the running processes.
```bash
$ docker-compose top
compose_service_a_1
PID USER TIME COMMAND
----------------------------
4060 root 0:00 top
compose_service_b_1
PID USER TIME COMMAND
----------------------------
4115 root 0:00 top
```