compose/docs/reference/compose_top.md

# docker compose top

<!---MARKER_GEN_START-->
Displays the running processes

### Options

| Name        | Type   | Default | Description                     |
|:------------|:-------|:--------|:--------------------------------|
| `--dry-run` | `bool` |         | Execute command in dry run mode |


<!---MARKER_GEN_END-->

## Description

Displays the running processes

## Examples

```console
$ docker compose top
example_foo_1
UID    PID      PPID     C    STIME   TTY   TIME       CMD
root   142353   142331   2    15:33   ?     00:00:00   ping localhost -c 5
```
docs: also generate "usage" in MarkDown files Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2022-03-09 12:57:07 +01:00			`# docker compose top`

			`<!---MARKER_GEN_START-->`
update docs generation to avoid man pages generation Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> 2024-07-17 11:27:58 +02:00			`Displays the running processes`
docs: also generate "usage" in MarkDown files Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2022-03-09 12:57:07 +01:00
Update dry-run documentation Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> 2023-05-05 12:43:27 +02:00			`### Options`

update docs generation to avoid man pages generation Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> 2024-07-17 11:27:58 +02:00			`\| Name \| Type \| Default \| Description \|`
			`\|:------------\|:-------\|:--------\|:--------------------------------\|`
			\| `--dry-run` \| `bool` \| \| Execute command in dry run mode \|
Update dry-run documentation Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> 2023-05-05 12:43:27 +02:00
docs: also generate "usage" in MarkDown files Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2022-03-09 12:57:07 +01:00
			`<!---MARKER_GEN_END-->`
reference documentation Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-03-11 16:20:30 +01:00
			`## Description`

docs: unify no trailing dots in docstrings and help (#11301) 2024-02-14 20:02:37 +01:00			`Displays the running processes`
reference documentation Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-03-11 16:20:30 +01:00
			`## Examples`

[v2] docs: markdown and link fixes Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2021-09-13 17:14:32 +02:00			```console
reference documentation Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-03-11 16:20:30 +01:00			`$ docker compose top`
update reference docs Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-06-08 09:39:49 +02:00			`example_foo_1`
reference documentation Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-03-11 16:20:30 +01:00			`UID PID PPID C STIME TTY TIME CMD`
docs: fix trailing whitespace from markdown and regenerate Trailing whitespace in Markdown can force line-breaks, which doesn't seem to be the intent on these; find . -type f -print0 \| xargs -0 perl -pi -e 's/ +$//' The trailing whitespace also can cause the YAML to go wonky (although the cli-docs-tool now takes that into account), and caused the "examples" section to be missed in the `docker compose pull` page (something we should fix in the tool). Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2022-03-09 13:24:09 +01:00			`root 142353 142331 2 15:33 ? 00:00:00 ping localhost -c 5`
[v2] docs: markdown and link fixes Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2021-09-13 17:14:32 +02:00			```