2020-08-04 23:09:05 -04:00
# TUF Manager
## License
2020-08-06 19:25:03 -04:00
2020-08-04 23:09:05 -04:00
[3-Clause BSD License ](LICENSE )
2020-08-04 23:30:07 -04:00
## Screenshots
2020-08-05 14:56:30 -04:00
< img src = "screenshot/tuf-gui.png" / >
2020-08-04 23:30:07 -04:00
2020-08-05 14:56:30 -04:00
< img src = "screenshot/tuf-cli.png" / >
2020-08-04 23:30:07 -04:00
2020-08-04 23:09:05 -04:00
## Build requirements
2020-08-06 19:25:03 -04:00
2020-08-04 23:09:05 -04:00
To build TUF Manager the following is needed:
- vala
- valadoc
- glib
- gtk3
- dbus
- polkit
- polkit-gobject
- gmodule-export
2020-08-07 20:21:05 -04:00
- libnotify
- libappindicator3
2020-08-04 23:09:05 -04:00
2020-08-04 23:16:10 -04:00
## Other requirements
2020-08-07 20:21:05 -04:00
This software will only work if using the [hackbnw/faustus ](https://github.com/hackbnw/faustus ) driver module. To get notifications on fan mode changes the fork of faustus at [rublag/faustus ](https://github.com/rublag/faustus ) should be used instead since it supports polling.
2020-08-04 23:16:10 -04:00
2020-08-04 23:09:05 -04:00
## Build options
- valadocs
Build TUF Manager's vala documentation.
2020-08-06 19:25:03 -04:00
2020-08-04 23:09:05 -04:00
- valadocs-deps
Build external valadocs that TUF Manager utilizes and calls.
2020-08-06 19:25:03 -04:00
2020-08-04 23:16:10 -04:00
- build-cli
Build the cli interface.
- build-gui
Build the gui interface.
2020-08-06 19:25:03 -04:00
2020-08-07 00:32:22 -04:00
- build-tray
Build the tray icon
2020-08-04 23:09:05 -04:00
- 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.
2020-08-06 19:25:03 -04:00
- 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.
2020-08-04 23:09:05 -04:00
## Usage
2020-08-06 19:25:03 -04:00
2020-08-07 00:32:22 -04:00
There are 3 programs and 1 daemon supplied by TUF Manager.
2020-08-04 23:09:05 -04:00
- tuf-cli
This allows controlling the TUF laptop functions via command line interface.
2020-08-07 00:32:22 -04:00
2020-08-04 23:09:05 -04:00
- tuf-gui
This supplies a graphical interface to control the TUF laptop.
2020-08-07 00:32:22 -04:00
2020-08-04 23:09:05 -04:00
- tuf-server
This is the daemon that runs in the background and handles all requests from both tuf-cli and tuf-gui.
2020-08-07 00:32:22 -04:00
- tuf-tray
2020-08-07 20:21:05 -04:00
This is the tray icon to control the TUF Manager program. It should automatically start in any desktop environment that supports xdg.
2020-08-07 00:32:22 -04:00
2020-08-04 23:09:05 -04:00
## Future plans
- Manpage
- Config options for both tuf-gui and tuf-cli
