.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "VOLUMEICON.5 5"
.TH VOLUMEICON.5 5 2024-03-12 0.5.1 volumeicon
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
volumeicon \- configuration file for volumeicon(1)
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fB~/.config/volumeicon/volumeicon\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBvolumeicon\fR\|(1) obtains configuration information from \fB~/.config/volumeicon/volumeicon\fR. This configuration file can be overridden on runtime via \fB\-\-config\fR switch.
.PP
The configuration syntax is similar of those .ini files.
.IP \fB[Alsa]\fR 4
.IX Item "[Alsa]"
This section holds alsa sound card configuration.
.RS 4
.IP \fBcard\fR 4
.IX Item "card"
Specify which sound card to control. The default value is \fBdefault\fR.
.IP \fBchannel\fR 4
.IX Item "channel"
Specify the channel to control. This defaults to the first channel of the selected card/device.
.IP \fBlogarithmic_scale\fR 4
.IX Item "logarithmic_scale"
Use logarithmic volume scale which mimics how humans perceive changes in volume. The default value is \fBfalse\fR.
.RE
.RS 4
.RE
.IP \fB[Notification]\fR 4
.IX Item "[Notification]"
This section holds notification configuration.
.RS 4
.IP \fBshow_notification\fR 4
.IX Item "show_notification"
The value can be either \fBtrue\fR to enable notification or \fBfalse\fR to disable notification.
.IP \fBnotification_type\fR 4
.IX Item "notification_type"
The value can be either \fB1\fR for libnotify based notification or \fB0\fR for GTK+ popup notification.
.RE
.RS 4
.RE
.IP \fB[StatusIcon]\fR 4
.IX Item "[StatusIcon]"
This section holds status icon configuration. The configuration items are as follows.
.RS 4
.IP \fBstepsize\fR 4
.IX Item "stepsize"
Configure how many steps when changing volume. Takes an integer value. The default is \fB5\fR.
.IP \fBonclick\fR 4
.IX Item "onclick"
Configure the command executed when clicking \fBvolumeicon\|(1)\fR applet. The default is \fBxterm \-e 'alsamixer'\fR.
.IP \fBtheme\fR 4
.IX Item "theme"
Icon theme to use. The default is \fBtango\fR
.IP \fBuse_panel_specific_icons\fR 4
.IX Item "use_panel_specific_icons"
Whether to use panel-provided icon. The default is \fBfalse\fR.
.IP \fBlmb_slider\fR 4
.IX Item "lmb_slider"
Whether to show volume slider. The default is \fBfalse\fR.
.IP \fBmmb_mute\fR 4
.IX Item "mmb_mute"
whether to use middle mouse button to toggle mute. The default is \fBfalse\fR.
.IP \fBuse_horizontal_slider\fR 4
.IX Item "use_horizontal_slider"
Whether to use horizontal slider. The default is \fBtrue\fR.
.IP \fBshow_sound_level\fR 4
.IX Item "show_sound_level"
Whether to show sound level. The default is \fBfalse\fR.
.IP \fBuse_transparent_background\fR 4
.IX Item "use_transparent_background"
Whether to use transparent background. The default is \fBfalse\fR.
.RE
.RS 4
.RE
.IP \fB[Hotkeys]\fR 4
.IX Item "[Hotkeys]"
This section holds the hotkey configuration for volume manipulation.
.RS 4
.IP \fBup_enabled\fR 4
.IX Item "up_enabled"
Whether to enable volume up hotkey. The default is \fBfalse\fR.
.IP \fBdown_enabled\fR 4
.IX Item "down_enabled"
whether to enable volume down hotkey. The default is \fBfalse\fR.
.IP \fBmute_enabled\fR 4
.IX Item "mute_enabled"
Whether to enable volume mute hotkey. The default is \fBfalse\fR.
.IP \fBup\fR 4
.IX Item "up"
Hotkey to increase volume. The default is \fBXF86AudioRaiseVolume\fR.
.IP \fBdown\fR 4
.IX Item "down"
Hotkey to decrease volume. The default is \fBXF86AudioLowerVolume\fR.
.IP \fBmute\fR 4
.IX Item "mute"
Hotkey to toggle mute. The default is \fBXF86AudioMute\fR.
.RE
.RS 4
.RE
.SH BUGS
.IX Header "BUGS"
Submit bug reports and pull requests to Github <https://github.com/Maato/volumeicon>
.SH LICENSE
.IX Header "LICENSE"
This program is licensed under GNU General Public License version 3. See \fBCOPYING\fR in the distribution for detailed license text.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBvolumeicon\fR\|(1), \fBalsamixer\fR\|(1), \fBxev\fR\|(1)