summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md22
1 files changed, 16 insertions, 6 deletions
diff --git a/README.md b/README.md
index 06d680f..996cd3f 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-# Volsv
+# VolSV
+
+Volume Setter V
#### What is it?
@@ -6,30 +8,38 @@ Volsv is a POSIX-compliant shell script I wrote in 2020, and have been modifying
- Increasing volume
- Decreasing volume
-- Toggling the interface mute
+- Toggling the output mute
- Toggling the microphone mute
- Getting the volume
- Getting the mute state
+- Getting both volume and mute state
-in both pulseaudio and ALSA. Once I get OpenBSD and FreeBSD up and running, I will add those sound options too.
+in pipewire, pulseaudio, sndio, and ALSA. Once I get FreeBSD up and running, I will add those sound options too.
It depends on:
-- pamixer (pulseaudio)
+- pamixer (pulseaudio/pipewire)
- amixer (alsa)
+- mixerd (sndio)
- pgrep (with the -x command, standard in BSD and \*/Linux systems)
#### But *why* though?
-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.
+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, 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`
+- toggle microphone mute: `mic` or `-m`
- get volume level: `getv` or `-v`
- get mute state: `getm` or `-g`
+- get volume and mute: `getvm` or `-vm`
- help message: `-h`