cromer/tuf-manager
1
0
Fork 0
Code Issues Pull Requests Releases 8 Wiki Activity
TUF Manager allows control of the keyboard and fans of ASUS TUF laptops using the faustus driver module.
31 Commits 1 Branch 8 Tags 2.6 MiB
Vala 85.7%
Meson 11.2%
Roff 1.6%
Shell 1.5%
f4d2f0f689
Go to file
Chris Cromer f4d2f0f689
update translations
2020-08-07 20:29:33 -04:00
contrib add s6 and runit scripts 2020-08-06 15:45:16 -04:00
data add configure options to gui 2020-08-07 20:21:05 -04:00
docs initial tray work 2020-08-07 00:32:22 -04:00
po update translations 2020-08-07 20:29:33 -04:00
screenshot add screenshots 2020-08-04 23:30:07 -04:00
script code cleanup and openrc script 2020-08-05 21:15:32 -04:00
src update translations 2020-08-07 20:29:33 -04:00
.gitignore initial commit 2020-08-04 23:09:05 -04:00
LICENSE initial commit 2020-08-04 23:09:05 -04:00
meson_options.txt initial tray work 2020-08-07 00:32:22 -04:00
meson.build initial tray work 2020-08-07 00:32:22 -04:00
README.md add configure options to gui 2020-08-07 20:21:05 -04:00

README.md

TUF Manager

License

3-Clause BSD License

Screenshots

Build requirements

To build TUF Manager the following is needed:

  • vala
  • valadoc
  • glib
  • gtk3
  • dbus
  • polkit
  • polkit-gobject
  • gmodule-export
  • libnotify
  • libappindicator3

Other requirements

This software will only work if using the hackbnw/faustus driver module. To get notifications on fan mode changes the fork of faustus at rublag/faustus should be used instead since it supports polling.

Build options

  • valadocs

Build TUF Manager's vala documentation.

  • valadocs-deps

Build external valadocs that TUF Manager utilizes and calls.

  • build-cli

Build the cli interface.

  • build-gui

Build the gui interface.

  • build-tray

Build the tray icon

  • always-authenticated

Authentication is not required to use the TUF Server that runs in the background as a daemon, if this is set to false polkit is used for authentication. Setting this to false is more secure, but also makes things like auto restore of settings on login impossible to do without a password.

  • openrc

Install an OpenRC init script. Ff this option is not set, the init script is still generated during build, just not installed.

  • runit

Install a runit init script. If this option is not set, the init script is still generated during build, just not installed.

  • s6

Install n s6 init scripts. If this option is not set, the init scripts are still generated during build, just not installed.

  • system

Install a systemd unit. If this option is not set, the unit is still generated during build, just not installed.

Usage

There are 3 programs and 1 daemon supplied by TUF Manager.

  • tuf-cli

This allows controlling the TUF laptop functions via command line interface.

  • tuf-gui

This supplies a graphical interface to control the TUF laptop.

  • tuf-server

This is the daemon that runs in the background and handles all requests from both tuf-cli and tuf-gui.

  • tuf-tray

This is the tray icon to control the TUF Manager program. It should automatically start in any desktop environment that supports xdg.

Future plans

  • Manpage
  • Config options for both tuf-gui and tuf-cli