GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2024-11-22 11:59:43 +01:00
Code Issues Projects Releases Wiki Activity

doc/Commands.md: describe Unix/POSIX conventions in some more detail

Browse Source
This commit is contained in:
Pragmatic Software 2020-06-01 12:14:07 -07:00
parent 382e0664bd
commit 957f33c27b
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/Commands.md
View File

@ -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 `<required>` 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: