Merge pull request #66 from jjant/patch-1

Show initial values of modified options

.gitattributes

@@ -0,0 +1,2 @@
+# Force text files to have unix eols, so Windows/Cygwin does not break them
+*.* eol=lf

CHANGELOG.md

@@ -1,6 +1,42 @@
 # Changelog
 
 ### master
+- remove `detach-on-destroy`
+- do not set `aggressive-resize` on iTerm terminal
+- disable `detach-on-destroy`
+
+### v3.0.0, 2015-06-24
+- remove 'almost sensible' feature
+
+### v2.3.0, 2015-06-24
+- update to support \*THE\* latest tmux version
+- bugfix for `prefix + R` key binding
+- fix for tmux 2.0 `default-terminal` option (thanks @kwbr)
+
+### v2.2.0, 2015-02-10
+- bugfix in `key_binding_not_set`: the regex is now properly detecting key
+  bindings with `-r` flag.
+- enable `aggressive-resize`
+
+### 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

README.md

@@ -1,23 +1,20 @@
 # 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).
 
+Tested and working on Linux, OSX and Cygwin.
+
 ### 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,30 +22,76 @@ 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`.
+```tmux
+# Address vim mode switching delay (http://superuser.com/a/252717/65504)
+set -s escape-time 0
 
-    # set prefix to `Ctrl-a`
-    tmux set-option -g prefix C-a
-    tmux unbind-key C-b
+# Increase scrollback buffer size from 2000 to 50000 lines
+set -g history-limit 50000
 
-Since user defined `.tmux.conf` settings are respected, if prefix is set to
-`Ctrl-z` - it won't be overriden!
+# Increase tmux messages display duration from 750ms to 4s
+set -g display-time 4000
+
+# Refresh 'status-left' and 'status-right' more often, from every 15s to 5s
+set -g status-interval 5
+
+# (OS X) Fix pbcopy/pbpaste for old tmux versions (pre 2.6)
+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
+
+# Super useful when using "grouped sessions" and multi-monitor setup
+setw -g aggressive-resize on
+```
+
+### Key bindings
+
+```tmux
+# 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.
+
+```tmux
+# Source .tmux.conf as suggested in `man tmux`
+bind R source-file '~/.tmux.conf'
+```
+
+"Adaptable" key bindings that build upon your `prefix` value:
+
+```tmux
+# 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.
 
 ### 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 "             \
-      tmux-plugins/tpm                \
-      tmux-plugins/tmux-sensible      \
-    "
+```tmux
+set -g @plugin 'tmux-plugins/tmux-sensible'
+```
 
 Hit `prefix + I` to fetch the plugin and source it. That's it!
 
-You might also want to restart your tmux server, just in case.
-
 ### Manual Installation
 
 Clone the repo:
@@ -57,14 +100,11 @@ Clone the repo:
 
 Add this line to the bottom of `.tmux.conf`:
 
-    run-shell ~/clone/path/sensible.tmux
+```tmux
+run-shell ~/clone/path/sensible.tmux
+```
 
-Reload TMUX environment:
-
-    # type this in terminal
-    $ tmux source-file ~/.tmux.conf
-
-You might also want to restart your tmux server, just in case.
+Reload TMUX environment with `$ tmux source-file ~/.tmux.conf`, and that's it.
 
 ### Other goodies
 
@@ -74,6 +114,8 @@ You might also find these useful:
   improve tmux search and reduce mouse usage
 - [pain control](https://github.com/tmux-plugins/tmux-pain-control)
   useful standard bindings for controlling panes
+- [resurrect](https://github.com/tmux-plugins/tmux-resurrect)
+  persists tmux environment across system restarts
 
 ### License
 

sensible.tmux

@@ -2,49 +2,82 @@
 
 CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
+# used to match output from `tmux list-keys`
+KEY_BINDING_REGEX="bind-key[[:space:]]\+\(-r[[:space:]]\+\)\?\(-T prefix[[:space:]]\+\)\?"
+
 is_osx() {
 	local platform=$(uname)
 	[ "$platform" == "Darwin" ]
 }
 
+iterm_terminal() {
+	[[ "${TERM_PROGRAM}" =~ ^iTerm || "${LC_TERMINAL}" =~ ^iTerm ]]
+}
+
+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() {
-	local key="$1"
-	if $(tmux list-keys | grep -q "bind-key[[:space:]]\+${key}"); then
+	local key="${1//\\/\\\\}"
+	if $(tmux list-keys | grep -q "${KEY_BINDING_REGEX}${key}[[:space:]]"); then
 		return 1
 	else
 		return 0
 	fi
 }
 
+key_binding_not_changed() {
+	local key="$1"
+	local default_value="$2"
+	if $(tmux list-keys | grep -q "${KEY_BINDING_REGEX}${key}[[:space:]]\+${default_value}"); then
+		# key still has the default binding
+		return 0
+	else
+		return 1
+	fi
+}
+
+get_tmux_config() {
+	local tmux_config_xdg="${XDG_CONFIG_HOME:-$HOME/.config}/tmux/tmux.conf"
+	local tmux_config="$HOME/.tmux.conf"
+
+	if [ -f "${tmux_config_xdg}" ]; then
+		echo "${tmux_config_xdg}"
+	else
+		echo ${tmux_config}
+	fi
+}
+
 main() {
 	# OPTIONS
 
-	# enable utf8
-	tmux set-option -g utf8 on
-
-	# 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,34 +99,53 @@ 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
+	# upgrade $TERM, tmux 1.9
 	if option_value_not_changed "default-terminal" "screen"; then
 		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
+	# upgrade $TERM, tmux 2.0+
+	if server_option_value_not_changed "default-terminal" "screen"; then
+		tmux set-option -s default-terminal "screen-256color"
+	fi
 
 	# 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
+	# super useful when using "grouped sessions" and multi-monitor setup
+	if ! iterm_terminal; then
+		tmux set-window-option -g aggressive-resize 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 obsolete 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
@@ -106,9 +158,11 @@ main() {
 
 	# source `.tmux.conf` file - as suggested in `man tmux`
 	if key_binding_not_set "R"; then
-		tmux bind-key R run-shell -b ' \
-			tmux source-file ~/.tmux.conf > /dev/null; \
-			tmux display-message "Sourced .tmux.conf!"'
+		local tmux_config=$(get_tmux_config)
+
+		tmux bind-key R run-shell " \
+			tmux source-file ${tmux_config} > /dev/null; \
+			tmux display-message 'Sourced ${tmux_config}!'"
 	fi
 }
 main