diff options
author | Kaz Kylheku <kaz@kylheku.com> | 2021-06-11 07:38:17 -0700 |
---|---|---|
committer | Kaz Kylheku <kaz@kylheku.com> | 2021-06-11 07:38:17 -0700 |
commit | f4fd4cf0ec1389a4a5d8a72548e0da0a8ce65a5a (patch) | |
tree | f32f62ee9b070d33bf9da341a62e4a0e7a3dad86 | |
parent | 36e1f75339b76cf1285bbc45c67051fb065ba330 (diff) | |
download | txr-f4fd4cf0ec1389a4a5d8a72548e0da0a8ce65a5a.tar.gz txr-f4fd4cf0ec1389a4a5d8a72548e0da0a8ce65a5a.tar.bz2 txr-f4fd4cf0ec1389a4a5d8a72548e0da0a8ce65a5a.zip |
doc: codify optional alternatives notation.
* txr.1: The notation [ a | b | c | .. ] is used throughout
the document, but the Conventions paragraph describes only
square brackets around a single optional element. The notation
is now officially codified.
-rw-r--r-- | txr.1 | 8 |
1 files changed, 7 insertions, 1 deletions
@@ -14097,7 +14097,8 @@ The curly braces may be omitted if the scope of the is clear. .coIP {syntax | syntax | ...} -This indicates a choice among alternatives. +This indicates a single, mandatory element, which is selected +from among the indicated alternatives. May be combined with .code + or @@ -14107,6 +14108,11 @@ repetition. .meIP [syntax] <> [ word ] Square brackets indicate optional syntax. +.meIP [syntax | syntax | ...] +Square brackets containing piped elements indicate an optional +element, which, if present, must be chosen from among the indicated +alternatives. + .coIP '[' ']' The quoted square brackets indicate literal brackets which appear in the syntax, which they do without quotes. For instance |