aboutsummaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2021-01-28 22:17:15 -0800
committerBruce Hill <bruce@bruce-hill.com>2021-01-28 22:17:15 -0800
commit7daa148e946d234de88c185dcf5e75000d73fdb8 (patch)
treeb87e2c740fe705a8df48602dc48352e9d3f46d00 /API.md
parent2aa5f544a7a03c1ad59c70ed149911aa3ece0898 (diff)
Renamed $BBCURSOR -> $BB for concision
Diffstat (limited to 'API.md')
-rw-r--r--API.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/API.md b/API.md
index 71bbd1b..ea2e9f2 100644
--- a/API.md
+++ b/API.md
@@ -30,7 +30,7 @@ own version there.
failure if the user does not press 'y'.
- `bbpause`: Display a "press any key to continue" message and wait for a keypress.
- `bbpick [prompt]`: Select one of `NULL`-delimited multiple inputs and print it.
-- `bbtargets "$BBCMD" "$@"`: If `$BBCURSOR` is not currently among `$@` (the
+- `bbtargets "$BBCMD" "$@"`: If `$BB` is not currently among `$@` (the
selected files), this script prompts the user to ask whether they want to
perform an action on the selected files, or on the cursor. The result is
printed as `cursor` or `selected`.
@@ -41,7 +41,7 @@ own version there.
When `bb` runs scripts, following values are provided as environment variables:
- `$@` (the list of arguments): the full paths of the selected files
-- `$BBCURSOR`: the full path of the file under the cursor
+- `$BB`: the full path of the file under the cursor
- `$BBDEPTH`: the number of `bb` instances deep (in case you want to run a
shell and have that shell print something special in the prompt)
- `$BBCMD`: a file to which `bb` commands can be written (used internally)