1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-11-19 11:35:12 +00:00
Go to file
Brenden Matthews fe5552f3a8 Use MODULE library type for Lua libs
Per the docs at
https://cmake.org/cmake/help/latest/command/add_library.html, we should
use `MODULE` rather than `SHARED` for the Lua libraries.

This mostly affects macOS, where the libraries are compiled as MH_DYLIB
(`.dylib`) rather than MH_BUNDLE (`.so`).
2024-05-01 15:03:14 -04:00
.github Enable cURL, RSS on mac build, lint codeql.yml 2024-04-25 20:13:02 -04:00
.vscode Namespace mouse-events.cc/.h 2023-11-19 14:16:34 -05:00
3rdparty/toluapp Cleanup build flags, global namespace and includes (#1841) 2024-04-23 21:15:37 +00:00
appimage Set RELEASE=ON only when it's a release 2024-04-25 20:13:02 -04:00
bin Use perfect hash (gperf) for parsing color names (#1848) 2024-04-24 06:24:54 +00:00
cmake Make sure the git command is run from the source dir 2024-05-01 15:02:58 -04:00
data Use perfect hash (gperf) for parsing color names (#1848) 2024-04-24 06:24:54 +00:00
doc Use perfect hash (gperf) for parsing color names (#1848) 2024-04-24 06:24:54 +00:00
extras Update copyright 2024-02-22 08:53:35 -05:00
lua Use MODULE library type for Lua libs 2024-05-01 15:03:14 -04:00
src CLI: -V now displays a short version string 2024-05-01 14:44:28 -04:00
tests Update copyright 2024-02-22 08:53:35 -05:00
web This span doesn't need to exist 2024-04-24 17:01:38 -04:00
.clang-format Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
.clang-tidy Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
.dockerignore Update dockerignore. 2021-03-02 08:02:53 -06:00
.editorconfig Apply a bunch of code fixes from sonarcloud. (#492) 2018-05-13 09:58:03 -04:00
.envrc Add nix flake dev shell, direnv, VSCode extensions, CI 2023-06-24 14:35:36 -04:00
.gitignore Disable -Wregister on gperf output 2024-04-28 15:22:59 -04:00
.prettierrc.cjs Update/fix some web stuff. (#1429) 2023-02-25 20:12:11 -05:00
AUTHORS FreeBSD: Additional memory reporting variables. 2022-12-24 08:55:20 -05:00
CMakeLists.txt Update copyright 2024-02-22 08:53:35 -05:00
COPYING Update copyright 2024-02-22 08:53:35 -05:00
Dockerfile Docker: Add gperf, enable Lua Cairo Xlib bindings 2024-04-28 18:41:41 -04:00
flake.lock Update nix flake w/ LLVM 18 2024-05-01 14:11:49 -04:00
flake.nix Update nix flake w/ LLVM 18 2024-05-01 14:11:49 -04:00
lefthook.yml Include these when linting 2024-04-28 15:22:59 -04:00
LICENSE.BSD Update copyright 2024-02-22 08:53:35 -05:00
LICENSE.md feat: Move docs to website, rearrange bits (#1475) 2023-03-28 08:21:17 -04:00
README.cmake Deprecate autotools, update docs to reflect cmake build system. 2010-01-01 14:08:57 -08:00
README.md Revert "Fix matrix URL" 2024-04-20 13:35:31 -04:00

Linux build macOS build Docker build AppImage build

📕 Documentaton

💬 Join the Matrix chat

Conky is a free, light-weight system monitor for X, that displays any kind of information on your desktop. It can also run on Wayland (with caveats), macOS, output to your console, a file, or even HTTP (oh my!).

👉 Grab the latest release from GitHub.

📹 An introduction to Conky (YouTube).

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, Audacious).
  • Can be extended using built-in Lua support, or any of your own scripts and programs (more).
  • Built-in Imlib2 and Cairo bindings for arbitrary drawing with Lua (more).
  • Runs on Linux, FreeBSD, OpenBSD, DragonFlyBSD, NetBSD, Solaris, Haiku, and macOS!
  • Docker image available for amd64, armv7, and aarch64 (aka armv8)

... and much much more.

Conky can display information either as text, or using simple progress bars and graph widgets, with different fonts and colours, as well as handle mouse events.

Screenshots

screenshot screenshot screenshot

See the User Configs below for more screenshots and associated config files.

Installing Conky

Many package managers already include Conky. However, if you'd like to try the latest version of Conky, you can use the AppImage or the Nix flake.

AppImage

To try the AppImage, head to https://github.com/brndnmtthws/conky/releases/latest and fetch the latest AppImage. You'll need to set the executable bit, then you can create a conkyrc, and run it as follows:

chmod +x ./conky-*.AppImage        # make it executable
./conky-*.AppImage -C > ~/.conkyrc # create a default config
./conky-*.AppImage                 # run

And that's it! Check out the Wiki for more details on configuring Conky.

NOTE: To use the AppImage, you may need to install additional runtime libraries.

Nix flake

As of Conky v1.17.0, there's a Nix flake available in addition to the upstream Nix package. You can include it as an input as follows:

{
  inputs = {
    conky.url = "github:brndnmtthws/conky";
  };
}

And use inputs.conky.packages.${system}.default (or inputs.conky.packages.${system}.conky for versions <=v1.19.8) to include the package. To use a specific version, add the git tag to the URL, such as github:brndnmtthws/conky?ref=refs/tags/v1.19.8.

Note that a Nix package exists in nixpkgs, and although it's not always up-to-date with the bleeding edge, it does offer more configuration options.

Documentation

Reference documentation

The Conky Wiki also serves as a central hub for Conky. Some resources from the Wiki include:

License

Conky is licensed under the terms of the GPLv3 license.

Contributing

Contributions are welcome from anyone.

Please read Contributing page on wiki for guidelines on contributing to Conky.

Supporting this project

Conky exists only through the hard work of a collection of volunteers. Please consider sponsoring the project's developers if you get value out of Conky.

Stargazers over time

Stargazers over time