summaryrefslogtreecommitdiff
path: root/docs/podman-varlink.1.md
diff options
context:
space:
mode:
authorW. Trevor King <wking@tremily.us>2018-06-29 10:53:33 -0700
committerAtomic Bot <atomic-devel@projectatomic.io>2018-07-04 09:40:37 +0000
commitf2462ca59e4a48b9f23e3c8f2acaa8bce60d588d (patch)
treeb5e90ce8ce97d498f379d58ce31b2bd0249f7516 /docs/podman-varlink.1.md
parent6d8fac87ed20c7bb3214e28e2ef74d3d8831eadd (diff)
downloadpodman-f2462ca59e4a48b9f23e3c8f2acaa8bce60d588d.tar.gz
podman-f2462ca59e4a48b9f23e3c8f2acaa8bce60d588d.tar.bz2
podman-f2462ca59e4a48b9f23e3c8f2acaa8bce60d588d.zip
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 <wking@tremily.us> Closes: #1027 Approved by: rhatdan
Diffstat (limited to 'docs/podman-varlink.1.md')
-rw-r--r--docs/podman-varlink.1.md8
1 files changed, 2 insertions, 6 deletions
diff --git a/docs/podman-varlink.1.md b/docs/podman-varlink.1.md
index 7d6c481e5..1e63ddec3 100644
--- a/docs/podman-varlink.1.md
+++ b/docs/podman-varlink.1.md
@@ -4,16 +4,12 @@
podman\-varlink - Runs the varlink backend interface
## SYNOPSIS
-**podman varlink** [OPTIONS]
-[**--help**|**-h**]
-VARLINK_URI
+**podman varlink** [*options*] *uri*
## DESCRIPTION
-Starts the varlink service that allows varlink clients to interact with podman. This should generally be done
+Starts the varlink service listening on *uri* that allows varlink clients to interact with podman. This should generally be done
with systemd. See _Configuration_ below.
-**podman [GLOBAL OPTIONS] [OPTIONS] varlink VARLINK_URI**
-
## GLOBAL OPTIONS
**--help, -h**