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-ps.1.md | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) (limited to 'docs/podman-ps.1.md') diff --git a/docs/podman-ps.1.md b/docs/podman-ps.1.md index f708c7d74..0ec39f5ac 100644 --- a/docs/podman-ps.1.md +++ b/docs/podman-ps.1.md @@ -4,12 +4,7 @@ podman\-ps - Prints out information about containers ## SYNOPSIS -**podman ps** -[**--all**|**-a**] -[**--no-trunc**] -[**--quiet**|**-q**] -[**--format**] -[**--help**|**-h**] +**podman ps** [*options*] ## DESCRIPTION **podman ps** lists the running containers on the system. Use the **--all** flag to view @@ -23,12 +18,6 @@ all the containers information. By default it lists: * port mappings the container is using * alternative names for the container -**podman [GLOBAL OPTIONS]** - -**podman ps [GLOBAL OPTIONS]** - -**podman ps [OPTIONS]** - ## OPTIONS **--all, -a** @@ -103,6 +92,10 @@ Valid filters are listed below: | since | [ID] or [Name] Containers created since this container | | volume | [VolumeName] or [MountpointDestination] Volume mounted in container | +**--help**, **-h** + +Print usage statement + ## EXAMPLES ``` -- cgit v1.2.3-54-g00ecf