.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "VOLUMEICON.5 5"
.TH VOLUMEICON.5 5 "2017-07-22" "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"
\&\fIvolumeicon\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 \s-1GTK+\s0 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 \fB\f(BIvolumeicon\fB\|(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 \s-1GNU\s0 General Public License version 3. See \fB\s-1COPYING\s0\fR in the distribution for detailed license text.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIvolumeicon\fR\|(1), \fIalsamixer\fR\|(1), \fIxev\fR\|(1)