darkcloud-tmuxconfig/README.md

41 lines
2.5 KiB
Markdown

# Darkcloud TMUX Config
## Features ##
* A custom theme that matches the one used in [darkcloud-vimconfig](https://github.com/prurigro/darkcloud-vimconfig).
* A bandwidth monitor showing the current upload and download speed of either **eth0** or the device you've set to **$NETDEV**.
* Sane defaults and a set of custom key bindings that group similar ideas and make frequently used commands easier to access.
* Optional support for powerline fonts that looks oh so much better when they're used :).
![Darkcloud TMUX Config Theme](http://i.imgur.com/Ps3XmMc.png)
## Installation ##
1. Choose either **tmux.powerline.conf** if powerline fonts are available or **tmux.normal.conf** if they're not, and install it to __/etc/tmux.conf__ for a system-wide install or __~/.tmux.conf__ for a local install.
2. Install **bwrate** to somewhere available in **$PATH** and make it executable (ie: `install -Dm755 bwrate /usr/local/bin/bwrate`)
3. If your network device isn't named **eth0**, set **$NETDEV** to the name of the device you'd like to use somewhere tmux will see it when it runs (ie: `echo 'export $NETDEV="wlan0"' >> ~/.bashrc`)
## Key Bindings ##
* **Prefix**: `Ctrl-Space`
* `m` and `Ctrl-m`: Toggle mouse mode on and off respectively.
* `\` and `Ctrl-\`: Toggle the status bar on and off respectively.
* `c` and `Ctrl-c`: Create a new pane and create a new pane in the current directory respectively.
* `[` and `]`: Split the window vertically and horizontally respectively.
* `{` and `}`: Rotate the window up and down respectively.
* `=` and `-`: Select an even layout horizontally and vertically respectively.
* `=` and `-`: Select a main layout horizontally and vertically respectively.
* `Space` and `Ctrl-Space`: Move to the previously selected window and pane respectively.
* `h`, `j`, `k` and `l`: Move left, down, up and right between panes respectively like the arrow keys.
* `` ` ``: Toggle synchronized input between the panes on the current window.
* `Escape`: Clear the terminal history, tmux history and the current window/pane.
* `?` and `/`: Show help for available key bindings and commands respectively.
* `y` and `Ctrl-p`: Enter __copy mode__ and paste from the copy buffer respectively.
* (**copy mode**) `v`, `y` and `Escape`: Begin selection, copy selection and cancel **copy mode** respectively.
## Credits ##
* Written by Kevin MacMartin: [GitHub Projects](https://github.com/prurigro) | [Arch Linux AUR Packages](https://aur.archlinux.org/packages/?SeB=m&K=prurigro)
## License ##
This config and the bwrate script are released under the MIT license.