6 Commits

Author SHA1 Message Date
c20bc5c4e2 v2.1.0 2014-12-12 23:25:39 +01:00
294e607f83 Deprecate "almost sensible" feature 2014-12-12 23:17:34 +01:00
d2565e5f10 Enable focus-events 2014-12-12 22:40:09 +01:00
babfd71d08 Update changelog and readme 2014-12-03 13:22:19 +01:00
c95eb0d88d Merge pull request #13 from m1foley/safe_bind_prefix
Don't overwrite $prefix if already bound
2014-12-03 13:19:50 +01:00
df5b537d21 Don't overwrite $prefix if already bound 2014-12-02 17:55:10 -08:00
3 changed files with 33 additions and 17 deletions

View File

@ -2,6 +2,12 @@
### master
### v2.1.0, 2014-12-12
- check before binding `prefix + prefix` (@m1foley)
- enable `focus-events`
- deprecate 'almost sensible' feature. The reason for this is to focus the
plugin on doing just one thing.
### v2.0.0, 2014-10-03
- bugfix: prevent exiting tmux if 'reattach-to-user-namespace' is not installed
- remove all mouse-related options

View File

@ -1,31 +1,26 @@
# Tmux sensible
A set of tmux options that should be acceptable for everyone.
A set of tmux options that should be acceptable to everyone.
Inspired by [vim-sensible](https://github.com/tpope/vim-sensible).
### Core principles
### Principles
- core `tmux-sensible` options should be acceptable to **every** tmux user!<br/>
If any option bothers you, please open an issue and it will probably be
updated (or removed).
- `tmux-sensible` options should be acceptable to **every** tmux user!<br/>
If any of the options bothers you, please open an issue and it will probably
be updated (or removed).
- if you think a new option should be added, feel free to open a pull request.
- **no overriding** of user defined settings.<br/>
Your existing `.tmux.conf` settings are respected and they won't be changed.
That way you can use `tmux-sensible` if you have a few specific options.
### Almost sensible principles
- widely used settings that do not make it into the 'core'
- explicitly enabled with `set -g @almost-sensible 'on'`
### Goals
- group standard tmux community options in one place
- remove clutter from your `.tmux.conf`
- educate new tmux users about basic options
### Core options
### Options
# utf8 is on
set -g utf8 on
@ -53,7 +48,10 @@ Inspired by [vim-sensible](https://github.com/tpope/vim-sensible).
# vi keys, even for vim users
set -g status-keys emacs
### Core key bindings
# focus events enabled for terminals that support them
set -g focus-events on
### Key bindings
# easier and faster switching between next/prev window
bind C-p previous-window
@ -75,7 +73,13 @@ allowing you to hold `Ctrl` and repeat `a + p`/`a + n` (if your prefix is
If prefix is `C-b`, above keys will be `C-b` and `b`.<br/>
If prefix is `C-z`, above keys will be `C-z` and `z`... you get the idea.
### Almost sensible options
### Almost sensible options - deprecated
**Note**: this feature is deprecated and will be removed from `tmux-sensible`
in the next major release. The reason for this is to focus this plugin on doing
just one thing (and hopefully doing it well).<br/>
If you were using 'almost sensible' the path forward is to move all the
below options to your `.tmux.conf`.
Activate these by putting `set -g @almost-sensible 'on'` in `.tmux.conf`.
@ -92,10 +96,10 @@ Activate these by putting `set -g @almost-sensible 'on'` in `.tmux.conf`.
Add plugin to the list of TPM plugins in `.tmux.conf`:
set -g @tpm_plugins " \
set -g @tpm_plugins ' \
tmux-plugins/tpm \
tmux-plugins/tmux-sensible \
"
'
Hit `prefix + I` to fetch the plugin and source it. That's it!

View File

@ -59,6 +59,7 @@ key_binding_not_changed() {
fi
}
# "almost sensible" is deprecated
almost_sensible_on() {
[ "$(tmux show-option -gvq "$ALMOST_SENSIBLE_OPTION")" == "on" ]
}
@ -106,7 +107,10 @@ main() {
# vi keys, even for vim users
tmux set-option -g status-keys emacs
# ALMOST SENSIBLE OPTIONS
# focus events enabled for terminals that support them
tmux set-option -g focus-events on
# ALMOST SENSIBLE OPTIONS - DEPRECATED
if almost_sensible_on; then
# C-a should be the Tmux default prefix, really
@ -132,7 +136,9 @@ main() {
fi
# pressing `prefix + prefix` sends <prefix> to the shell
tmux bind-key "$prefix" send-prefix
if key_binding_not_set "$prefix"; then
tmux bind-key "$prefix" send-prefix
fi
fi
# If Ctrl-a is prefix then `Ctrl-a + a` switches between alternate windows.