vmatare/thinkfan
1
1
Fork 0
mirror of https://github.com/vmatare/thinkfan.git synced 2024-12-04 11:52:49 +03:00
Code Issues Projects Releases Wiki Activity
The minimalist fan control program
503 Commits 10 Branches 14 Tags 1.1 MiB
C 48.9%
C++ 39.4%
CMake 10.7%
Shell 1%
master
Go to file
Victor Mataré e3cf71b328 work around old GCC bug
2024-10-17 00:58:14 +02:00
.github/workflows workflow: remove ubuntu-18.04 runner 2023-04-11 19:20:41 +02:00
examples Added support for LM Sensors. 2021-10-26 23:51:54 +02:00
include/nvidia/gdk include nvml.h, fix cmake docstring 2015-10-09 21:37:38 +02:00
rcscripts Add Documentation field to systemd unit 2023-01-14 23:38:51 +01:00
src work around old GCC bug 2024-10-17 00:58:14 +02:00
CMakeLists.txt fix cmake warnings 2024-10-15 20:12:34 +02:00
COPYING remove duplicate src subdir 2012-05-10 20:27:27 +02:00
README.md Merge pull request #202 from benyaminl/fedora-readme 2023-04-07 16:02:29 +02:00

README.md

thinkfan

Thinkfan is a simple, lightweight fan control program.

WARNING

There's only very basic sanity checking on the configuration (semantic plausibility). You can set the temperature limits as insane as you like.

Any change to fan behaviour that results in higher temperatures in some parts of the system will shorten your system's lifetime and/or cause weird hardware bugs that'll make you pull out your hair.

No warranties whatsoever

If this program steals your car, kills your horse, smokes your dope or pees on your carpet... too bad, you're on your own.

Building and installing

To compile thinkfan, you will need to have the following things installed:

  • A recent C++ compiler (GCC >= 4.8 or clang)
  • pkgconfig or an equivalent (pkgconf or pkg-config)
  • cmake (and optionally a cmake GUI if you want to configure interactively)
  • optional: libyaml-cpp for YAML support (the -dev or -devel package)

E.g. on a debian-based system that usually boils down to:

sudo apt install -y cmake-curses-gui build-essential cmake g++ libyaml-cpp-dev pkgconfig libsensors-dev

on EL/Fedora based system, usually :

sudo dnf install -y cmake g++ pkgconfig yaml-cpp-devel lm_sensors-devel

  1. In the thinkfan main directory, do

    mkdir build && cd build

  2. Then configure your build, either interactively:

    ccmake ..

    Or set your build options from the command line. E.g. to configure a build with full debugging support:

     cmake -D CMAKE_BUILD_TYPE:STRING=Debug ..

    CMAKE_BUILD_TYPE:STRING can also be Release, which produces a fully optimized binary, or RelWithDebInfo, which is also optimized but can still be debugged with gdb.

    Other options are:

    USE_NVML:BOOL (default: ON) Allows thinkfan to read GPU temperatures from the proprietary nVidia driver. The interface library is loaded dynamically, so it does not need to be installed when compiling.

    USE_ATASMART:BOOL (default: OFF) Enable libatasmart to read temperatures directly from hard disks. Use this only when you really need it, since libatasmart is unreasonably CPU-intensive.

    USE_LM_SENSORS:BOOL (default: ON) Use LM sensors to read temperatures directly from Linux drivers. The libsensors library needs to be installed for this feature, probably with required headers and development files (e.g., libsensors-dev).

    USE_YAML:BOOL (default: ON) Support config file in the new, more flexible YAML format. The old config format will be deprecated after the thinkfan 1.0 release. New features will be supported in YAML configs only. See examples/thinkfan.conf.yaml. Requires libyaml-cpp.

  3. To compile simply run:

    make

  4. If you did not change CMAKE_INSTALL_PREFIX, thinkfan will be installed under /usr/local by doing:

    sudo make install

    CMake will detect whether you use OpenRC or systemd and install some appropriate service files. With systemd, you can edit the commandline arguments of the thinkfan service with systemctl edit thinkfan. With OpenRC, we install only a plain initscript (edit /etc/init.d/thinkfan to change options).

Documentation