Skip to content

Commit 74c4a76

Browse files
author
Bruno Sutic
committedAug 4, 2014
Big README update
1 parent 89a51c8 commit 74c4a76

File tree

2 files changed

+49
-12
lines changed

2 files changed

+49
-12
lines changed
 

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
- bugfix: determine the default shell from the $SHELL env var on OS X
55
- set `mode-mouse on` by default
66
- do not make any decision about the prefix, just enhance it
7+
- update `README.md`. List options set in the plugin.
78

89
### v1.0.0, 2014-07-30
910
- initial work on the plugin

‎README.md

+48-12
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,64 @@ Inspired by [vim-sensible](https://github.com/tpope/vim-sensible).
1313
- **no overriding** of user defined settings.<br/>
1414
Your existing `.tmux.conf` settings are respected and they won't be changed.
1515
That way you can use `tmux-sensible` if you have a few specific options.
16-
See [feature section](#example-feature) for an example.
17-
- [source code](https://github.com/tmux-plugins/tmux-sensible/blob/master/sensible.tmux)
18-
is the authoritative documentation.<br/>
19-
It's really not that scary and you should have a look, even if you're a
20-
tmux beginner.
2116

2217
### Goals
2318

2419
- group standard tmux community options in one place
2520
- remove clutter from your `.tmux.conf`
2621
- educate new tmux users about basic options
2722

28-
### Example feature
23+
### Options
2924

30-
Sets tmux prefix to `Ctrl-a`.
25+
# utf8 is on
26+
set -g utf8 on
27+
set -g status-utf8 on
3128

32-
# set prefix to `Ctrl-a`
33-
tmux set-option -g prefix C-a
34-
tmux unbind-key C-b
29+
# address vim mode switching delay (http://superuser.com/a/252717/65504)
30+
set -s escape-time 0
3531

36-
Since user defined `.tmux.conf` settings are respected, if prefix is set to
37-
`Ctrl-z` - it won't be overriden!
32+
# increase scrollback buffer size
33+
set -g history-limit 50000
34+
35+
# tmux messages are displayed for 4 seconds
36+
set -g display-time 4000
37+
38+
# refresh 'status-left' and 'status-right' more often
39+
set -g status-interval 5
40+
41+
# set only on OS X where it's required
42+
set -g default-command "reattach-to-user-namespace -l $SHELL"
43+
44+
# upgrade $TERM
45+
set -g default-terminal "screen-256color"
46+
47+
# enable all mouse features for terminals that support it
48+
setw -g mode-mouse on
49+
set -g mouse-resize-pane on
50+
set -g mouse-select-pane on
51+
set -g mouse-select-window on
52+
53+
# emacs key bindings in tmux command prompt (prefix + :) are better than
54+
# vi keys, even for vim users
55+
set -g status-keys emacs
56+
57+
### Key bindings
58+
59+
# easier and faster switching between next/prev window
60+
bind C-p previous-window
61+
bind C-n next-window
62+
63+
# source .tmux.conf as suggested in `man tmux`
64+
bind R source-file '~/.tmux.conf'
65+
66+
"Adaptable" key bindings that build upon your `prefix` value:
67+
68+
# if prefix is 'C-a'
69+
bind C-a send-prefix
70+
bind a last-window
71+
72+
If prefix is `C-b`, above keys will be `C-b` and `b`.<br/>
73+
If prefix is `C-z`, above keys will be `C-z` and `z`... you get the idea.
3874

3975
### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
4076

0 commit comments

Comments
 (0)
Failed to load comments.