diff options
| author | Ellie Huxtable <ellie@elliehuxtable.com> | 2023-11-01 19:25:04 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-01 19:25:04 +0000 |
| commit | 61d05d04e9474f73c68065683a2d4e60b4b2b5f5 (patch) | |
| tree | 724c117abdd5df1e7ee12300ffcea4e7a87e8e5f | |
| parent | 8ac090a8107b7f094fd463420cee863cd2e9984b (diff) | |
Update docs (#1367)
| -rw-r--r-- | docs/docs/guide/index.md | 6 | ||||
| -rw-r--r-- | docs/docs/key-binding.md | 3 |
2 files changed, 6 insertions, 3 deletions
diff --git a/docs/docs/guide/index.md b/docs/docs/guide/index.md index 939ee46e..f78ee423 100644 --- a/docs/docs/guide/index.md +++ b/docs/docs/guide/index.md @@ -164,5 +164,7 @@ curl https://api.atuin.sh/enable -d $(cat ~/.local/share/atuin/session) The response includes the URL to your graph. Feel free to share and/or embed this URL, the token is _not_ a secret, and simply prevents user enumeration. - - + +## Known issues +- SQLite has some issues with ZFS in certain configurations. As Atuin uses SQLite, this may cause your shell to become slow! We have an [issue](https://github.com/atuinsh/atuin/issues/952) to track, with some workarounds +- SQLite also does not tend to like network filesystems (eg, NFS) diff --git a/docs/docs/key-binding.md b/docs/docs/key-binding.md index 02d00d5b..c0bd2885 100644 --- a/docs/docs/key-binding.md +++ b/docs/docs/key-binding.md @@ -136,6 +136,8 @@ $env.config = ( | Shortcut | Action | | ----------------------------------------- | ----------------------------------------------------------------------------- | +| enter | Execute selected item | +| tab | Select item and edit | | ctrl + r | Cycle through filter modes | | ctrl + s | Cycle through search modes | | alt + 1 to alt + 9 | Select item by the number located near it | @@ -155,7 +157,6 @@ $env.config = ( | ctrl + p / ctrl + k / ⬇ | Select the previous item on the list | | page down | Scroll search results one page down | | page up | Scroll search results one page up | -| enter | Select highlighted item | | ⬇ (with no entry selected) | Return original or return query depending on settings | | ⬇ | Select the next item on the list | |