derped/tmux-kanagawa
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

chore: update INSTALL.md

Browse source
This commit is contained in:
Nybkox 2023-12-21 03:56:58 +01:00 committed by Kevin Baensch
parent 476a850ddb
commit 48d53e8646
No known key found for this signature in database
1 changed files with 20 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
INSTALL.md
View file

@ -4,7 +4,7 @@
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: 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' set -g @plugin 'Nybkox/tmux-kanagawa'
Add any configuration options below this line in your tmux config. Add any configuration options below this line in your tmux config.
@ -21,7 +21,7 @@ programs.tmux = {
sensible sensible
yank yank
{ {
plugin = dracula; plugin = kanagawa;
extraConfig = '' extraConfig = ''
set -g @kanagawa-show-battery false set -g @kanagawa-show-battery false
set -g @kanagawa-show-powerline true set -g @kanagawa-show-powerline true
@ -188,6 +188,7 @@ You can configure which server (hostname, IP) you want to ping and at which rate
set -g @kanagawa-ping-server "google.com" set -g @kanagawa-ping-server "google.com"
set -g @kanagawa-ping-rate 5 set -g @kanagawa-ping-rate 5
``` ```
### ssh-session options ### ssh-session options
Show SSH session port Show SSH session port
@ -217,43 +218,51 @@ set -g @kanagawa-military-time true
``` ```
Set custom time format e.g (2023-01-01 14:00) Set custom time format e.g (2023-01-01 14:00)
```bash ```bash
set -g @kanagawa-time-format "%F %R" set -g @kanagawa-time-format "%F %R"
``` ```
See [[this page]](https://man7.org/linux/man-pages/man1/date.1.html) for other format symbols. See [[this page]](https://man7.org/linux/man-pages/man1/date.1.html) for other format symbols.
#### git options #### git options
Hide details of git changes Hide details of git changes
```bash ```bash
set -g @kanagawa-git-disable-status true set -g @kanagawa-git-disable-status true
``` ```
Set symbol to use for when branch is up to date with HEAD Set symbol to use for when branch is up to date with HEAD
```bash ```bash
# default is ✓. Avoid using non unicode characters that bash uses like $, * and ! # default is ✓. Avoid using non unicode characters that bash uses like $, * and !
set -g @kanagawa-git-show-current-symbol ✓ set -g @kanagawa-git-show-current-symbol ✓
``` ```
Set symbol to use for when branch diverges from HEAD Set symbol to use for when branch diverges from HEAD
```bash ```bash
# default is unicode !. Avoid bash special characters # default is unicode !. Avoid bash special characters
set -g @kanagawa-git-show-diff-symbol ! set -g @kanagawa-git-show-diff-symbol !
``` ```
Set symbol or message to use when the current pane has no git repo Set symbol or message to use when the current pane has no git repo
```bash ```bash
# default is unicode no message # default is unicode no message
set -g @kanagawa-git-no-repo-message "" set -g @kanagawa-git-no-repo-message ""
``` ```
Hide untracked files from being displayed as local changes Hide untracked files from being displayed as local changes
```bash ```bash
# default is false # default is false
set -g @kanagawa-git-no-untracked-files true set -g @kanagawa-git-no-untracked-files true
``` ```
Show remote tracking branch together with diverge/sync state Show remote tracking branch together with diverge/sync state
```bash ```bash
# default is false # default is false
set -g @kanagawa-git-show-remote-status true set -g @kanagawa-git-show-remote-status true
@ -262,29 +271,34 @@ set -g @kanagawa-git-show-remote-status true
#### hg options #### hg options
Hide details of hg changes Hide details of hg changes
```bash ```bash
set -g @kanagawa-hg-disable-status true set -g @kanagawa-hg-disable-status true
``` ```
Set symbol to use for when branch is up to date with HEAD Set symbol to use for when branch is up to date with HEAD
```bash ```bash
#default is ✓.Avoid using non unicode characters that bash uses like $, * and ! #default is ✓.Avoid using non unicode characters that bash uses like $, * and !
set -g @kanagawa-hg-show-current-symbol ✓ set -g @kanagawa-hg-show-current-symbol ✓
``` ```
Set symbol to use for when branch diverges from HEAD Set symbol to use for when branch diverges from HEAD
```bash ```bash
#default is unicode !.Avoid bash special characters #default is unicode !.Avoid bash special characters
set -g @kanagawa-hg-show-diff-symbol ! set -g @kanagawa-hg-show-diff-symbol !
``` ```
Set symbol or message to use when the current pane has no hg repo Set symbol or message to use when the current pane has no hg repo
```bash ```bash
#default is unicode no message #default is unicode no message
set -g @kanagawa-hg-no-repo-message "" set -g @kanagawa-hg-no-repo-message ""
``` ```
Hide untracked files from being displayed as local changes Hide untracked files from being displayed as local changes
```bash ```bash
#default is false #default is false
set -g @kanagawa-hg-no-untracked-files false set -g @kanagawa-hg-no-untracked-files false
@ -317,6 +331,7 @@ Customize label
```bash ```bash
set -g @kanagawa-synchronize-panes-label "Sync" set -g @kanagawa-synchronize-panes-label "Sync"
``` ```
#### attached-clients options #### attached-clients options
Set the minimum number of clients to show (otherwise, show nothing) Set the minimum number of clients to show (otherwise, show nothing)
@ -354,7 +369,7 @@ set -g @kanagawa-kubernetes-eks-hide-arn true
Extract the account as a prefix to the cluster name - Available for EKS only (only available for cluster names that are ARNs) Extract the account as a prefix to the cluster name - Available for EKS only (only available for cluster names that are ARNs)
``` ````
set -g @kanagawa-kubernetes-eks-extract-account true set -g @kanagawa-kubernetes-eks-extract-account true
#### continuum options #### continuum options
@ -367,7 +382,7 @@ Set the output mode. Options are:
```bash ```bash
set -g @kanagawa-continuum-mode countdown set -g @kanagawa-continuum-mode countdown
``` ````
Show if the last save was performed less than 60 seconds ago (default threshold is 15 seconds) Show if the last save was performed less than 60 seconds ago (default threshold is 15 seconds)