Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/docs/reference/commandline/top.md

20 lines
310 B
Markdown
Raw Normal View History

Convert Markdown frontmatter to YAML Some frontmatter such as the weights, menu stuff, etc is no longer used 'draft=true' becomes 'published: false' Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-14 18:30:36 -04:00
---
title: "top"
description: "The top command description and usage"
fix frontmatter keywords value type (string, instead of []string) in /docs/reference Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-03 18:48:30 -04:00
keywords: "container, running, processes"
Convert Markdown frontmatter to YAML Some frontmatter such as the weights, menu stuff, etc is no longer used 'draft=true' becomes 'published: false' Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-14 18:30:36 -04:00
---
Splitting out the cli command into parts. Signed-off-by: Mary Anthony <mary@docker.com>
2015-06-21 16:41:38 -04:00
# top
Updates on cli reference documentation - Update ps with `--last` flag - Update commands with current output - Make sure hugo does not detect the wrong language - Update usage for `tag` command to be more coherent with the other ones Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-07-07 14:43:18 -04:00
```markdown
Usage: docker top CONTAINER [ps OPTIONS]
Splitting out the cli command into parts. Signed-off-by: Mary Anthony <mary@docker.com>
2015-06-21 16:41:38 -04:00
Updates on cli reference documentation - Update ps with `--last` flag - Update commands with current output - Make sure hugo does not detect the wrong language - Update usage for `tag` command to be more coherent with the other ones Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-07-07 14:43:18 -04:00
Display the running processes of a container
Fix man and commandline docs - missing help option in `docs/reference/commandline/*.md` (some files have it, the other I fixed didn't) - missing `[OPTIONS]` in Usage description - missing options - formatting - start/stop idempotence Signed-off-by: Antonio Murdaca <amurdaca@redhat.com>
2015-10-03 11:56:41 -04:00
cli: use custom annotation for aliases Cobra allows for aliases to be defined for a command, but only allows these to be defined at the same level (for example, `docker image ls` as alias for `docker image list`). Our CLI has some commands that are available both as a top-level shorthand as well as `docker <object> <verb>` subcommands. For example, `docker ps` is a shorthand for `docker container ps` / `docker container ls`. This patch introduces a custom "aliases" annotation that can be used to print all available aliases for a command. While this requires these aliases to be defined manually, in practice the list of aliases rarely changes, so maintenance should be minimal. As a convention, we could consider the first command in this list to be the canonical command, so that we can use this information to add redirects in our documentation in future. Before this patch: docker images --help Usage: docker images [OPTIONS] [REPOSITORY[:TAG]] List images Options: -a, --all Show all images (default hides intermediate images) ... With this patch: docker images --help Usage: docker images [OPTIONS] [REPOSITORY[:TAG]] List images Aliases: docker image ls, docker image list, docker images Options: -a, --all Show all images (default hides intermediate images) ... Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-06-28 04:52:25 -04:00
Aliases:
docker container top, docker top
Updates on cli reference documentation - Update ps with `--last` flag - Update commands with current output - Make sure hugo does not detect the wrong language - Update usage for `tag` command to be more coherent with the other ones Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-07-07 14:43:18 -04:00
Options:
--help Print usage
```