aboutsummaryrefslogtreecommitdiff
path: root/tmux/.tmux/plugins/dwm.tmux/README.md
diff options
context:
space:
mode:
authorKumar Damani <damani.kumar@gmail.com>2019-12-09 00:13:52 +0000
committerKumar Damani <damani.kumar@gmail.com>2019-12-09 00:13:52 +0000
commit63ad7837556192589799261cdccc28ee3002b36e (patch)
tree34523192bcac71533d895653bd413455dbaf7e71 /tmux/.tmux/plugins/dwm.tmux/README.md
parentbad72a6710ac3a8d78c98327d9b9f7e987751862 (diff)
updated mutt and st
Diffstat (limited to 'tmux/.tmux/plugins/dwm.tmux/README.md')
-rw-r--r--tmux/.tmux/plugins/dwm.tmux/README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/tmux/.tmux/plugins/dwm.tmux/README.md b/tmux/.tmux/plugins/dwm.tmux/README.md
new file mode 100644
index 0000000..c971e77
--- /dev/null
+++ b/tmux/.tmux/plugins/dwm.tmux/README.md
@@ -0,0 +1,43 @@
+dwm.tmux
+===
+[dwm](http://dwm.suckless.org/)-inspired tiling pane management for Tmux.
+
+![](https://raw.githubusercontent.com/saysjonathan/dwm.tmux/master/screenshot.png)
+
+## Usage
+dwm.tmux defines several keybindings to assist with pane management:
+
+- `Meta-N` Create a new pane and place it in the Main pane
+- `Meta-W` Create a new pane starting in the same directory and place it in the Main pane
+- `Meta-C` Close the current pane. If the pane is in the Main pane, close the pane and promote the first pane in the stack to the Main pane
+- `Meta-J` Select the next pane (clockwise)
+- `Meta-K` Select the previous pane (counterclockwise)
+- `Meta-,` Rotate panes counterclockwise
+- `Meta-.` Rotate panes clockwise
+- `Meta-R` Refresh layout
+- `Meta-space` Place select pane in the Main pane
+- `Meta-m` Zoom selected pane
+
+## Details
+
+Similar to dwm, windows are always organised as follows:
+
+```
+ ====================================
+| | S1 |
+| |==================
+| M(0) | S2 |
+| |==================
+| | S3 |
+ ====================================
+```
+
+A large Master pane is placed on the left side of the screen while a stack of smaller panes is placed on the right. The Master pane is always pane 0, while the stack of panes is numbered sequentially in ascending order.
+
+## Setup
+To use dwm.tmux:
+
+- `git clone git@github.com/saysjonathan/dwm.tmux.git $HOME/.dwm.tmux`
+- `echo 'source-file $HOME/.dwm.tmux/dwm.tmux' >> $HOME/.tmux.conf`
+
+dwm.tmux requires tmux > 2.0.