From c7b1658c09720e6651f29c740cd164df1301561a Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Fri, 9 Mar 2018 10:23:22 -0800 Subject: Rewrite unfinished paragraph at the end of OPTIONS. --- docs/man/nngcat.adoc | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/man/nngcat.adoc b/docs/man/nngcat.adoc index edb22629..2822cd71 100644 --- a/docs/man/nngcat.adoc +++ b/docs/man/nngcat.adoc @@ -30,15 +30,26 @@ receiving messages. == OPTIONS -The following options may be supplied for _OPTION_. +The possible values for _OPTION_ are described below. TIP: The _nngcat_ utility accepts shortened versions of these options, as long as the supplied option is unambiguous. For example `--comp` can be used in lieu of `--compat`, but `--re` may not be used for anything because it could mean any of `--req`, `--rep`, or `--respondent`. -Options that take values may be separated from their value either by an -equa +When using the long form of an option (names prefixed with with `--`), if the +option takes a value then the value may be supplied by appending the option +with an equals sign and the value (e.g. `--subscribe=times`), by appending +the option with a colon and the value (e.g. `--subscribe:tribune`) or by +providing the data as the next program argument (e.g. `--subscribe herald`). + +When using short form options (a single letter prefixed with a `-`), +if the option takes a value it may either be immediately appended to +the value (e.g. `-L5678`) or provided as the next program argument +(e.g. `-L 5678`). + +POSIX style option clustering of single letter options is not supported; +each option must be presented as a separate argument to the program. === Generic *-h, --help*:: -- cgit v1.2.3-70-g09d2