diff --git a/API.md b/API.md index ce92b1c..71bbd1b 100644 --- a/API.md +++ b/API.md @@ -9,9 +9,23 @@ internal state. ## Helper Functions -- `bbask [-1] [prompt [initial]]`: get user input in a standardized and +`bb` is bundled with some helper scripts for performing common tasks. These +scripts are installed to `/etc/xdg/bb/`, which is added to `bb`'s `$PATH` +environment variable at runtime. `~/.config/bb/` is also added to the `$PATH` +with higher priority, so you can override any of these scripts by putting your +own version there. + +- `bbstartup`: The script run when `bb` first launches. It calls `bbbindkeys` by + default and sets up some configuration settings like which columns to display. +- `bbbindkeys`: The script called by `bb` to create all of `bb`'s key bindings. + It's currently very hacky, but it amounts to a bunch of calls to `bbcmd + bind::