gilles/asusctl
1
0
Fork 0
mirror of https://gitlab.com/asus-linux/asusctl.git synced 2026-02-06 00:15:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Luke D Jones
2020-08-04 22:22:57 +12:00
parent 4011bdd554
commit 4383464f73
1 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -138,46 +138,46 @@ the daemon mode over dbus.
Commands are given by: Commands are given by:
``` ```
asusd <option> <command> <command-options> asusctl <option> <command> <command-options>
``` ```
Help is available through: Help is available through:
``` ```
asusd --help asusctl --help
asusd <command> --help asusctl <command> --help
``` ```
Some commands may have subcommands: Some commands may have subcommands:
``` ```
asusd <command> <subcommand> --help asusctl <command> <subcommand> --help
``` ```
### Example ### Example
``` ```
$ asusd --help $ asusctl --help
Usage: asusd [OPTIONS] Usage: asusctl [OPTIONS]
Optional arguments: Optional arguments:
-h, --help print help message -h, --help print help message
-v, --version show program version number -v, --version show program version number
-d, --daemon start daemon -k, --kbd-bright VAL <off, low, med, high>
-b, --bright VAL <off, low, med, high> -p, --pwr-profile PWR <silent, normal, boost>
-f, --fan-mode FAN <silent, normal, boost> -c, --chg-limit CHRG <20-100>
Available commands: Available commands:
led-mode Set the keyboard lighting from built-in modes led-mode Set the keyboard lighting from built-in modes
$ asusd led-mode --help $ asusctl led-mode --help
Usage: asusd led-mode [OPTIONS] Usage: asusctl led-mode [OPTIONS]
Optional arguments: Optional arguments:
-h, --help print help message -h, --help print help message
Available commands: Available commands:
stable set a single static colour static set a single static colour
breathe pulse between one or two colours breathe pulse between one or two colours
strobe strobe through all colours strobe strobe through all colours
rainbow rainbow cycling in one of four directions rainbow rainbow cycling in one of four directions
@@ -191,15 +191,15 @@ Available commands:
flash set a wide vertical line zooming from left flash set a wide vertical line zooming from left
multi-static 4-zone multi-colour multi-static 4-zone multi-colour
$ asusd led-mode stable --help $ asusctl led-mode static --help
Usage: asusd led-mode stable [OPTIONS] Usage: asusctl led-mode static [OPTIONS]
Optional arguments: Optional arguments:
-h, --help print help message -h, --help print help message
-c HEX set the RGB value e.g, ff00ff -c HEX set the RGB value e.g, ff00ff
$ asusd led-mode star --help $ asusctl led-mode star --help
Usage: asusd led-mode star [OPTIONS] Usage: asusctl led-mode star [OPTIONS]
Optional arguments: Optional arguments:
-h, --help print help message -h, --help print help message
@@ -221,7 +221,7 @@ The daemon also saves the settings per mode as the keyboard does not do this
itself - this means cycling through modes with the Aura keys will use the itself - this means cycling through modes with the Aura keys will use the
settings that were used via CLI. settings that were used via CLI.
Daemon mode creates a config file at `/etc/rogcore.conf` which you can edit a Daemon mode creates a config file at `/etc/asusd.conf` which you can edit a
little of. Most parts will be byte arrays, but you can adjust things like little of. Most parts will be byte arrays, but you can adjust things like
`mode_performance`. `mode_performance`.