VOLUMEICON.5(5)

📦
version 0.5.1+git20230228 · 6 versions
, in ubuntu noble, ubuntu questing

💖 VOLUMEICON.5 💖

okay so bestie, this is the manual page for the volumeicon config file — that's the fifth section of the manual, the one for file formats — and it's genuinely the glow-up guide for volumeicon(1). read this and your lil volume applet will be serving exactly the vibe you want. 🎀

✨ NAME ✨

volumeicon — the configuration file for volumeicon(1). it's giving "settings but make it a text file". 💅

🌸 SYNOPSIS 🌸

~/.config/volumeicon/volumeicon

that's it. that's the whole path. so simple, so iconic. 🦋

💜 DESCRIPTION 💜

volumeicon(1) gets all its configuration tea from ~/.config/volumeicon/volumeicon. and ngl, if you don't like what's in there at any given moment, you can override the whole file on runtime with the --config switch. main character energy: the command line wins. 👑

the syntax is basically the same as those .ini files you've definitely seen before — sections in square brackets, keys and values inside them. iykyk. ✨

🎀 [Alsa]

this section holds the alsa sound card configuration. the audio source of truth, fr fr.

  • card — tells it which sound card to control. the default value is default. yes the default is literally the word default, we love a self-referential moment. 💖
  • channel — which channel to control. if you don't say anything, it defaults to the first channel of the selected card/device. it just picks for you, generous queen. 🌸
  • logarithmic_scale — use a logarithmic volume scale, which mimics how humans actually perceive changes in volume. the default value is false. so by default it's linear, and turning this on makes it feel natural to your ears. 🔥

🔔 [Notification]

this section holds notification configuration. the popups!! the little moments!!

  • show_notification — value can be either true to enable notification, or false to disable it. pick a lane bestie. 💅
  • notification_type — value can be either 1 for libnotify based notification, or 0 for GTK+ popup notification. one or zero, no in-between. ⭐

👑 [StatusIcon]

this section holds status icon configuration. the configuration items are as follows — and there are a LOT of them, so buckle up:

  • stepsize — configure how many steps when changing volume. takes an integer value. the default is 5. 🎚️
  • onclick — configure the command executed when clicking the volumeicon(1) applet. the default is xterm -e 'alsamixer'. so click it and alsamixer pops open, iconic behaviour honestly. 🖱️
  • theme — icon theme to use. the default is tango. 💃
  • use_panel_specific_icons — whether to use the panel-provided icon. the default is false. 🖼️
  • lmb_slider — whether to show the volume slider. the default is false. 🎀
  • mmb_mute — whether to use the middle mouse button to toggle mute. the default is false. 🖱️
  • use_horizontal_slider — whether to use a horizontal slider. the default is true. so it's horizontal out of the box, slay. ➡️
  • show_sound_level — whether to show sound level. the default is false. 🔊
  • use_transparent_background — whether to use a transparent background. the default is false. 🫧

⌨️ [Hotkeys]

this section holds the hotkey configuration for volume manipulation. keyboard shortcuts, the moment we've all been waiting for. ⌨️✨

  • up_enabled — whether to enable the volume up hotkey. the default is false. ⬆️
  • down_enabled — whether to enable the volume down hotkey. the default is false. ⬇️
  • mute_enabled — whether to enable the volume mute hotkey. the default is false. 🔇
  • up — hotkey to increase volume. the default is XF86AudioRaiseVolume. 🔼
  • down — hotkey to decrease volume. the default is XF86AudioLowerVolume. 🔽
  • mute — hotkey to toggle mute. the default is XF86AudioMute. 🤫
heads up bestie: those three hotkeys are false by default for their *_enabled flags, so the keybinds won't do anything until you flip them on. no cap. 🚨

🐛 BUGS 🐛

found a bug? submit bug reports and pull requests to Github at https://github.com/Maato/volumeicon. they want to hear from you, fr fr. 💌

📜 LICENSE 📜

this program is licensed under GNU General Public License version 3. see COPYING in the distribution for the detailed license text. read the fine print, it's important. 🫶

🌈 SEE ALSO 🌈

k that's the whole page bestie 💖 go forth and configure, you're gonna absolutely eat this. sending love, stay tuned, and remember: version 0.5.1 dropped on 2024-04-01 — so if you're running that, you're running the real thing. mwah. 💅✨🎀🦋🌸

📦 where this page comes from