From 49c629d4863c20b9e3c573d80254f8ce560e3d19 Mon Sep 17 00:00:00 2001 From: zachir Date: Fri, 12 Aug 2022 03:26:18 -0500 Subject: update README.md --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) (limited to 'README.md') 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` -- cgit v1.2.3