From f2462ca59e4a48b9f23e3c8f2acaa8bce60d588d Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Fri, 29 Jun 2018 10:53:33 -0700 Subject: docs: Follow man-pages(7) suggestions for SYNOPSIS man-pages(7) has [1]: > For commands, this shows the syntax of the command and its arguments > (including options); boldface is used for as-is text and italics are > used to indicate replaceable arguments. Brackets ([]) surround > optional arguments, vertical bars (|) separate choices, and ellipses > (...) can be repeated. I've adjusted our SYNOPSIS entries to match that formatting, and generally tried to make them more consistent with the precedent set by the man-pages project. Outside of the SYNOPSIS entry, I prefer using backticks for literals, although in some places I've left the ** bolding to keep things visually similar to a nearby SYNOPSIS entry. [1]: http://man7.org/linux/man-pages/man7/man-pages.7.html Signed-off-by: W. Trevor King Closes: #1027 Approved by: rhatdan --- docs/podman-top.1.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) (limited to 'docs/podman-top.1.md') diff --git a/docs/podman-top.1.md b/docs/podman-top.1.md index 9e7647079..a9abd8baf 100644 --- a/docs/podman-top.1.md +++ b/docs/podman-top.1.md @@ -4,13 +4,10 @@ podman\-top - Display the running processes of a container ## SYNOPSIS -**podman top** -[**--help**|**-h**] +**podman top** [*options*] *container* [*ps-options*] ## DESCRIPTION -Display the running process of the container. ps-OPTION can be any of the options you would pass to a Linux ps command - -**podman [GLOBAL OPTIONS] top [OPTIONS]** +Display the running process of the container. *ps-options* can be any of the options you would pass to `ps(1)`. ## OPTIONS -- cgit v1.2.3-54-g00ecf