From c8a3bdbf8e55c532967b2dd7bd6a55b2f2ce292a Mon Sep 17 00:00:00 2001 From: Tassilo Horn Date: Wed, 13 Apr 2022 12:40:50 +0200 Subject: [PATCH] Update README --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 2f2d572..7ff67f6 100644 --- a/README.md +++ b/README.md @@ -507,6 +507,8 @@ Right now, there are the following modules: charging), and the [state of health](https://en.wikipedia.org/wiki/State_of_health). 4. The `date` module can show, you guess it, the current date and time! +5. The `pactl` module can show the current volume percentage and muted state. + Clicks can increase/decrease the volume or toggle the mute state. I guess there will be more modules in the future as time permits. I personally would enjoy a `volume` module. [Patches](#questions-and-patches) are certainly @@ -606,6 +608,7 @@ on_click = { Left = ['swayr', 'switch-to-urgent-or-lru-window'], Right = ['kill' but then it has to be on one single line. + #### The `window` module The `window` module supports the following placeholders: @@ -613,6 +616,11 @@ The `window` module supports the following placeholders: * `{app_name}` is the application name. * `{pid}` is the process id. +By default, it has the following click bindings: +* `Left` executes `swayr switch-to-urgent-or-lru-window`. +* `Right` kills the process of the window. + + #### The `sysinfo` module The `sysinfo` module supports the following placeholders: @@ -622,6 +630,10 @@ The `sysinfo` module supports the following placeholders: * `{load_avg_5}` is the average system load in the last five minutes. * `{load_avg_15}` is the average system load in the last fifteen minutes. +By default, it has the following click bindings: +* `Left` executes `foot htop`. + + #### The `battery` module The `battery` module supports the following placeholders: @@ -631,6 +643,21 @@ The `battery` module supports the following placeholders: compared to its original capacity. * `{state}` is the current state, e.g., something like Discharging or Full. + +#### The `pactl` module + +The `pactl` module requires the pulse-audio command line tool of the same name +to be installed. It supports the following placeholders: +* `{volume}` is the current volume percentage of the default sink. +* `{muted}` is the string `" muted"` if the default sink is currently muted, + otherwise it is the empty string. + +By default, it has the following click bindings: +* `Left` calls the `pavucontrol` program (PulseAudio GUI control). +* `Right` toggles the default sink's mute state. +* `WheelUp` and `WheelDown` increase/decrease the volume of the default sink. + + #### The `date` module The `date` module shows the date and time by defining the `format` using