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

add man pages and autodetection of init system

Browse Source
This commit is contained in:
Chris Cromer 2020-08-15 16:43:34 -04:00
parent 0f6e7baef4
commit a545d6b7f4
Signed by: cromer
GPG Key ID: 39CC813FF3C8708A
9 changed files with 106 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -18,6 +18,8 @@ To build TUF Manager the following is needed:
- valadoc
- glib
- gtk3
- gio-unix
- gobject
- dbus
- polkit
- polkit-gobject
@ -55,22 +57,6 @@ 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.
- 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.
@ -96,7 +82,3 @@ 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 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

6
data/man/meson.build Normal file
View File

@ -0,0 +1,6 @@
man_pages = files(
'tuf-cli.1',
'tuf-gui.1',
'tuf-tray.1'
)
install_man(man_pages)

36
data/man/tuf-cli.1 Normal file
View File

@ -0,0 +1,36 @@
.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>

16
data/man/tuf-gui.1 Normal file
View File

@ -0,0 +1,16 @@
.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>

15
data/man/tuf-tray.1 Normal file
View File

@ -0,0 +1,15 @@
.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>

3
data/meson.build
View File

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

2
meson.build
View File

@ -4,7 +4,7 @@ project(
'c',
'vala'
],
version: '1.1.1',
version: '1.2.0',
license: 'BSD-3',
default_options:
[

28
po/es.po
View File

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

28
po/tuf-manager.pot
View File

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