tmux-plugins / tmux-yank

Tmux plugin for copying to system clipboard. Works on OSX, Linux and Cygwin.
https://tmux-plugins.github.io/tmux-yank/
MIT License
2.72k stars 122 forks source link

[Feature Request] improve documentation for options #174

Open Jasha10 opened 1 year ago

Jasha10 commented 1 year ago

The scripts/helpers.sh file defines a lot of configurable options that can be set in one's .tmux.conf file. It would be nice to have exhaustive documentation of these in README.md.

For example, you can do set -g @yank_line 'C-y' in your .tmux.conf to change the yank-line keybinding from prefix + y to prefix + C-y. Currently this is undocumented.

Jasha10 commented 1 year ago

Here is some (possibly incomplete?) documentation I've put together:

Mappings defined via tmux-yank: