v2.1.0

Don't overwrite $prefix if already bound

CHANGELOG.md

@@ -2,6 +2,26 @@
 
 ### 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
+- introduce 'almost sensible' setting and options
+
+### v1.1.0, 2014-08-30
+- bugfix: determine the default shell from the $SHELL env var on OS X
+- set `mode-mouse on` by default
+- do not make any decision about the prefix, just enhance it
+- update `README.md`. List options set in the plugin.
+- do *not* set `mode-mouse on` by default because some users don't like it
+- if a user changes default prefix but binds `C-b` to something else, do not
+  unbind `C-b`
+
 ### v1.0.0, 2014-07-30
 - initial work on the plugin
 - add readme

README.md

@@ -1,23 +1,18 @@
 # 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).
 
 ### Principles
 
 - `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).
+  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.
-  See [feature section](#example-feature) for an example.
-- [source code](https://github.com/tmux-plugins/tmux-sensible/blob/master/sensible.tmux)
-  is the authoritative documentation.<br/>
-  It's really not that scary and you should have a look, even if you're a
-  tmux beginner.
 
 ### Goals
 
@@ -25,25 +20,86 @@ Inspired by [vim-sensible](https://github.com/tpope/vim-sensible).
 - remove clutter from your `.tmux.conf`
 - educate new tmux users about basic options
 
-### Example feature
+### Options
 
-Sets tmux prefix to `Ctrl-a`.
+    # utf8 is on
+    set -g utf8 on
+    set -g status-utf8 on
 
-    # set prefix to `Ctrl-a`
-    tmux set-option -g prefix C-a
-    tmux unbind-key C-b
+    # address vim mode switching delay (http://superuser.com/a/252717/65504)
+    set -s escape-time 0
 
-Since user defined `.tmux.conf` settings are respected, if prefix is set to
-`Ctrl-z` - it won't be overriden!
+    # increase scrollback buffer size
+    set -g history-limit 50000
+
+    # tmux messages are displayed for 4 seconds
+    set -g display-time 4000
+
+    # refresh 'status-left' and 'status-right' more often
+    set -g status-interval 5
+
+    # set only on OS X where it's required
+    set -g default-command "reattach-to-user-namespace -l $SHELL"
+
+    # upgrade $TERM
+    set -g default-terminal "screen-256color"
+
+    # emacs key bindings in tmux command prompt (prefix + :) are better than
+    # vi keys, even for vim users
+    set -g status-keys emacs
+
+    # 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
+    bind C-n next-window
+
+Above bindings enhance the default `prefix + p` and `prefix + n` bindings by
+allowing you to hold `Ctrl` and repeat `a + p`/`a + n` (if your prefix is
+`C-a`), which is a lot quicker.
+
+    # source .tmux.conf as suggested in `man tmux`
+    bind R source-file '~/.tmux.conf'
+
+"Adaptable" key bindings that build upon your `prefix` value:
+
+    # if prefix is 'C-a'
+    bind C-a send-prefix
+    bind a last-window
+
+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 - 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`.
+
+    # C-a should be the Tmux default prefix, really
+    set -g prefix C-a
+    set -g mode-keys vi
+
+    # enable mouse features for terminals that support it
+    set -g mouse-resize-pane on
+    set -g mouse-select-pane on
+    set -g mouse-select-window on
 
 ### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
 
 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!
 

sensible.tmux

@@ -2,23 +2,41 @@
 
 CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
+ALMOST_SENSIBLE_OPTION="@almost-sensible"
+
 is_osx() {
 	local platform=$(uname)
 	[ "$platform" == "Darwin" ]
 }
 
