README.rst
1=============================================
2 tmux-mem-cpu-load
3=============================================
4---------------------------------------------
5CPU, RAM, and load monitor for use with tmux_
6---------------------------------------------
7
8.. image:: https://travis-ci.org/thewtex/tmux-mem-cpu-load.svg
9 :target: https://travis-ci.org/thewtex/tmux-mem-cpu-load
10
11.. image:: https://circleci.com/gh/thewtex/tmux-mem-cpu-load.svg?style=svg
12 :target: https://circleci.com/gh/thewtex/tmux-mem-cpu-load
13
14.. image:: https://github.com/thewtex/tmux-mem-cpu-load/actions/workflows/main.yml/badge.svg
15 :target: https://github.com/thewtex/tmux-mem-cpu-load/actions/workflows/main.yml
16
17Description
18===========
19
20A simple, lightweight program provided for system monitoring in the *status*
21line of **tmux**.
22
23The memory monitor displays the used and available memory.
24
25The CPU usage monitor outputs a percent CPU usage over all processors. It also
26displays a textual bar graph of the current percent usage.
27
28The system load average is also displayed.
29
30Example output::
31
32 2885/7987MB [||||| ] 51.2% 2.11 2.35 2.44
33
34 ^ ^ ^ ^ ^ ^ ^
35 | | | | | | |
36 1 2 3 4 5 6 7
37
381. Currently used memory.
392. Available memory.
403. CPU usage bar graph.
414. CPU usage percentage.
425. Load average for the past minute.
436. Load average for the past 5 minutes.
447. Load average for the past 15 minutes.
45
46For `terminals with 256 color support`_, graded colors can be displayed by
47passing the **--colors** flag.
48
49
50Installation
51============
52
53Dependencies
54------------
55
56Currently, Linux, Mac OSX, FreeBSD, OpenBSD, and NetBSD are supported.
57
58Building
59~~~~~~~~
60
61* >= CMake_ -2.6
62* C++ compiler with C++11 support (e.g. gcc/g++ >= 4.6)
63
64Download
65--------
66
67There are links to the source code at the `project homepage`_.
68
69Build
70-----
71
72::
73
74 cd <source dir>
75 cmake .
76 make
77
78Install
79-------
80
81::
82
83 su -
84 make install
85 logout
86
87Build and Install Using tpm_
88-----------------------------
89
90Include the plugin in your ``.tmux.conf``, the same file you'll set the
91configuration in, below.
92
93::
94
95 set -g @plugin 'thewtex/tmux-mem-cpu-load'
96
97Install with Package Managers
98-----------------------------
99
100* Gentoo: ``emerge tmux-mem-cpu-load``
101* Homebrew: ``brew install tmux-mem-cpu-load``
102
103Build and Install Using Antigen_
104--------------------------------
105
106Include the bundle in your ``.zshrc``
107
108::
109
110 antigen bundle thewtex/tmux-mem-cpu-load
111
112Configuring tmux_
113=================
114
115Edit ``$HOME/.tmux.conf`` to display the program's output in *status-left* or
116*status-right*. For example::
117
118 set -g status-interval 2
119 set -g status-left "#S #[fg=green,bg=black]#(tmux-mem-cpu-load --colors --interval 2)#[default]"
120 set -g status-left-length 60
121
122If you installed using tpm, you must specify the full path to the
123``tmux-mem-cpu-load`` script, like below::
124
125 set -g status-right "#[fg=green]#($TMUX_PLUGIN_MANAGER_PATH/tmux-mem-cpu-load/tmux-mem-cpu-load --colors --powerline-right --interval 2)#[default]"
126
127Note that the *interval* argument to `tmux-mem-cpu-load` should be the same number
128of seconds that *status-interval* is set at.
129
130Another optional argument is the number of bars in the bar graph, which
131defaults to 10. This can, for instance, be set to the number of cores in a
132multi-core system.
133
134The *colors* option will add graded colors for each of the measures.
135
136The full usage::
137
138 Usage: tmux-mem-cpu-load [OPTIONS]
139
140 Available options:
141 -h, --help
142 Prints this help message
143 -c, --colors
144 Use tmux colors in output
145 -p, --powerline-left
146 Use powerline left symbols throughout the output, enables --colors
147 -q, --powerline-right
148 Use powerline right symbols throughout the output, enables --colors
149 -i <value>, --interval <value>
150 Set tmux status refresh interval in seconds. Default: 1 second
151 -g <value>, --graph-lines <value>
152 Set how many lines should be drawn in a graph. Default: 10
153 -m <value>, --mem-mode <value>
154 Set memory display mode. 0: Default, 1: Free memory, 2: Usage percent.
155 -t <value>, --cpu-mode <value>
156 Set cpu % display mode. 0: Default max 100%, 1: Max 100% * number of threads.
157 -a <value>, --averages-count <value>
158 Set how many load-averages should be drawn. Default: 3
159
160
161
162Authors
163=======
164
165Matt McCormick (thewtex) <matt@mmmccormick.com>
166
167Contributions from:
168
169* cousine <iam@cousine.me>
170* Jasper Lievisse Adriaanse <jasper@humppa.nl>
171* Justin Crawford <justinc@pci-online.net>
172* krieiter <krieiter@gmail.com>
173* Mark Palmeri <mlp6@duke.edu>
174* `Pawel 'l0ner' Soltys`_ <pwslts@gmail.com>
175* Travil Heller <trav.heller@gmail.com>
176* Tony Narlock <tony@git-pull.com>
177* Compilenix <Compilenix@compilenix.org>
178* jodavies <jodavies1010@gmail.com>
179* `@nhdaly`_ (Nathan Daly) <nhdaly@gmail.com>
180* bensuperpc <bensuperpc@gmail.com>
181
182.. _tmux: http://tmux.sourceforge.net/
183.. _CMake: http://www.cmake.org
184.. _`project homepage`: http://github.com/thewtex/tmux-mem-cpu-load
185.. _`tpm`: http://github.com/tmux-plugins/tpm
186.. _`Antigen`: https://github.com/zsh-users/antigen
187.. _`terminals with 256 color support`: http://misc.flogisoft.com/bash/tip_colors_and_formatting#terminals_compatibility
188.. _`Pawel 'l0ner' Soltys` : http://l0ner.github.io/
189.. _`@nhdaly` : http://github.com/nhdaly
190
