Compare commits

..

No commits in common. "master" and "1.1.1" have entirely different histories.

21 changed files with 92 additions and 133 deletions

View File

@ -18,8 +18,6 @@ To build TUF Manager the following is needed:
- valadoc - valadoc
- glib - glib
- gtk3 - gtk3
- gio-unix
- gobject
- dbus - dbus
- polkit - polkit
- polkit-gobject - polkit-gobject
@ -29,7 +27,7 @@ To build TUF Manager the following is needed:
## Other requirements ## Other requirements
This software will only work if using the [hackbnw/faustus](https://github.com/hackbnw/faustus) driver module. 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.
## Build options ## Build options
@ -57,6 +55,22 @@ Build the tray icon
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. 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 ## Usage
There are 3 programs and 1 daemon supplied by TUF Manager. There are 3 programs and 1 daemon supplied by TUF Manager.
@ -82,3 +96,7 @@ This is the tray icon to control the TUF Manager program. It should automaticall
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 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. 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.
## Future plans
- Manpages

4
contrib/meson.build Normal file
View File

@ -0,0 +1,4 @@
subdir('openrc')
subdir('runit')
subdir('s6')
subdir('systemd')

View File

@ -1,3 +1,5 @@
openrc = get_option('openrc')
openrc_config_data = configuration_data() openrc_config_data = configuration_data()
openrc_config_data.set('SBINDIR', join_paths(get_option('prefix'), get_option('sbindir'))) openrc_config_data.set('SBINDIR', join_paths(get_option('prefix'), get_option('sbindir')))
openrc_config_data.set('LIBEXECDIR', join_paths(get_option('prefix'), get_option('libexecdir'), meson.project_name())) openrc_config_data.set('LIBEXECDIR', join_paths(get_option('prefix'), get_option('libexecdir'), meson.project_name()))
@ -8,9 +10,7 @@ openrc_config_data_file = configure_file(
configuration: openrc_config_data configuration: openrc_config_data
) )
openrc = find_program ('openrc', required: false) if openrc
if openrc.found()
install_data( install_data(
openrc_config_data_file, openrc_config_data_file,
install_dir: join_paths(get_option('sysconfdir'), 'init.d') install_dir: join_paths(get_option('sysconfdir'), 'init.d')

View File

@ -1,3 +1,5 @@
runit = get_option('runit')
runit_config_data = configuration_data() runit_config_data = configuration_data()
runit_config_data.set('LIBEXECDIR', join_paths(get_option('prefix'), get_option('libexecdir'), meson.project_name())) runit_config_data.set('LIBEXECDIR', join_paths(get_option('prefix'), get_option('libexecdir'), meson.project_name()))
@ -7,9 +9,7 @@ runit_config_data_file = configure_file(
configuration: runit_config_data configuration: runit_config_data
) )
runit = find_program ('runit', required: false) if runit
if runit.found()
install_data( install_data(
runit_config_data_file, runit_config_data_file,
install_dir: join_paths(get_option('sysconfdir'), 'runit', 'sv', 'tufmanager') install_dir: join_paths(get_option('sysconfdir'), 'runit', 'sv', 'tufmanager')

View File

@ -1,3 +1,5 @@
s6 = get_option('s6')
s6_config_data = configuration_data() s6_config_data = configuration_data()
s6_config_data.set('LIBEXECDIR', join_paths(get_option('prefix'), get_option('libexecdir'), meson.project_name())) s6_config_data.set('LIBEXECDIR', join_paths(get_option('prefix'), get_option('libexecdir'), meson.project_name()))
@ -7,9 +9,7 @@ s6_config_data_file = configure_file(
configuration: s6_config_data configuration: s6_config_data
) )
s6 = find_program ('s6-init', required: false) if s6
if s6.found()
install_data( install_data(
[s6_config_data_file, 'type', 'dependencies'], [s6_config_data_file, 'type', 'dependencies'],
install_dir: join_paths(get_option('sysconfdir'), 's6', 'sv', 'tufmanager') install_dir: join_paths(get_option('sysconfdir'), 's6', 'sv', 'tufmanager')

View File

@ -1,3 +1,5 @@
systemd = get_option('systemd')
systemd_config_data = configuration_data() systemd_config_data = configuration_data()
systemd_config_data.set('LIBEXECDIR', join_paths(get_option('prefix'), get_option('libexecdir'), meson.project_name())) systemd_config_data.set('LIBEXECDIR', join_paths(get_option('prefix'), get_option('libexecdir'), meson.project_name()))
@ -7,9 +9,7 @@ systemd_config_data_file = configure_file(
configuration: systemd_config_data configuration: systemd_config_data
) )
systemd = find_program ('systemctl', required: false) if systemd
if systemd.found()
install_data( install_data(
systemd_config_data_file, systemd_config_data_file,
install_dir: join_paths(get_option('prefix'), 'lib', 'systemd', 'system') install_dir: join_paths(get_option('prefix'), 'lib', 'systemd', 'system')

View File

@ -3,7 +3,6 @@ Description=TUF Manager Server
[Service] [Service]
Type=forking Type=forking
PIDFile=/run/tufmanager/pid
ExecStart=@LIBEXECDIR@/tuf-server ExecStart=@LIBEXECDIR@/tuf-server
[Install] [Install]

View File

@ -1,15 +0,0 @@
man_pages = files()
if build_cli
man_pages += files('tuf-cli.1')
endif
if build_gui
man_pages += files('tuf-gui.1')
endif
if build_tray
man_pages += files('tuf-tray.1')
endif
if build_cli or build_gui or build_tray
install_man(man_pages)
endif

View File

@ -1,36 +0,0 @@
.Dd August 15, 2020
.Dt tuf-cli 1 SMM
.Os TUF Manager
.Sh NAME
.Nm tuf-cli
.Nd Manage the TUF Gaming notebook
.Sh SYNOPSIS
.Nm
.Ar COMMAND
.Ar <SUBCOMMAND>
.Sh DESCRIPTION
This program allows controlling the fan modes and keyboard lighting of Asus TUF Gaming notebooks via a CLI.
.Pp
The commands are as follows:
.Bl -tag -width ".Fl lighting {static | breath | cycle | stobe}"
.It version
Print the version of tuf-cli
.It help
Show the help screen
.It info
Show the current config
.It restore
Restore saved settings
.It fan {balanced | turbo | silent}
Set the fan mode
.It lighting {static | breath | cycle | stobe}
Set the keyboard lighting
.It speed {slow | medium | fast}
Set the keyboard lighting speed
.It color \&"#XXXXXX\&"
Set the keyboard color
.Sh SEE ALSO
.Xr tuf-gui 1 ,
.Xr tuf-tray 1
.Sh AUTHORS
.An Chris Cromer <chris@cromer.cl>

View File

@ -1,16 +0,0 @@
.Dd August 15, 2020
.Dt tuf-gui 1 SMM
.Os TUF Manager
.Sh NAME
.Nm tuf-gui
.Nd Manage the TUF Gaming notebook
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
This program allows controlling the fan modes and keyboard lighting of Asus TUF Gaming notebooks via a GUI.
There are 2 available configuration options. Restore settings which will allow settings to be restored when TUF Manager is run either from CLI, GUI, or the Tray Icon. The other setting is notifications, which if set will notify the user via tray icon that the fan mode changed.
.Sh SEE ALSO
.Xr tuf-cli 1 ,
.Xr tuf-tray 1
.Sh AUTHORS
.An Chris Cromer <chris@cromer.cl>

View File

@ -1,15 +0,0 @@
.Dd August 15, 2020
.Dt tuf-tray 1 SMM
.Os TUF Manager
.Sh NAME
.Nm tuf-tray
.Nd Manage the TUF Gaming notebook
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
This program should be started automatically by the desktop environment. It is a tray icon that runs in the status bar and allows changing fan speeds, opening the TUF Manager GUI, and notifications about fan speed changes.
.Sh SEE ALSO
.Xr tuf-cli 1 ,
.Xr tuf-gui 1
.Sh AUTHORS
.An Chris Cromer <chris@cromer.cl>

View File

@ -7,7 +7,7 @@ if build_gui
install: true, install: true,
install_dir: join_paths(get_option('datadir'), 'applications') install_dir: join_paths(get_option('datadir'), 'applications')
) )
if build_tray if build_tray
i18n.merge_file( i18n.merge_file(
input: 'tuf-tray.desktop.in', input: 'tuf-tray.desktop.in',
@ -25,8 +25,3 @@ subdir('polkit')
subdir('ui') subdir('ui')
subdir('icons') subdir('icons')
subdir('gschema') subdir('gschema')
subdir('man')
subdir('openrc')
subdir('runit')
subdir('s6')
subdir('systemd')

View File

@ -4,7 +4,7 @@ project(
'c', 'c',
'vala' 'vala'
], ],
version: '1.2.3', version: '1.1.1',
license: 'BSD-3', license: 'BSD-3',
default_options: default_options:
[ [
@ -28,3 +28,4 @@ subdir('data')
subdir('src') subdir('src')
subdir('docs') subdir('docs')
subdir('script') subdir('script')
subdir('contrib')

View File

@ -34,3 +34,27 @@ option(
value: true, value: true,
description: 'User is always authenticated, so no password is necessary' description: 'User is always authenticated, so no password is necessary'
) )
option(
'openrc',
type : 'boolean',
value: false,
description: 'Install OpenRC script'
)
option(
'runit',
type : 'boolean',
value: false,
description: 'Install runit script'
)
option(
's6',
type : 'boolean',
value: false,
description: 'Install s6 scripts'
)
option(
'systemd',
type : 'boolean',
value: false,
description: 'Install systemd unit'
)

View File

@ -7,7 +7,7 @@ msgid ""
msgstr "" msgstr ""
"Project-Id-Version: tuf-manager\n" "Project-Id-Version: tuf-manager\n"
"Report-Msgid-Bugs-To: \n" "Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2020-08-15 16:42-0400\n" "POT-Creation-Date: 2020-08-07 21:50-0400\n"
"PO-Revision-Date: 2020-08-07 21:51-0400\n" "PO-Revision-Date: 2020-08-07 21:51-0400\n"
"Last-Translator: Chris Cromer <chris@cromer.cl>\n" "Last-Translator: Chris Cromer <chris@cromer.cl>\n"
"Language-Team: none\n" "Language-Team: none\n"
@ -112,39 +112,39 @@ msgstr "¡No se pudo obtener la velocidad actual del teclado!"
msgid "Current keyboard color: " msgid "Current keyboard color: "
msgstr "Color de teclado actual: " msgstr "Color de teclado actual: "
#: src/cli.vala:609 #: src/cli.vala:606
msgid "Usage:" msgid "Usage:"
msgstr "Uso:" msgstr "Uso:"
#: src/cli.vala:609 #: src/cli.vala:606
msgid "COMMAND [SUBCOMMAND]" msgid "COMMAND [SUBCOMMAND]"
msgstr "COMANDO [SUBCOMANDO]" msgstr "COMANDO [SUBCOMANDO]"
#: src/cli.vala:610 #: src/cli.vala:607
msgid "Print the version of tuf-cli\n" msgid "Print the version of tuf-cli\n"
msgstr "Imprimir la versión del tuf-cli\n" msgstr "Imprimir la versión del tuf-cli\n"
#: src/cli.vala:611 #: src/cli.vala:608
msgid "Show this help screen\n" msgid "Show this help screen\n"
msgstr "Mostrar esta pantalla de ayuda\n" msgstr "Mostrar esta pantalla de ayuda\n"
#: src/cli.vala:612 #: src/cli.vala:609
msgid "Set the fan mode\n" msgid "Set the fan mode\n"
msgstr "Establecer el modo del ventilador:\n" msgstr "Establecer el modo del ventilador:\n"
#: src/cli.vala:613 #: src/cli.vala:610
msgid "Set the keyboard lighting\n" msgid "Set the keyboard lighting\n"
msgstr "Iluminación de teclado\n" msgstr "Iluminación de teclado\n"
#: src/cli.vala:614 #: src/cli.vala:611
msgid "Set the keyboard lighting speed\n" msgid "Set the keyboard lighting speed\n"
msgstr "Establecer la Iluminación de teclado\n" msgstr "Establecer la Iluminación de teclado\n"
#: src/cli.vala:615 #: src/cli.vala:612
msgid "Set the keyboard color\n" msgid "Set the keyboard color\n"
msgstr "Color del teclado\n" msgstr "Color del teclado\n"
#: src/cli.vala:616 #: src/cli.vala:613
msgid "" msgid ""
"Restore saved settings\n" "Restore saved settings\n"
"\n" "\n"
@ -152,7 +152,7 @@ msgstr ""
"Restaurar configuraciones guardadas\n" "Restaurar configuraciones guardadas\n"
"\n" "\n"
#: src/cli.vala:617 #: src/cli.vala:614
msgid "" msgid ""
"Show the current config\n" "Show the current config\n"
"\n" "\n"
@ -160,15 +160,15 @@ msgstr ""
"Mostrar la configuración actual\n" "Mostrar la configuración actual\n"
"\n" "\n"
#: src/cli.vala:618 #: src/cli.vala:615
msgid "Examples:\n" msgid "Examples:\n"
msgstr "Ejemplos:\n" msgstr "Ejemplos:\n"
#: src/cli.vala:619 #: src/cli.vala:616
msgid "Silence fan:" msgid "Silence fan:"
msgstr "Silenciar ventilador:" msgstr "Silenciar ventilador:"
#: src/cli.vala:620 #: src/cli.vala:617
msgid "Change RGB color:" msgid "Change RGB color:"
msgstr "Cambiar el color RGB:" msgstr "Cambiar el color RGB:"

View File

@ -8,7 +8,7 @@ msgid ""
msgstr "" msgstr ""
"Project-Id-Version: tuf-manager\n" "Project-Id-Version: tuf-manager\n"
"Report-Msgid-Bugs-To: \n" "Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2020-08-15 16:42-0400\n" "POT-Creation-Date: 2020-08-07 21:50-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n" "Language-Team: LANGUAGE <LL@li.org>\n"
@ -108,59 +108,59 @@ msgstr ""
msgid "Current keyboard color: " msgid "Current keyboard color: "
msgstr "" msgstr ""
#: src/cli.vala:609 #: src/cli.vala:606
msgid "Usage:" msgid "Usage:"
msgstr "" msgstr ""
#: src/cli.vala:609 #: src/cli.vala:606
msgid "COMMAND [SUBCOMMAND]" msgid "COMMAND [SUBCOMMAND]"
msgstr "" msgstr ""
#: src/cli.vala:610 #: src/cli.vala:607
msgid "Print the version of tuf-cli\n" msgid "Print the version of tuf-cli\n"
msgstr "" msgstr ""
#: src/cli.vala:611 #: src/cli.vala:608
msgid "Show this help screen\n" msgid "Show this help screen\n"
msgstr "" msgstr ""
#: src/cli.vala:612 #: src/cli.vala:609
msgid "Set the fan mode\n" msgid "Set the fan mode\n"
msgstr "" msgstr ""
#: src/cli.vala:613 #: src/cli.vala:610
msgid "Set the keyboard lighting\n" msgid "Set the keyboard lighting\n"
msgstr "" msgstr ""
#: src/cli.vala:614 #: src/cli.vala:611
msgid "Set the keyboard lighting speed\n" msgid "Set the keyboard lighting speed\n"
msgstr "" msgstr ""
#: src/cli.vala:615 #: src/cli.vala:612
msgid "Set the keyboard color\n" msgid "Set the keyboard color\n"
msgstr "" msgstr ""
#: src/cli.vala:616 #: src/cli.vala:613
msgid "" msgid ""
"Restore saved settings\n" "Restore saved settings\n"
"\n" "\n"
msgstr "" msgstr ""
#: src/cli.vala:617 #: src/cli.vala:614
msgid "" msgid ""
"Show the current config\n" "Show the current config\n"
"\n" "\n"
msgstr "" msgstr ""
#: src/cli.vala:618 #: src/cli.vala:615
msgid "Examples:\n" msgid "Examples:\n"
msgstr "" msgstr ""
#: src/cli.vala:619 #: src/cli.vala:616
msgid "Silence fan:" msgid "Silence fan:"
msgstr "" msgstr ""
#: src/cli.vala:620 #: src/cli.vala:617
msgid "Change RGB color:" msgid "Change RGB color:"
msgstr "" msgstr ""