Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request] improve documentation for options #174

Open
Jasha10 opened this issue Sep 22, 2023 · 1 comment
Open

[Feature Request] improve documentation for options #174

Jasha10 opened this issue Sep 22, 2023 · 1 comment

Comments

@Jasha10
Copy link

Jasha10 commented Sep 22, 2023

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
Copy link
Author

Jasha10 commented Sep 22, 2023

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

Mappings defined via tmux-yank:

  • y => yank in copy-mode and copy-mode-vi, controlled by @copy_mode_yank
  • Y => put in copy-mode and copy-mode-vi, controlled by @copy_mode_put
  • M-y => yank&put in copy-mode and copy-mode-vi, controlled by @copy_mode_yank_put
  • ! => yank&put w/o newline in copy-mode and copy-mode-vi, controlled by @copy_mode_yank_put_wo_newline
  • prefix + y => yank line in normal mode, controlled by @yank_line
  • prefix + Y => yank $PWD in normal mode, controlled by @yank_pane_pwd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant