From e9ab6b0a3ffcb69ed0868f9ec4b61e8f7ad36d85 Mon Sep 17 00:00:00 2001 From: Nathan Reiner Date: Fri, 10 Feb 2023 00:10:40 +0100 Subject: add manuals --- man/smash.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 man/smash.md (limited to 'man/smash.md') diff --git a/man/smash.md b/man/smash.md new file mode 100644 index 0000000..3bc021d --- /dev/null +++ b/man/smash.md @@ -0,0 +1,40 @@ +# smash + +The **sm**all **sh**ell is the default shell of the reX os. + +## Syntax + +### Pipe Stream + +``` +$ command [args...] | ... | command [args...] | command [args] +``` + +### Variables + +Variables are inserted in the location by indicating the following: + +``` +$ command arg1 arg2 $[variable] +``` + +Variables are set by the following: + +``` +$ [variable]=command [args...] [| ... | ...] +``` + + **IMPORTANT** `This is not implemented yet.` + +## Run a script + +You can run a script by providing its path to smash and every argument after it are forwarded to the script. + +``` +$ smash