154 lines
4.0 KiB
ReStructuredText
154 lines
4.0 KiB
ReStructuredText
====================================================
|
|
tmux-mem-cpu-load
|
|
====================================================
|
|
----------------------------------------------------
|
|
CPU, RAM memory, and load monitor for use with tmux_
|
|
----------------------------------------------------
|
|
|
|
.. image:: https://travis-ci.org/thewtex/tmux-mem-cpu-load.svg
|
|
:target: https://travis-ci.org/thewtex/tmux-mem-cpu-load
|
|
|
|
.. image:: https://circleci.com/gh/thewtex/tmux-mem-cpu-load.svg?style=svg
|
|
:target: https://circleci.com/gh/thewtex/tmux-mem-cpu-load
|
|
|
|
Description
|
|
===========
|
|
|
|
A simple, lightweight program provided for system monitoring in the *status*
|
|
line of **tmux**.
|
|
|
|
The memory monitor displays the used and available memory.
|
|
|
|
The CPU usage monitor outputs a percent CPU usage over all processors. It also
|
|
displays a textual bar graph of the current percent usage.
|
|
|
|
The system load average is also displayed.
|
|
|
|
Example output::
|
|
|
|
2885/7987MB [||||| ] 51.2% 2.11 2.35 2.44
|
|
|
|
^ ^ ^ ^ ^ ^ ^
|
|
| | | | | | |
|
|
1 2 3 4 5 6 7
|
|
|
|
1. Currently used memory.
|
|
2. Available memory.
|
|
3. CPU usage bar graph.
|
|
4. CPU usage percentage.
|
|
5. Load average for the past minute.
|
|
6. Load average for the past 5 minutes.
|
|
7. Load average for the past 15 minutes.
|
|
|
|
For `terminals with 256 color support`_, graded colors can be displayed by
|
|
passing the **--colors** flag.
|
|
|
|
|
|
Installation
|
|
============
|
|
|
|
Dependencies
|
|
------------
|
|
|
|
Currently, Linux, Mac OSX, FreeBSD, OpenBSD, and NetBSD are supported.
|
|
|
|
Building
|
|
~~~~~~~~
|
|
|
|
* >= CMake_ -2.6
|
|
* C++ compiler with C++11 support (e.g. gcc/g++ >= 4.6)
|
|
|
|
Download
|
|
--------
|
|
|
|
There are links to the source code at the `project homepage`_.
|
|
|
|
Build
|
|
-----
|
|
|
|
::
|
|
|
|
cd <source dir>
|
|
cmake .
|
|
make
|
|
|
|
Install
|
|
-------
|
|
|
|
::
|
|
|
|
su -
|
|
make install
|
|
logout
|
|
|
|
Build and Install Using `Antigen`_
|
|
-------
|
|
|
|
Include the bundle in your ``.zshrc``
|
|
|
|
::
|
|
|
|
antigen bundle thewtex/tmux-mem-cpu-load
|
|
|
|
Configuring tmux_
|
|
=================
|
|
|
|
Edit ``$HOME/.tmux.conf`` to display the program's output in *status-left* or
|
|
*status-right*. For example::
|
|
|
|
set -g status-interval 2
|
|
set -g status-left "#S #[fg=green,bg=black]#(tmux-mem-cpu-load --colors --interval 2)#[default]"
|
|
set -g status-left-length 60
|
|
|
|
Note that the *interval* argument to `tmux-mem-cpu-load` should be the same number
|
|
of seconds that *status-interval* is set at.
|
|
|
|
Another optional argument is the number of bars in the bar graph, which
|
|
defaults to 10. This can, for instance, be set to the number of cores in a
|
|
multi-core system.
|
|
|
|
The *colors* option will add graded colors for each of the measures.
|
|
|
|
The full usage::
|
|
|
|
Usage: tmux-mem-cpu-load [OPTIONS]
|
|
|
|
Available options:
|
|
-h, --help
|
|
Prints this help message
|
|
--colors
|
|
Use tmux colors in output
|
|
--powerline
|
|
Use powerline symbols throughout the output, DO NOT reset background color at the end, enables --colors
|
|
-i <value>, --interval <value>
|
|
Set tmux status refresh interval in seconds. Default: 1 second
|
|
-g <value>, --graph-lines <value>
|
|
Set how many lines should be drawn in a graph. Default: 10
|
|
-m <value>, --mem-mode <value>
|
|
Set memory display mode. 0: Default, 1: Free memory, 2: Usage percent.
|
|
|
|
|
|
Authors
|
|
=======
|
|
|
|
Matt McCormick (thewtex) <matt@mmmccormick.com>
|
|
|
|
Contributions from:
|
|
|
|
* cousine <iam@cousine.me>
|
|
* Jasper Lievisse Adriaanse <jasper@humppa.nl>
|
|
* Justin Crawford <justinc@pci-online.net>
|
|
* krieiter <krieiter@gmail.com>
|
|
* Mark Palmeri <mlp6@duke.edu>
|
|
* `Pawel 'l0ner' Soltys`_ <pwslts@gmail.com>
|
|
* Travil Heller <trav.heller@gmail.com>
|
|
* Tony Narlock <tony@git-pull.com>
|
|
|
|
|
|
.. _tmux: http://tmux.sourceforge.net/
|
|
.. _CMake: http://www.cmake.org
|
|
.. _`project homepage`: http://github.com/thewtex/tmux-mem-cpu-load
|
|
.. _`Antigen`: https://github.com/zsh-users/antigen
|
|
.. _`terminals with 256 color support`: http://misc.flogisoft.com/bash/tip_colors_and_formatting#terminals_compatibility
|
|
.. _`Pawel 'l0ner' Soltys` : http://l0ner.github.io/
|