2018-08-07 19:58:41 +00:00
|
|
|
# Conky
|
2012-12-26 00:57:10 +00:00
|
|
|
|
2018-05-12 23:26:31 +00:00
|
|
|
[](https://travis-ci.org/brndnmtthws/conky) [](https://sonarcloud.io/dashboard/index/conky)
|
2012-12-26 00:57:10 +00:00
|
|
|
|
|
|
|
|
**Conky** is a free, light-weight system monitor for X, that displays
|
|
|
|
|
any kind of information on your desktop.
|
|
|
|
|
|
2015-11-18 15:47:45 +00:00
|
|
|
Grab the [latest release from GitHub](https://github.com/brndnmtthws/conky/releases/latest).
|
|
|
|
|
|
2012-12-26 00:57:10 +00:00
|
|
|
### Features
|
|
|
|
|
|
|
|
|
|
Conky can display more than 300 built-in objects, including support for:
|
|
|
|
|
|
|
|
|
|
* A plethora of OS stats (uname, uptime, **CPU usage**, **mem
|
|
|
|
|
usage**, disk usage, **"top"** like process stats, and **network
|
|
|
|
|
monitoring**, just to name a few).
|
|
|
|
|
* Built-in **IMAP** and **POP3** support.
|
|
|
|
|
* Built-in support for many popular music players ([MPD][],
|
|
|
|
|
[XMMS2][], [BMPx][], [Audacious][]).
|
|
|
|
|
* Can be extended using built-in [**Lua**](lua) support, or any of your
|
2018-08-07 19:58:41 +00:00
|
|
|
own scripts and programs ([more](https://github.com/brndnmtthws/conky/wiki#tutorial)).
|
2012-12-26 00:57:10 +00:00
|
|
|
* Built-in [**Imlib2**][Imlib2] and [**Cairo**][cairo] bindings for arbitrary drawing
|
2018-08-07 19:58:41 +00:00
|
|
|
with Lua ([more](https://github.com/brndnmtthws/conky/wiki/Lua-API)).
|
2018-08-07 15:04:06 +00:00
|
|
|
* Runs on Linux, FreeBSD, OpenBSD, DragonFlyBSD, NetBSD, Solaris, Haiku OS, and macOS!
|
2012-12-26 00:57:10 +00:00
|
|
|
|
|
|
|
|
... and much much more.
|
|
|
|
|
|
|
|
|
|
Conky can display information either as text, or using simple progress
|
|
|
|
|
bars and graph widgets, with different fonts and colours.
|
|
|
|
|
|
|
|
|
|
### Screenshots
|
|
|
|
|
|
2013-03-28 21:29:47 +00:00
|
|
|
[](https://raw.github.com/wiki/brndnmtthws/conky/configs/brenden/screenshot.png)
|
|
|
|
|
[](https://raw.github.com/wiki/brndnmtthws/conky/configs/ke49/screenshot.png)
|
|
|
|
|
[](https://raw.github.com/wiki/brndnmtthws/conky/configs/jc/screenshot.png)
|
2012-12-26 00:57:10 +00:00
|
|
|
|
2018-08-07 19:58:41 +00:00
|
|
|
See the User Configs below for more screenshots and associated config files.
|
2012-12-26 00:57:10 +00:00
|
|
|
|
|
|
|
|
### Documentation
|
|
|
|
|
|
2013-09-13 20:49:55 +00:00
|
|
|
The [GitHub Wiki](https://github.com/brndnmtthws/conky/wiki) serves as a central hub for all of
|
2018-08-07 19:58:41 +00:00
|
|
|
Conky's documentation.
|
2012-12-26 00:57:10 +00:00
|
|
|
|
2018-08-07 19:58:41 +00:00
|
|
|
* [Installation](https://github.com/brndnmtthws/conky/wiki/Installation)
|
|
|
|
|
* [Configuration Settings](https://github.com/brndnmtthws/conky/wiki/Configuration-Settings)
|
2013-03-28 21:29:47 +00:00
|
|
|
* [User Configs](https://github.com/brndnmtthws/conky/wiki/User-Configs)
|
|
|
|
|
* [Frequently Asked Questions](https://github.com/brndnmtthws/conky/wiki/FAQ)
|
2012-12-26 00:57:10 +00:00
|
|
|
|
|
|
|
|
### License
|
|
|
|
|
|
2018-08-07 19:58:41 +00:00
|
|
|
Conky is licensed under the terms of the [GPLv3](LICENSE) and
|
2013-03-28 21:29:47 +00:00
|
|
|
[BSD](LICENSE.BSD) licenses.
|
2012-12-26 00:57:10 +00:00
|
|
|
|
2016-07-13 14:29:51 +00:00
|
|
|
### Contributing
|
|
|
|
|
|
2018-08-07 19:58:41 +00:00
|
|
|
To report bugs or issues, open [new issues](https://github.com/brndnmtthws/conky/issues/new).
|
|
|
|
|
To submit code changes, open [new pull requests](https://github.com/brndnmtthws/conky/compare).
|
2016-07-13 14:29:51 +00:00
|
|
|
|
2018-08-07 19:58:41 +00:00
|
|
|
Patches submitted in issues, email, or elsewhere will likely be ignored. When submitting PRs, please:
|
|
|
|
|
|
|
|
|
|
* Describe the changes, why they were necessary, etc
|
|
|
|
|
* Describe how the changes affect existing behaviour
|
|
|
|
|
* Describe how you tested and validated your changes
|
|
|
|
|
* Include any relevant screenshots/evidence demonstrating that the changes work and have been tested
|
2016-07-13 14:29:51 +00:00
|
|
|
* Any new source files should include a GPLv3 license header
|
|
|
|
|
* Any contributed code must be GPLv3 licensed
|
|
|
|
|
|
2018-08-07 19:58:41 +00:00
|
|
|
[MPD]: https://musicpd.org/
|
|
|
|
|
[XMMS2]: https://github.com/xmms2/wiki/wiki
|
|
|
|
|
[BMPx]: https://www.beep-media-player.org/
|
|
|
|
|
[Audacious]: https://audacious-media-player.org/
|
|
|
|
|
[luawiki]: https://en.wikipedia.org/wiki/Lua_%28programming_language%29
|
|
|
|
|
[Imlib2]: https://docs.enlightenment.org/api/imlib2/html/
|
|
|
|
|
[cairo]: https://www.cairographics.org/
|
