diff options
| -rw-r--r-- | man/clear.md | 9 | ||||
| -rw-r--r-- | man/env.md | 22 | ||||
| -rw-r--r-- | man/ls.md | 20 | ||||
| -rw-r--r-- | man/mdv.md | 16 | ||||
| -rw-r--r-- | man/pager.md | 20 | ||||
| -rw-r--r-- | man/powerctl.md | 32 | ||||
| -rw-r--r-- | man/print.md | 9 | ||||
| -rw-r--r-- | man/read.md | 40 | ||||
| -rw-r--r-- | man/smash.md | 40 | ||||
| -rw-r--r-- | man/tctl.md | 24 | ||||
| -rw-r--r-- | man/write.md | 9 |
11 files changed, 241 insertions, 0 deletions
diff --git a/man/clear.md b/man/clear.md new file mode 100644 index 0000000..e78bd35 --- /dev/null +++ b/man/clear.md @@ -0,0 +1,9 @@ +# clear + +Clears the screen and moves the cursor to the top left. + +## Usage + +``` +$ clear +``` diff --git a/man/env.md b/man/env.md new file mode 100644 index 0000000..bf142b4 --- /dev/null +++ b/man/env.md @@ -0,0 +1,22 @@ +# env + +Read and write the environment of a process. + +## Usage + +Read the current environment +``` +$ env +``` + +Run a new process under a new environment +``` +$ env -f file command [args...] +``` + + +## Notices + +If you run a command under the new environment, the environment is only +**changed** not reset. So the variables which are not touched by the file +stay the same. diff --git a/man/ls.md b/man/ls.md new file mode 100644 index 0000000..4839115 --- /dev/null +++ b/man/ls.md @@ -0,0 +1,20 @@ +# ls + +List entries of a directory + +## Usage + +``` +$ ls [path] +``` + +To list all entries (also the hidden ones starting with '.') + +``` +$ ls -a [path] +``` + + +## Notice + +If the path is omitted the current working directory is listed. diff --git a/man/mdv.md b/man/mdv.md new file mode 100644 index 0000000..a9eb73f --- /dev/null +++ b/man/mdv.md @@ -0,0 +1,16 @@ +# mdv + +Markdown viewer which prints a markdown file in a pretty format. +This view is the result of mdv, because all manuals are written +in markdown. + +## Usage + +``` +$ ... | mdv +``` + +## Notice + +By design, **mdv** does only reads from stdin, so if you wish to view a file, +use **read** and pipe it into mdv diff --git a/man/pager.md b/man/pager.md new file mode 100644 index 0000000..52a0db5 --- /dev/null +++ b/man/pager.md @@ -0,0 +1,20 @@ +# pager + +A simple pager which shows the standart input in a scrollable format. + +## Keymaps + +- j scroll down +- k scroll up +- <esc> exit +- q exit + +## Usage + +``` +$ ... | pager +``` + +## Notice + +To open a file in the pager use **read** and pipe it into pager. diff --git a/man/powerctl.md b/man/powerctl.md new file mode 100644 index 0000000..bcf9c92 --- /dev/null +++ b/man/powerctl.md @@ -0,0 +1,32 @@ +# powerctl + +Controll the state of your system. + +## Usage + +Poweroff the system +``` +$ powerctl poweroff +``` + +Reboot the system + +``` +$ powerctl reboot +``` + +Halt the system +``` +$ powerctl halt +``` + +Hard-reset the system + +``` +$ powerctl hard-reset +``` + +Suspend the system +``` +$ powerctl suspend +``` diff --git a/man/print.md b/man/print.md new file mode 100644 index 0000000..d2c69b7 --- /dev/null +++ b/man/print.md @@ -0,0 +1,9 @@ +# print + +Print the arguments to the standart output. + +## Usage + +``` +$ print Hello, World +``` diff --git a/man/read.md b/man/read.md new file mode 100644 index 0000000..a43fd1c --- /dev/null +++ b/man/read.md @@ -0,0 +1,40 @@ +# read + +Read a file or from standart input. It also concatinates them if given more then one. + +## Usage + +Read from stdin +``` +$ read +``` + +Read from a file + +``` +$ read <file> +``` + +Concatinate two files + +``` +$ read <file> <file> +``` + +Concatinate a file and stdin + +``` +$ read <file> - +``` + +Read only one line + +``` +$ read -l +``` + + +## Notice + +The **-** stands for the standart input. +The **-l** is mostly useful for a prompt in scripts. 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. diff --git a/man/tctl.md b/man/tctl.md new file mode 100644 index 0000000..a9c8231 --- /dev/null +++ b/man/tctl.md @@ -0,0 +1,24 @@ +# tctl + +Terminal control, set or get the terminal width and height + +## Usage + +Get the terminal width and height +``` +$ tctl +``` + +Set the terminal width and height +``` +$ tctl -w <width> -h <height> +``` + + +## Notice + +The width and height is printet in the following format: + +``` +<width>x<height> +``` diff --git a/man/write.md b/man/write.md new file mode 100644 index 0000000..c5db029 --- /dev/null +++ b/man/write.md @@ -0,0 +1,9 @@ +# write + +Write the standart input to a file + +## Usage + +``` +$ write <file> +``` |