karma/volumectl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Karma Riuk 2021-09-19 17:53:38 +02:00
parent a378d154b3
commit cef0d03860
2 changed files with 13 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
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,14 +80,21 @@ 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
(You can find all the information below by doing `volumectl -h`) (You can find all the information below by doing `volumectl -h`)
|Flag|Usage| |Flag|Description|
|----|-----| |----|-----|
|`-i` or `--increase` | increases the volume by the "normal" amount (by default: 5%) | |`-i` or `--increase` | increases the volume by the "normal" amount (by default: 5%) |
|`-i arg` or `--increase arg` | increase the volume by the `arg` amount | |`-i <arg>` or `--increase <arg>` | increase the volume by the `<arg>` amount |
|`-I` or `--big-increase` | increases the volume by the "big" amount (by default: 10%) |
|`-d` or `--decrease` | decreases the volume by the "normal" amount (by default: 5%) |
|`-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>` |

17
volumectl
View File

@ -23,9 +23,6 @@ DEFAULT_NOTIFICATION_TIMEOUT=3000
DEFAULT_NORMAL_DELTA=5 DEFAULT_NORMAL_DELTA=5
DEFAULT_BIG_DELTA=10 DEFAULT_BIG_DELTA=10
DEFAULT_VOLUME_MAX=100
DEFAULT_VOLUME_MIN=5
VERBOSE=0 VERBOSE=0
@ -105,8 +102,6 @@ checkout_config () {
NORMAL_DELTA=${INI__Controller__normal_delta:-$DEFAULT_NORMAL_DELTA} NORMAL_DELTA=${INI__Controller__normal_delta:-$DEFAULT_NORMAL_DELTA}
BIG_DELTA=${INI__Controller__big_delta:-$DEFAULT_BIG_DELTA} BIG_DELTA=${INI__Controller__big_delta:-$DEFAULT_BIG_DELTA}
VOLUME_MAX=${INI__Controller__volume_max:-$DEFAULT_VOLUME_MAX}
VOLUME_MIN=${INI__Controller__volume_min:-$DEFAULT_VOLUME_MIN}
NOTIFICATION_ENABLED=${INI__Notification__enabled:-$DEFAULT_NOTIFICATION_ENABLED} NOTIFICATION_ENABLED=${INI__Notification__enabled:-$DEFAULT_NOTIFICATION_ENABLED}
NOTIFICATION_TIMEOUT=${INI__Notification__timeout:-$DEFAULT_NOTIFICATION_TIMEOUT} NOTIFICATION_TIMEOUT=${INI__Notification__timeout:-$DEFAULT_NOTIFICATION_TIMEOUT}
@ -123,8 +118,6 @@ checkout_config () {
echo "ADDITIONAL_FLAGS: '${ADDITIONAL_FLAGS[@]}'" && \ echo "ADDITIONAL_FLAGS: '${ADDITIONAL_FLAGS[@]}'" && \
echo "NORMAL_DELTA: '$NORMAL_DELTA'" && \ echo "NORMAL_DELTA: '$NORMAL_DELTA'" && \
echo "BIG_DELTA: '$BIG_DELTA'" && \ echo "BIG_DELTA: '$BIG_DELTA'" && \
echo "VOLUME_MIN: '$VOLUME_MIN'" && \
echo "VOLUME_MAX: '$VOLUME_MAX'" && \
echo "NOTIFICATION_ENABLED: '$NOTIFICATION_ENABLED'" && \ echo "NOTIFICATION_ENABLED: '$NOTIFICATION_ENABLED'" && \
echo "NOTIFICATION_TIMEOUT: '$NOTIFICATION_TIMEOUT'" && \ echo "NOTIFICATION_TIMEOUT: '$NOTIFICATION_TIMEOUT'" && \
echo "" echo ""
@ -237,8 +230,6 @@ Options:
-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
--set-min-volume set volume to minimum
--set-max-volume set volume to maximum
-m, --mute mute -m, --mute mute
-u, --unmute unmute -u, --unmute unmute
-t, --toggle toggle mute -t, --toggle toggle mute
@ -300,14 +291,6 @@ if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then #if '__name__' == '__main__'
verbose && echo "Detected -s or --set-volume, with argument '$2'" verbose && echo "Detected -s or --set-volume, with argument '$2'"
[[ -z "$2" ]] && echo "Error, missing value to set volume" 1>&2 && exit 1 || volume_set $2 [[ -z "$2" ]] && echo "Error, missing value to set volume" 1>&2 && exit 1 || volume_set $2
;; ;;
--set-min-volume)
verbose && echo "Detected --set-min-volume"
volume_set $VOLUME_MIN
;;
--set-max-volume)
verbose && echo "Detected --set-min-volume"
volume_set $VOLUME_MAX
;;
-m|--set-mute) -m|--set-mute)
verbose && echo "Detected -m or --mute" verbose && echo "Detected -m or --mute"
mute mute