From 957f33c27b428dbf23bcb166fc48a0fe8d36faec Mon Sep 17 00:00:00 2001 From: Pragmatic Software Date: Mon, 1 Jun 2020 12:14:07 -0700 Subject: [PATCH] doc/Commands.md: describe Unix/POSIX conventions in some more detail --- doc/Commands.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/doc/Commands.md b/doc/Commands.md index 36d55a85..dd4be5d7 100644 --- a/doc/Commands.md +++ b/doc/Commands.md @@ -119,7 +119,17 @@ PBot has a powerful command interpreter with useful functionality. ### Command invocation There are a number of ways to invoke commands with PBot. -The syntax of PBot's commands largely follow Unix/POSIX conventions. +The documentation and syntax of PBot's commands largely follow Unix/POSIX conventions: + +Square brackets `[optional]` indicate that the enclosed element (parameter, value, or information) is optional. +You can choose one or more items or no items. Do not type the square brackets themselves in the command line. + +Angle brackets `` indicate that the enclosed element (parameter, value, or information) is mandatory. +You are required to replace the text within the angle brackets with the appropriate information. +Do not type the angle brackets themselves in the command line. + +A parenthesized set of elements delimited by a vertical bar `(x|y|z)` indicates mutually exclusive choices. You +must pick one and only one. Do not type the parentheses in the command line. A single command's syntax is: