updated README.md

README.md

@@ -1,32 +1,97 @@
 .tmux
 =====
 
-Self-contained, opinionated `.tmux.conf` configuration file.
+Self-contained, pretty and versatile `.tmux.conf` configuration file.
 
 ![Screenshot](https://cloud.githubusercontent.com/assets/553208/9889393/85e50e4e-5bfa-11e5-99d8-76572350803a.gif)
 
-The `master` branch targets tmux `HEAD`. You may want to use the `1.9` or `2.0`
+The `2.0` branch targets tmux `2.0`. You may want to use the `1.9` or `master`
 branch.
 
 Features
 --------
 
  - `C-a` acts as secondary prefix, while keeping default `C-b` prefix
- - visual theme inspired by [powerline](https://github.com/Lokaltog/powerline)
+ - visual theme inspired by [Powerline][]
- - [maximize any pane to a new window with `<prefix>+`](http://pempek.net/articles/2013/04/14/maximizing-tmux-pane-new-window/)
+ - [maximize any pane to a new window with `<prefix> +`](http://pempek.net/articles/2013/04/14/maximizing-tmux-pane-new-window/)
- - mouse mode toggle with `<prefix>m`
+ - mouse mode toggle with `<prefix> m`
  - automatic usage of `reattach-to-user-namespace` if available
  - laptop battery status
  - configurable new windows and panes behavior (optionally retain current path)
+ - [Facebook PathPicker][] integration if available
+ - [Urlview][] integration if available
 
-The "maximize any pane to a new window with `<prefix>+`" feature is different
+[Powerline]: https://github.com/Lokaltog/powerline
+[Facebook PathPicker]: https://facebook.github.io/PathPicker/
+[Urlview]: https://packages.debian.org/stable/misc/urlview
+
+This configuration uses the following bindings:
+
+ - `<prefix> C-c` creates a new session
+ - `<prefix> e` opens `~/.tmux.conf.local` with the editor defined by the
+   `$EDITOR` environment variable (defaults to `vim` when empty)
+ - `<prefix> r` reloads the configuration
+ - `<prefix> C-f` lets you switch to another session by name
+ - `<prefix> C-h` and `<prefix> C-l` let you navigate windows (default
+   `<prefix> n` and `<prefix> p` are unbound)
+ - `<prefix> Tab` brings you to the last active window
+ - `<prefix> h`, `<prefix> j`, `<prefix> k` and `<prefix> l` let you navigate
+   panes ala Vim
+ - `<prefix> H`, `<prefix> J`, `<prefix>` K`, `<prefix> L` let you resize panes
+ - `<prefix> <` and `<prefix> >` let you swap panes
+ - `<prefix> +` maximizes the current pane to a new window
+ - `<prefix> m` toggles mouse mode on or off
+ - `<prefix> U` launches Urlview (if available)
+ - `<prefix> F` launches Facebook PathPicker (if available)
+ - `<prefix> Enter` enters copy-mode
+ - `<prefix> b` lists the paste-buffers
+ - `<prefix> p` pastes from the top paste-buffer
+ - `<prefix> P` lets you choose the paste-buffer to paste from
+ - `C-l` clears both the screen and the history
+
+Additionaly, `vi-choice`, `vi-edit` and `vi-copy` named tables are adjusted
+   to closely match [my own Vim configuration][]
+
+[my own Vim configuration]: https://github.com/gpakosz/.vim.git
+
+Bindings for the `vi-choice` mode-table:
+
+- `h` collapses the current tree node
+- `l` expands the current tree node
+- `H` collapes all the tree nodes
+- `L` expands all the tree nodes
+- `K` jumps to the start of list (tmux 2.0+)
+- `L` jumps to the end of list (tmux 2.0+)
+- `Escape` cancels the current operation
+
+Bindings for the `vi-edit` mode-table:
+
+- `H` jumps to the start of line
+- `L` jumps to the end of line
+- `q` cancels the current operation
+- `Escape` cancels the current operation
+
+Bindings for the `vi-copy` mode-table:
+
+- `v` begins selection / visual mode
+- `C-v` toggles between blockwise visual mode and visual mode
+- `H` jumps to the start of line
+- `L` jumps to the end of line
+- `y` copies the selection to the top paste-buffer
+- `Escape` cancels the current operation
+
+The "maximize any pane to a new window with `<prefix> +`" feature is different
 from stock `resize-pane -Z` as it allows you to further split a maximized pane.
 Also, you can maximize a pane to a new window, then change window, then go back
 and the pane is still in maximized state in its own window. You can then
-minimize a pane by using `<prefix>+` either from the source window or the
+minimize a pane by using `<prefix> +` either from the source window or the
 maximized window.
 
 ![Maximize pane](https://cloud.githubusercontent.com/assets/553208/9890858/ee3c0ca6-5c02-11e5-890e-05d825a46c92.gif)
+
+Mouse mode allows you to set the active window, set the active pane, resize
+panes and select switch to copy-mode to select text.
+
 ![Mouse mode](https://cloud.githubusercontent.com/assets/553208/9890797/8dffe542-5c02-11e5-9c06-a25b452e6fcc.gif)
 
 Installation
@@ -56,8 +121,27 @@ can change to alter different behaviors.
 
 ### Enabling the Powerline like visual theme
 
-You first need to install [fonts patched with powerline symbols][] (see also the
+Powerline originated as a status-line plugin for Vim. Its popular eye-cacthing
-[powerline manual][]).
+look is based on the use of special symbols: <img width="80" alt="Powerline Symbols" style="vertical-align: middle;" src="https://cloud.githubusercontent.com/assets/553208/10687156/1b76dda6-796b-11e5-83a1-1634337c4571.png" />
+
+To make use of these symbols, there are several options:
+
+- use a font that already bundles those: this is e.g. the case of the
+  [2.010R-ro/1.030R-it version][source code pro] of the Source Code Pro] font
+- use a [pre-patched font][powerline patched fonts]
+- use your preferred font along with the [Powerline font][powerline font] (that
+  only contains the Powerline symbols): this highly depends on your operating
+  system and your terminal emulator
+- [patch your preferred font][powerline font patcher] by adding the missing
+  Powerline symbols: this is the most difficult way and is no more documented in
+  the Powerline manual
+
+[source code pro]: https://github.com/adobe-fonts/source-code-pro/releases/tag/2.010R-ro%2F1.030R-it
+[powerline patched fonts]: https://github.com/powerline/fonts
+[powerline font]: https://github.com/powerline/powerline/raw/develop/font/PowerlineSymbols.otf
+[powerline font patcher]: https://github.com/powerline/fontpatcher
+
+Please see the [powerline manual] for further details.
 
 Then edit the `~/.tmux.conf.local` file and uncomment the following line: