tmux-kanagawa/INSTALL.md

284 lines
6 KiB
Markdown
Raw Normal View History

### [tmux](https://github.com/tmux/tmux/wiki)
2020-12-01 01:03:04 +01:00
#### Install using [tpm](https://github.com/tmux-plugins/tpm)
If you are a tpm user, you can install the theme and keep up to date by adding the following to your .tmux.conf file:
set -g @plugin 'dracula/tmux'
2020-12-01 01:03:04 +01:00
Add any configuration options below this line in your tmux config.
#### Install with [Nix](https://nixos.org)
2020-11-30 02:50:23 +01:00
If you're using [home-manager](https://github.com/nix-community/home-manager), an example config would look similar to this:
Then run `home-manager switch`, the `Activating theme` section doesn't apply here.
```nix
programs.tmux = {
enable = true;
clock24 = true;
plugins = with pkgs.tmuxPlugins; [
sensible
yank
{
plugin = dracula;
extraConfig = ''
set -g @dracula-show-battery false
set -g @dracula-show-powerline true
set -g @dracula-refresh-rate 10
'';
}
];
extraConfig = ''
set -g mouse on
'';
};
```
#### Activating theme
1. Make sure `run -b '~/.tmux/plugins/tpm/tpm'` is at the bottom of your .tmux.conf
2. Run tmux
3. Use the tpm install command: `prefix + I` (default prefix is ctrl+b)
#### Configuration
To enable plugins set up the `@dracula-plugins` option in you `.tmux.conf` file, separate plugin by space.
The order that you define the plugins will be the order on the status bar left to right.
```bash
2022-11-11 04:31:24 +01:00
# available plugins: battery, cpu-usage, git, gpu-usage, ram-usage, tmux-ram-usage, network, network-bandwidth, network-ping, attached-clients, network-vpn, weather, time, spotify-tui, kubernetes-context
set -g @dracula-plugins "cpu-usage gpu-usage ram-usage"
```
For each plugin is possible to customize background and foreground colors
```bash
# available colors: white, gray, dark_gray, light_purple, dark_purple, cyan, green, orange, red, pink, yellow
# set -g @dracula-[plugin-name]-colors "[background] [foreground]"
set -g @dracula-cpu-usage-colors "pink dark_gray"
```
#### Status bar options
Enable powerline symbols
```bash
set -g @dracula-show-powerline true
```
Switch powerline symbols
```bash
# for left
set -g @dracula-show-left-sep 
# for right symbol (can set any symbol you like as seperator)
set -g @dracula-show-right-sep 
```
Enable window flags
```bash
set -g @dracula-show-flags true
```
Adjust the refresh rate for the status bar
```bash
# the default is 5, it can accept any number
set -g @dracula-refresh-rate 5
```
Switch the left smiley icon
```bash
# it can accept `session`, `smiley`, `window`, or any character.
set -g @dracula-show-left-icon session
```
Add padding to the left smiley icon
```bash
# default is 1, it can accept any number and 0 disables padding.
set -g @dracula-left-icon-padding 1
```
Enable high contrast pane border
```bash
set -g @dracula-border-contrast true
```
2023-04-08 20:56:40 +02:00
Hide empty plugins
```bash
set -g @dracula-show-empty-plugins false
```
#### cpu-usage options
Customize label
```bash
set -g @dracula-cpu-usage-label "CPU"
```
2021-12-22 23:32:41 +01:00
Show system load average instead of CPU usage percentage (default)
2021-12-22 23:11:09 +01:00
```bash
set -g @dracula-cpu-display-load true
```
2021-12-22 23:32:41 +01:00
CPU usage percentage (default) - in percentage (output: %)
Load average is the average system load calculated over a given period of time of 1, 5 and 15 minutes (output: x.x x.x x.x)
#### battery options
Customize label
```bash
set -g @dracula-battery-label "Battery"
```
#### gpu-usage options
2023-04-08 20:18:42 +02:00
Note, currently only the Linux NVIDIA Proprietary drivers are supported. Nouveau and AMD Graphics Cards support are still under development.
Customize label
```bash
set -g @dracula-gpu-usage-label "GPU"
```
#### ram-usage options
Customize label
```bash
set -g @dracula-ram-usage-label "RAM"
```
2022-11-11 04:31:24 +01:00
#### tmux-ram-usage options
Customize label
```bash
set -g @dracula-tmux-ram-usage-label "MEM"
```
#### network-bandwidth
You can configure which network interface you want to view the bandwidth,
Displaying of the interface name, The interval between each bandwidth update.
The most common interfaces name are `eth0` for a wired connection and `wlan0` for a wireless connection.
```bash
set -g @dracula-network-bandwidth eth0
set -g @dracula-network-bandwidth-interval 0
set -g @dracula-network-bandwidth-show-interface true
```
2021-12-23 00:50:24 +01:00
#### network-ping options
You can configure which server (hostname, IP) you want to ping and at which rate (in seconds). Default is google.com at every 5 seconds.
```bash
set -g @dracula-ping-server "google.com"
set -g @dracula-ping-rate 5
```
#### time options
Disable timezone
```bash
set -g @dracula-show-timezone false
```
Swap date to day/month
```bash
set -g @dracula-day-month true
```
Enable military time
```bash
set -g @dracula-military-time true
```
2021-07-27 04:57:16 +02:00
#### git options
Hide details of git changes
```bash
set -g @dracula-git-disable-status true
```
Set symbol to use for when branch is up to date with HEAD
```bash
# default is ✓. Avoid using non unicode characters that bash uses like $, * and !
2021-07-27 04:57:16 +02:00
set -g @dracula-git-show-current-symbol ✓
```
Set symbol to use for when branch diverges from HEAD
```bash
# default is unicode !. Avoid bash special characters
2021-07-27 04:57:16 +02:00
set -g @dracula-git-show-diff-symbol !
```
Set symbol or message to use when the current pane has no git repo
```bash
# default is unicode no message
set -g @dracula-git-no-repo-message ""
```
Hide untracked files from being displayed as local changes
```bash
# default is false
set -g @dracula-git-no-untracked-files true
```
2021-07-27 04:57:16 +02:00
Show remote tracking branch together with diverge/sync state
```bash
# default is false
set -g @dracula-git-show-remote-status true
```
2021-07-27 04:57:16 +02:00
#### weather options
Switch from default fahrenheit to celsius
```bash
set -g @dracula-show-fahrenheit false
```
2022-03-27 23:31:33 +02:00
Set your location manually
2022-03-27 23:28:41 +02:00
```bash
set -g @dracula-fixed-location "Some City"
```
2022-03-27 23:31:33 +02:00
Hide your location
2022-03-27 23:28:41 +02:00
```bash
set -g @dracula-show-location false
```
#### attached-clients options
Set the minimum number of clients to show (otherwise, show nothing)
```bash
set -g @dracula-clients-minimum 1
```
Set the label when there is one client, or more than one client
```bash
set -g @dracula-clients-singular client
set -g @dracula-clients-plural clients
```