This repository has been archived by the owner on Sep 4, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Configuration
Gustav Dersjö edited this page Dec 16, 2020
·
1 revision
TBD.
The standards outlined here shall be used in all wiki pages for this project. They exist to improve readability and make it easier to understand the requirements for certain sequences, commands and arguments.
NOTE: Unless marked as literal, spaces are not to be taken literally, and are only there to improve readability.
- Escaping:
\arg(read asarg) - Optional argument:
[arg] - Required argument:
<arg> - Default value:
{arg} - Miscellaneous info:
(arg) - Multiple arguments can be supplied:
arg... - Literal
"arg"orarg - Acronym or predefined value
$arg- For example
$ESCrefers to character 27, "escape". - See predefined values.
- For example
-
%d: Single numeric only. -
%a: Single alphanumeric character only. -
%l: Single letter only. -
%s: String (any length unless specified otherwise in a custom condition). -
%(<custom condition>): Custom condition(s). -
...can be suffixed to indicate that any amount greater than 0 is accepted
- Specify a custom length:
%a(length 1-5) - Specify a custom range:
%a(range 9-1005)
More values can be defined in each wiki page, these are just some common ones. Additional values are usually at the bottom of said pages, or explained in tables with acronyms. Uppercase letters are not required, but strongly recommended. If uppercase is not suitable then CamelCase is another option.
-
$ESC: "Escape", character 27. -
$CSI: Control Sequence Inducer, AKA$ESC\[ -
$SP: "Space", character 32.