Compare commits

...

2 Commits

Author SHA1 Message Date
Karma Riuk
2bb095c08a Updated README 2021-09-19 18:07:24 +02:00
Karma Riuk
47b24679cc Changed the help message 2021-09-19 18:07:17 +02:00
2 changed files with 20 additions and 8 deletions

View File

@ -69,9 +69,9 @@ ln -s $HOME/.local/lib/volumectl $HOME/.local/bin/volumectl
#### Option 2 (not recommended): Downloading the script directly #### Option 2 (not recommended): Downloading the script directly
```bash ```bash
$ mkdir -p $HOME/.local/bin mkdir -p $HOME/.local/bin
$ wget -O $HOME/.local/bin/volumectl https://raw.githubusercontent.com/karma-riuk/volumectl/master/volumectl wget -O $HOME/.local/bin/volumectl https://raw.githubusercontent.com/karma-riuk/volumectl/master/volumectl
$ chmod +x $HOME/.local/bin/volumectl chmod +x $HOME/.local/bin/volumectl
``` ```
@ -80,7 +80,7 @@ $ chmod +x $HOME/.local/bin/volumectl
To use the script, simply execute the `volumectl` with the flag you want, To use the script, simply execute the `volumectl` with the flag you want,
example: example:
```bash ```bash
$ volumectl -i volumectl -i
``` ```
### Possible flags ### Possible flags
@ -95,6 +95,18 @@ $ volumectl -i
|`-d arg` or `--decrease arg` | decrease the volume by the `<arg>` amount | |`-d arg` or `--decrease arg` | decrease the volume by the `<arg>` amount |
|`-D` or `--big-decrease` | decreases the volume by the "big" amount (by default: 10%) | |`-D` or `--big-decrease` | decreases the volume by the "big" amount (by default: 10%) |
|`-s <arg>` or `--set <arg>` | sets the volume to `<arg>` | |`-s <arg>` or `--set <arg>` | sets the volume to `<arg>` |
|`-m` or `--mute` | sets the volume to `<arg>` | |`-m` or `--mute` | activates mute |
|`-u` or `--unmute` | deactivates mute |
|`-t` or `--toggle` | toggles mute |
|`-g` or `--get-volume` | prints the current volume level |
|`-G` or `--get-mute` | prints the current mute state |
### Optional flags
|Flag|Description|
|----|-----|
|`-c <file>` or `--config <file>` | use `<file>` as the config file instead of the default location (`$HOME/.config/volumectl/config.ini` |
|`-v` or `--verbose` | print each step the script passes through |
|`-h` or `-?` or `--help` | print the help message and exit |

View File

@ -222,14 +222,14 @@ usage() {
volumectl - A configurable bash script that makes your life easier in controlling volume and notifying it volumectl - A configurable bash script that makes your life easier in controlling volume and notifying it
at the same time. at the same time.
Usage: volumectl [-v|--verbose] [-c|--config path] -option [arg] Usage: volumectl [-v|--verbose] [-c|--config <file>] -option [arg]
Options: Options:
-i [arg], --increase [arg] increase the volume by the "normal" amount or by the [arg] amount -i [arg], --increase [arg] increase the volume by the "normal" amount or by the [arg] amount
-d [arg], --decrease [arg] decrease the volume by the "normal" amount or by the [arg] amount -d [arg], --decrease [arg] decrease the volume by the "normal" amount or by the [arg] amount
-I, --big-increase increase the volume by the "big" amount -I, --big-increase increase the volume by the "big" amount
-D, --big-decrease decrease the volume by the "big" amount -D, --big-decrease decrease the volume by the "big" amount
-s arg, --set arg set volume to arg -s <arg>, --set <arg> set volume to <arg>
-m, --mute mute -m, --mute mute
-u, --unmute unmute -u, --unmute unmute
-t, --toggle toggle mute -t, --toggle toggle mute
@ -237,7 +237,7 @@ Options:
-G, --get-mute get mute -G, --get-mute get mute
Optional arguments: Optional arguments:
-c path, --config path instead of reading from the default location ($CONFIG_PATH), -c <file>, --config <file> instead of reading from the default location ($CONFIG_PATH),
read from the path given read from the path given
-v, --verbose print each step the script passes through -v, --verbose print each step the script passes through
-h, -?, --help show this message -h, -?, --help show this message