cromer
/
tuf-manager
1
0
Fork 0
Code Issues Pull Requests Releases 8 Wiki Activity
tuf-manager/README.md

85 lines
2.2 KiB
Markdown
Raw Normal View History

initial commit
2020-08-04 23:09:05 -04:00
# TUF Manager
## License
update readme
2020-08-06 19:25:03 -04:00
initial commit
2020-08-04 23:09:05 -04:00
[3-Clause BSD License](LICENSE)
add screenshots
2020-08-04 23:30:07 -04:00
## Screenshots
cleanup files
2020-08-05 14:56:30 -04:00
<img src="screenshot/tuf-gui.png" />
add screenshots
2020-08-04 23:30:07 -04:00
cleanup files
2020-08-05 14:56:30 -04:00
<img src="screenshot/tuf-cli.png" />
add screenshots
2020-08-04 23:30:07 -04:00
initial commit
2020-08-04 23:09:05 -04:00
## Build requirements
update readme
2020-08-06 19:25:03 -04:00
initial commit
2020-08-04 23:09:05 -04:00
To build TUF Manager the following is needed:
- vala
- valadoc
- glib
- gtk3
add man pages and autodetection of init system
2020-08-15 16:43:34 -04:00
- gio-unix
- gobject
initial commit
2020-08-04 23:09:05 -04:00
- dbus
- polkit
- polkit-gobject
- gmodule-export
add configure options to gui
2020-08-07 20:21:05 -04:00
- libnotify
- libappindicator3
initial commit
2020-08-04 23:09:05 -04:00
update readme
2020-08-04 23:16:10 -04:00
## Other requirements
update readme
2021-03-30 19:40:13 -03:00
This software will only work if using the [hackbnw/faustus](https://github.com/hackbnw/faustus) driver module.
update readme
2020-08-04 23:16:10 -04:00
initial commit
2020-08-04 23:09:05 -04:00
## Build options
- valadocs
Build TUF Manager's vala documentation.
update readme
2020-08-06 19:25:03 -04:00
initial commit
2020-08-04 23:09:05 -04:00
- valadocs-deps
Build external valadocs that TUF Manager utilizes and calls.
update readme
2020-08-06 19:25:03 -04:00
update readme
2020-08-04 23:16:10 -04:00
- build-cli
Build the cli interface.
- build-gui
Build the gui interface.
update readme
2020-08-06 19:25:03 -04:00
initial tray work
2020-08-07 00:32:22 -04:00
- build-tray
Build the tray icon
initial commit
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.
## Usage
update readme
2020-08-06 19:25:03 -04:00
initial tray work
2020-08-07 00:32:22 -04:00
There are 3 programs and 1 daemon supplied by TUF Manager.
initial commit
2020-08-04 23:09:05 -04:00
- tuf-cli
This allows controlling the TUF laptop functions via command line interface.
initial tray work
2020-08-07 00:32:22 -04:00
initial commit
2020-08-04 23:09:05 -04:00
- tuf-gui
This supplies a graphical interface to control the TUF laptop.
initial tray work
2020-08-07 00:32:22 -04:00
initial commit
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.
initial tray work
2020-08-07 00:32:22 -04:00
- tuf-tray
add configure options to gui
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.
initial tray work
2020-08-07 00:32:22 -04:00
add notes
2020-08-07 21:46:13 -04:00
## Notes
The restore settings option saves the changes made on a per user basis. This means that for example if a different user logs in and the tray icon is running, it will restore their settings. So for example user A can have a blue keyboard and user B can have a green keyboard. Or even change keyboard colors based on the distro that is booted. For example when in linux mint a green keyboard and when in fedora a blue keyboard.
The other important use of the restore settings options is the fan mode. Normally fan mode does not survive a reboot. It is always set to "balanced" when booted. However now when the user logs in it restores the previous fan mode that was saved.