Introduction
Okapi Command Reference is an alphabetical listing of Okapi commands and their detailed explanation. Here, we provide references to all commands of Okapi Router.
| Convention | Description |
[ ] | Square brackets enclose default responses to system prompts. |
| ^ or Ctrl | The ^ and Ctrl symbols represent the Control key. Keys are indicated in capital letters. |
| WORD | WORD is a non quoted set of characters shown in italics. |
| boldface | Commands and keywords are indicated by boldface text that you enter literally as shown. |
| italics | Italic text indicates arguments for which you supply values. |
| [x] | An optional element(keyword or argument) is enclosed in square brackets. |
| | | A vertical line indicates a choice within an optional or required set of keywords or arguments. |
| [x | y] | Square brackets enclosing keywords or arguments separated by a vertical line indicate an optional choice. |
| {x | y} | Braces enclosing keywords or arguments separated by a vertical line indicate a required choice. |
| [x {y | z}] | Braces and a vertical line within square brackets indicate a required choice within an optional element. |
| screen | Examples of information displayed on the screen are set in Courier font. |
| boldface screen | Examples of text that you must enter are set in Courier bold font. |
|
| Angle brackets enclose text that is not printed to the screen, such as passwords. |
| ! | A comment line is indicated by an exclamation point at the beginning of a line. |