Skip to content

Commit

Permalink
docs: document detach keybinding in README
Browse files Browse the repository at this point in the history
This is a fairly common thing to want to do,
we should include it in our README. Currently,
you need to go digging in CONFIG.md.
  • Loading branch information
ethanpailes committed Sep 18, 2024
1 parent 55be263 commit 62af231
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,16 @@ You can customize some of `shpool`s behavior by editing your
`~/.config/shpool/config.toml` file. For an in depth discussion
of configuration options see [CONFIG.md](./CONFIG.md).

### Keybindings

`shpool` supports keybindings (well really for the moment it
supports keybinding, but in principle we could add more).
For the moment, the only binding is `Ctrl-Space Ctrl-q`
to detach from the current session. If you wish, you can
[configure](./CONFIG.md#detach-keybinding) this to use
a different keybinding. The full list of supported binding
actions is defined by the `Action` enum in [`keybindings.rs`](./libshpool/src/daemon/keybindings.rs).

### Shell Config

##### bash
Expand Down

0 comments on commit 62af231

Please sign in to comment.