Bruce/bb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Version bump and documentation updates.

Browse Source
This commit is contained in:
Bruce Hill 2020-04-09 00:08:26 -07:00
parent e0a30fe02b
commit 9114b41b98
2 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
API.md
View File

@ -9,9 +9,23 @@ internal state.
## Helper Functions ## 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:<key>:<script>`
- `bbshutdown`: The script run when `bb` exits. The default implementation saves
the current configuration settings to `~/.local/share/bb/settings.sh`, which
is run by `bbstartup` to restore the settings at launch.
- `bbask [-1] [prompt [initial]]`: Get user input in a standardized and
customizable way and output it to `STDOUT`. customizable way and output it to `STDOUT`.
- `bbcmd <cmd>*`: used for modifying `bb`'s internal state (see BB Commands). - `bbcmd <cmd>*`: Modify`bb`'s internal state (see BB Commands).
- `bbconfirm [prompt]`: Display a "Is this okay? [y/N]" prompt and exit with - `bbconfirm [prompt]`: Display a "Is this okay? [y/N]" prompt and exit with
failure if the user does not press 'y'. failure if the user does not press 'y'.
- `bbpause`: Display a "press any key to continue" message and wait for a keypress. - `bbpause`: Display a "press any key to continue" message and wait for a keypress.
@ -24,8 +38,7 @@ internal state.
## Environment Variables ## Environment Variables
For startup commands and key bindings, the following values are provided as When `bb` runs scripts, following values are provided as environment variables:
environment variables:
- `$@` (the list of arguments): the full paths of the selected files - `$@` (the list of arguments): the full paths of the selected files
- `$BBCURSOR`: the full path of the file under the cursor - `$BBCURSOR`: the full path of the file under the cursor

2
bb.1
View File

@ -1,6 +1,6 @@
.\" Manpage for bb. .\" Manpage for bb.
.\" Contact bruce@bruce-hill.com to correct errors or typos. .\" Contact bruce@bruce-hill.com to correct errors or typos.
.TH man 1 "23 Feb 2020" "0.26" "bb manual page" .TH man 1 "23 Feb 2020" "0.27" "bb manual page"
.SH NAME .SH NAME
bb \- A bitty browser for command line file management bb \- A bitty browser for command line file management
.SH SYNOPSIS .SH SYNOPSIS