diff options
author | Dylan Araps <dylan.araps@gmail.com> | 2018-10-21 16:13:43 +1100 |
---|---|---|
committer | Dylan Araps <dylan.araps@gmail.com> | 2018-10-21 16:13:43 +1100 |
commit | 813b8aa5a99dc6279d918ee74f90af7c9ce6f4a1 (patch) | |
tree | 1701d97c746365c28baeb5cf1df856f0a9376412 | |
parent | 9269c20f92002fe406eb85c818cdf3a536a81585 (diff) |
docs: update
-rw-r--r-- | CONTRIBUTING.md | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f526907..34f663d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,11 +22,12 @@ | `PWD` | current dir. | `REPLY` | user input. | `f[@]` | every dir item. | -| `c` | total number of dir items. | | `g` | previous dir when navigating to a bookmark. | +| `c` | total number of dir items. | | `j` | last dir item that fits on the screen. | | `k` | first dir item that fits on the screen. | -| `l` | cursor position. | +| `l` | cursor position (and index to current dir item). | +| `m` | max number of dir items that fit on the screen. | | `l2[@]` | history of parent dir nest level. | @@ -74,3 +75,12 @@ # Components ## Scroll + +The scroll uses these variables for the math. + +| var | meaning | +| `c` | total number of dir items. | +| `j` | last dir item that fits on the screen. | +| `k` | first dir item that fits on the screen. | +| `l` | cursor position (and index to current dir item). | +| `m` | max number of dir items that fit on the screen. | |