aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: 116c0a257df0a0eb3d2b0ec143e49a1598bffd9a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
Tmux ColorTag Theme
-------------------

.. raw:: html

    <div align="center">
    <img src="https://raw.githubusercontent.com/Determinant/tmux-colortag/master/demo.gif" width="90%">
    </div>

Also...works for powerline haters using the default setting.

.. raw:: html

    <div align="center">
    <img src="https://raw.githubusercontent.com/Determinant/tmux-colortag/master/no-powerline-symbol.png" width="90%">
    </div>

What's This?
============

This is a very succinct theme that colors the window tags according to their
names. This means with a proper ``status-interval`` set in your tmux (see
below), it can even automatically change when various programs in your shell
runs!

Installation
============

- Make sure you have tmux plugin manager installed: https://github.com/tmux-plugins/tpm

- Add plugin to the list of TPM plugins in ``.tmux.conf``:

  ::
    
    set -g @plugin 'Determinant/tmux-colortag'

- Hit ``prefix`` + ``I`` to fetch the plugin and source it.

- Optional:

  - To immediately play with the main feature, try ``prefix`` (``Ctrl+b`` by default) + ``,`` and change the window name.
  - NOTE: tmux won't change the window name automatically once you set it manually. To test the auto-changing color, just run any command in your new window.

Customization
=============

- If you would like to use Powerline Symbols like shown in the demo, add the
  following line to the top of your ``.tmux.conf`` to enable them:

  ::

    TMUX_COLORTAG_USE_POWERLINE=yes

- If you don't like the existing powerline symbols, feel free to change them by
  specifying the following environment variables to override the default:

  - ``TMUX_ARROW_SYMBOL_L1``
  - ``TMUX_ARROW_SYMBOL_L2``
  - ``TMUX_ARROW_SYMBOL_R1``
  - ``TMUX_ARROW_SYMBOL_R2``

- For the best experience, this plugin assumes a short status update
  interval. To change it back, specify ``TMUX_COLORTAG_SET_INTERVAL=no`` or
  directly override the setting in your tmux config file.

- If you only want to color the tags (without changing other styles
  such as borders), specify ``TMUX_COLORTAG_TAG_ONLY=yes``.

- ``TMUX_COLORTAG_IDX_SEP`` controls the separator between the window index and name.

Update to the Latest Version
============================

- Hit ``prefix`` + ``U`` and choose this plugin.