summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index b0dc96f..e139145 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,8 @@ Volsv is a POSIX-compliant shell script I wrote in 2020, and have been modifying
- Decreasing volume
- Toggling the interface mute
- Toggling the microphone mute\*
+- Getting the volume
+- Getting the mute state
in both pulseaudio and ALSA\*. Once I get OpenBSD and FreeBSD up and running, I will add those sound options too.
@@ -21,6 +23,15 @@ It depends on:
I made volsv so that I could use it with keybindings to control the volume, regardless of whether or not I was running pulseaudio, since I dislike pulseaudio and tend to avoid it when possible. This means I can have a consistent keybinding, whether or not I'm using it. Additionally, this would give me less keybindings to have to port to OpenBSD, which I occasionally install from time to time, although I haven't booted into it since I started writing this script. Additionally, it has provided a fun learning experience as I learn to write scripts.
+#### Flags/Commands
+
+- increase volume: `up` or `-i`
+- decrease volume: `down` or `-d`
+- toggle system mute: `toggle` or `-t`
+- toggle microphone mute\*: `mic` or `-m`
+- get volume level: `getv` or `-v`
+- get mute state: `getm` or `-g`
+
\*Volsv does not yet support muting the microphone in ALSA.