summaryrefslogtreecommitdiff
path: root/docs/podman-top.1.md
diff options
context:
space:
mode:
authorRyan Whalen <rj.whalen@gmail.com>2019-08-31 16:58:52 -0400
committerRyan Whalen <rj.whalen@gmail.com>2019-08-31 16:58:52 -0400
commit09f373283ac8d0f22bfe5c47746dfd920b004d9d (patch)
tree462dd86f78d18f1a58c7eece9510a74334b02083 /docs/podman-top.1.md
parentd266dbea152b106d01cb110be1529e6661d89f54 (diff)
downloadpodman-09f373283ac8d0f22bfe5c47746dfd920b004d9d.tar.gz
podman-09f373283ac8d0f22bfe5c47746dfd920b004d9d.tar.bz2
podman-09f373283ac8d0f22bfe5c47746dfd920b004d9d.zip
Add command aliases to SYNOPSIS section
The files under docs/links reference another man page, e.g. `man podman-container-list` displays `podman-ps(1)`. This adds the alias to the in the displayed page's SYNOPSIS section. Signed-off-by: Ryan Whalen <rj.whalen@gmail.com>
Diffstat (limited to 'docs/podman-top.1.md')
-rw-r--r--docs/podman-top.1.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/podman-top.1.md b/docs/podman-top.1.md
index 564c2f067..1410aa651 100644
--- a/docs/podman-top.1.md
+++ b/docs/podman-top.1.md
@@ -6,6 +6,8 @@ podman\-top - Display the running processes of a container
## SYNOPSIS
**podman top** [*options*] *container* [*format-descriptors*]
+**podman container top** [*options*] *container* [*format-descriptors*]
+
## DESCRIPTION
Display the running processes of the container. The *format-descriptors* are ps (1) compatible AIX format descriptors but extended to print additional information, such as the seccomp mode or the effective capabilities of a given process. The descriptors can either be passed as separated arguments or as a single comma-separated argument. Note that you can also specify options and or flags of ps(1); in this case, Podman will fallback to executing ps with the specified arguments and flags in the container.