Updated documentation regarding --device. Fixes: #166

Author: ErikReider

README.md

@@ -52,24 +52,29 @@ Starting with Debian trixie and Ubuntu Plucky swayosd is available via apt.
 
 ## Usage:
 
-### SwayOSD LibInput Backend
+### SwayOSD Frontend
+
+`swayosd-server` must be running in the background.
+Use `swayosd-client` to send commands and display the OSD.
+
+### SwayOSD LibInput Backend (Optional)
+
+Used for notifying when caps-lock, scroll-lock, and num-lock is changed.
 
 Using Systemd: `sudo systemctl enable --now swayosd-libinput-backend.service`
 
 Other users can run: `pkexec swayosd-libinput-backend`
 
-### SwayOSD Frontend
-
-#### Sway examples
+### Sway examples
 
-##### Start Server
+#### Start Server
 
 ```zsh
 # OSD server
 exec swayosd-server
 ```
 
-##### Add Client bindings
+#### Add Client bindings
 
 ```zsh
 # Sink volume raise optionally with --device
@@ -101,10 +106,10 @@ bindsym --release Caps_Lock exec swayosd-client --caps-lock
 # Capslock but specific LED name (/sys/class/leds/)
 bindsym --release Caps_Lock exec swayosd-client --caps-lock-led input19::capslock
 
-# Brightness raise
-bindsym XF86MonBrightnessUp exec swayosd-client --brightness raise
-# Brightness lower
-bindsym XF86MonBrightnessDown exec swayosd-client --brightness lower
+# Brightness raise (optionally with --device, can be device name or wildcard)
+bindsym XF86MonBrightnessUp exec swayosd-client --brightness raise --device intel_backlight
+# Brightness lower (optionally with --device, can be device name or wildcard)
+bindsym XF86MonBrightnessDown exec swayosd-client --brightness lower --device intel_backlight
 
 # Brightness raise with custom value('+' sign needed)
 bindsym XF86MonBrightnessUp  exec swayosd-client --brightness +10
@@ -119,10 +124,11 @@ bindsym XF86AudioPlay exec swayosd-client --playerctl play-pause
 
 ### Notes on using `--device`:
 
-- It is for audio devices only.
-- If it is omitted the default audio device is used.
-- It only changes the target device for the current action that changes the volume.
+- It is for audio and BrightnessCtl devices only.
+- If it is omitted, the default audio / first BrightnessCtl device is used.
+- It only changes the target device for the current action that changes the volume / brightness.
 - You can list your input audio devices using `pactl list short sources`, for outputs replace `sources` with `sinks`.
+- You can list your brightness devices using `brightnessctl -l`, for backlights, use `brightnessctl -l -c backlight`.
 
 ### Notes on using `--monitor`:
 

src/args.rs

@@ -69,11 +69,10 @@ pub struct ArgsClient {
 	#[arg(long, value_name = "(+)number")]
 	pub max_volume: Option<String>,
 
-	/// For which device to increase/decrease audio
-	#[arg(
-		long,
-		value_name = "Pulseaudio device name (pactl list short sinks|sources)"
-	)]
+	/// For which device to increase/decrease audio/brightness.
+	/// Can be wildcard for brightness.
+	/// Ex: (pactl list short sinks|sources)/(brightnessctl -l -c backlight).
+	#[arg(long, value_name = "Pulseaudio/BrightnessCtl device name")]
 	pub device: Option<String>,
 
 	/// Shows brightness osd and raises or loweres all available sources of brightness device