diff options
| author | Nathan Reiner <nathan@nathanreiner.xyz> | 2023-02-10 00:10:40 +0100 |
|---|---|---|
| committer | Nathan Reiner <nathan@nathanreiner.xyz> | 2023-02-10 00:10:40 +0100 |
| commit | e9ab6b0a3ffcb69ed0868f9ec4b61e8f7ad36d85 (patch) | |
| tree | e99eddcf75128810e4afd988bf3ffacff8acf3e6 /man/smash.md | |
| parent | 5b47adb57b11acb2318053d710d075d37f669f76 (diff) | |
add manuals
Diffstat (limited to 'man/smash.md')
| -rw-r--r-- | man/smash.md | 40 |
1 files changed, 40 insertions, 0 deletions
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 <script> [args...] +``` + + +## Notice + +As you see is smash **not** POSIX-compliant. |