docs: add docs for functions

sammyette 2021-10-16 15:38:49 -04:00
parent 54635072f6
commit afd999a7b0
No known key found for this signature in database
GPG Key ID: 50EE40A2809851F5
5 changed files with 43 additions and 0 deletions

docs/bait.txt 100644
View File

@ -0,0 +1,4 @@
catch(name, cb) > Catches a hook with `name`. Runs the `cb` when it is thrown
throw(name, ...args) > Throws a hook with `name` with the provided `args`

View File

@ -0,0 +1,4 @@
deregister(name) > Deregisters any command registered with `name`
register(name, cb) > Register a command with `name` that runs `cb` when ran

docs/fs.txt 100644
View File

@ -0,0 +1,8 @@
cd(dir) > Changes directory to `dir`
mkdir(name, recursive) > Makes a directory called `name`. If `recursive` is true, it will create its parent directories.
readdir(dir) > Returns a table of files in `dir`
stat(path) > Returns info about `path`

docs/global.txt 100644
View File

@ -0,0 +1,21 @@
alias(cmd, orig) > Sets an alias of `orig` to `cmd`
appendPath(dir) > Appends `dir` to $PATH
exec(cmd) > Replaces running hilbish with `cmd`
goro(fn) > Puts `fn` in a goroutine
interval(cb, time) > Runs the `cb` function every `time` milliseconds
multiprompt(str) > Changes the continued line prompt to `str`
prompt(str) > Changes the shell prompt to `str`
There are a few verbs that can be used in the prompt text.
These will be formatted and replaced with the appropriate values.
`%d` - Current working directory
`%u` - Name of current user
`%h` - Hostname of device
timeout(cb, time) > Runs the `cb` function after `time` in milliseconds

docs/hilbish.txt 100644
View File

@ -0,0 +1,6 @@
cwd() > Returns the current directory of the shell
flag(f) > Checks if the `f` flag has been passed to Hilbish.
run(cmd) > Runs `cmd` in Hilbish's sh interpreter