+command_exists() {
+	local command="$1"
+	type "$command" >/dev/null 2>&1
+}
+
+# returns prefix key, e.g. 'C-a'
+prefix() {
+	tmux show-option -gv prefix
+}
+
+# if prefix is 'C-a', this function returns 'a'
+prefix_without_ctrl() {
+	local prefix="$(prefix)"
+	echo "$prefix" | cut -d '-' -f2
+}
+
 option_value_not_changed() {
 	local option="$1"
 	local default_value="$2"
 	local option_value=$(tmux show-option -gv "$option")
-	[ $option_value == $default_value ]
+	[ "$option_value" == "$default_value" ]
 }
 
 server_option_value_not_changed() {
 	local option="$1"
 	local default_value="$2"
 	local option_value=$(tmux show-option -sv "$option")
-	[ $option_value == $default_value ]
+	[ "$option_value" == "$default_value" ]
 }
 
 key_binding_not_set() {
@@ -30,6 +48,22 @@ key_binding_not_set() {
 	fi
 }
 
+key_binding_not_changed() {
+	local key="$1"
+	local default_value="$2"
+	if $(tmux list-keys | grep -q "bind-key[[:space:]]\+${key}[[:space:]]\+${default_value}"); then
+		# key still has the default binding
+		return 0
+	else
+		return 1
+	fi
+}
+
+# "almost sensible" is deprecated
+almost_sensible_on() {
+	[ "$(tmux show-option -gvq "$ALMOST_SENSIBLE_OPTION")" == "on" ]
+}
+
 main() {
 	# OPTIONS
 
@@ -39,12 +73,6 @@ main() {
 	# enable utf8 in tmux status-left and status-right
 	tmux set-option -g status-utf8 on
 
-	# set Ctrl-a as Tmux prefix
-	if option_value_not_changed "prefix" "C-b"; then
-		tmux set-option -g prefix C-a
-		tmux unbind-key C-b
-	fi
-
 	# address vim mode switching delay (http://superuser.com/a/252717/65504)
 	if server_option_value_not_changed "escape-time" "500"; then
 		tmux set-option -s escape-time 0
@@ -66,8 +94,8 @@ main() {
 	fi
 
 	# required (only) on OS X
-	if is_osx && option_value_not_changed "default-command" ""; then
-		tmux set-option -g default-command "reattach-to-user-namespace -l bash"
+	if is_osx && command_exists "reattach-to-user-namespace" && option_value_not_changed "default-command" ""; then
+		tmux set-option -g default-command "reattach-to-user-namespace -l $SHELL"
 	fi
 
 	# upgrade $TERM
@@ -75,25 +103,48 @@ main() {
 		tmux set-option -g default-terminal "screen-256color"
 	fi
 
-	# enable mouse features for terminals that support it
-	tmux set-option -g mouse-resize-pane on
-	tmux set-option -g mouse-select-pane on
-	tmux set-option -g mouse-select-window on
-
 	# emacs key bindings in tmux command prompt (prefix + :) are better than
 	# vi keys, even for vim users
 	tmux set-option -g status-keys emacs
 
-	# DEFAULT KEY BINDINGS
+	# focus events enabled for terminals that support them
+	tmux set-option -g focus-events on
 
-	# Ctrl-a + a   send `Ctrl-a` to the shell
-	if key_binding_not_set "a"; then
-		tmux bind-key a send-prefix
+	# ALMOST SENSIBLE OPTIONS - DEPRECATED
+
+	if almost_sensible_on; then
+		# C-a should be the Tmux default prefix, really
+		tmux set-option -g prefix C-a
+		tmux set-option -g mode-keys vi
+
+		# enable mouse features for terminals that support it
+		tmux set-option -g mouse-resize-pane on
+		tmux set-option -g mouse-select-pane on
+		tmux set-option -g mouse-select-window on
 	fi
 
-	# Ctrl-a + Ctrl-a   switch between alternate windows
-	if key_binding_not_set "C-a"; then
-		tmux bind-key C-a last-window
+	# DEFAULT KEY BINDINGS
+
+	local prefix="$(prefix)"
+	local prefix_without_ctrl="$(prefix_without_ctrl)"
+
+	# if C-b is not prefix
+	if [ $prefix != "C-b" ]; then
+		# unbind obsolte default binding
+		if key_binding_not_changed "C-b" "send-prefix"; then
+			tmux unbind-key C-b
+		fi
+
+		# pressing `prefix + prefix` sends <prefix> to the shell
+		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.
+	# Works for any prefix character.
+	if key_binding_not_set "$prefix_without_ctrl"; then
+		tmux bind-key "$prefix_without_ctrl" last-window
 	fi
 
 	# easier switching between next/prev window