GNU Rush |
|
Restricted User Shell |
Sergey Poznyakoff |
Configuration file consists of statements and comments.
A comment is any line whose first non-whitespace character is ‘#’. Empty lines and comments are ignored.
A statement consists of a keyword and optional argument,
separated by any amount of whitespace. Depending on the keyword, the
statement may treat its argument as a single value or as multiple values.
For example, the command
instruction takes a single
value as its argument, so parsing the statement
command ^scp -t /incoming/
results in keyword ‘command’ and value ‘^scp -t /incoming/’.
If the keyword requires multiple values, its argument is split into words using the following algorithm:
Arguments, obtained as a result of rules (1) and (2) are subject to backslash interpretation, during which the following escape sequences are replaced with single characters, as described in the table below:
Sequence | Replaced with |
\a | Audible bell character (ASCII 7) |
\b | Backspace character (ASCII 8) |
\f | Form-feed character (ASCII 12) |
\n | Newline character (ASCII 10) |
\r | Carriage return character (ASCII 13) |
\t | Horizontal tabulation character (ASCII 9) |
\v | Vertical tabulation character (ASCII 11) |
Any escape sequence not listed in this table is replaced with its second character.
Statements are delimited by newline characters. Length of a statement line is not limited. To improve readability, long statements may be split over several lines by using backslash (‘\’) as a last character on line. Thus, the following statement:
usage-error Contact your\ system administrator
is equivalent to:
usage-error Contact your system administrator
This document was generated on June 29, 2019 using makeinfo.
Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.