Compare commits
2 Commits
cef0d03860
...
2bb095c08a
Author | SHA1 | Date | |
---|---|---|---|
|
2bb095c08a | ||
|
47b24679cc |
22
README.md
22
README.md
@ -69,9 +69,9 @@ ln -s $HOME/.local/lib/volumectl $HOME/.local/bin/volumectl
|
||||
#### Option 2 (not recommended): Downloading the script directly
|
||||
|
||||
```bash
|
||||
$ mkdir -p $HOME/.local/bin
|
||||
$ wget -O $HOME/.local/bin/volumectl https://raw.githubusercontent.com/karma-riuk/volumectl/master/volumectl
|
||||
$ chmod +x $HOME/.local/bin/volumectl
|
||||
mkdir -p $HOME/.local/bin
|
||||
wget -O $HOME/.local/bin/volumectl https://raw.githubusercontent.com/karma-riuk/volumectl/master/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,
|
||||
example:
|
||||
```bash
|
||||
$ volumectl -i
|
||||
volumectl -i
|
||||
```
|
||||
|
||||
### Possible flags
|
||||
@ -95,6 +95,18 @@ $ volumectl -i
|
||||
|`-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%) |
|
||||
|`-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 |
|
||||
|
||||
|
||||
|
@ -222,14 +222,14 @@ usage() {
|
||||
volumectl - A configurable bash script that makes your life easier in controlling volume and notifying it
|
||||
at the same time.
|
||||
|
||||
Usage: volumectl [-v|--verbose] [-c|--config path] -option [arg]
|
||||
Usage: volumectl [-v|--verbose] [-c|--config <file>] -option [arg]
|
||||
|
||||
Options:
|
||||
-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
|
||||
-I, --big-increase increase 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
|
||||
-u, --unmute unmute
|
||||
-t, --toggle toggle mute
|
||||
@ -237,7 +237,7 @@ Options:
|
||||
-G, --get-mute get mute
|
||||
|
||||
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
|
||||
-v, --verbose print each step the script passes through
|
||||
-h, -?, --help show this message
|
||||
|
Loading…
Reference in New Issue
Block a user