.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SFWBAR-PULSE" 1 "" ""
.SH NAME
sfwbar-pulse \- Sfwbar PulseAudio module
.sp
Filename: pulsectl.so
.sp
Requires: libpulse
.SH SYNOPSIS
.sp
The PulseAudio module provides an interface to query and adjust the settings of
the PulseAudio server.
.SH EXPRESSION FUNCTIONS
.SS Pulse(Query[,Interface])
.sp
function Pulse queries the state of the Pulse server, the Query parameter
specifies the information to query, the optional Interface parameter
specifies the interface to which the query applies. If the Interface isn\(aqt
given the query is applied to the current sink or the current source. The
supported query types are:
.INDENT 0.0
.TP
.B \(dqsink\-volume\(dq
the volume of a sink.
.TP
.B \(dqsink\-mute\(dq
muted state of the sink.
.TP
.B \(dqsink\-icon\(dq
sink icon.
.TP
.B \(dqsink\-form\(dq
the form of the sink.
.TP
.B \(dqsink\-port\(dq
the port name of the sink.
.TP
.B \(dqsink\-monitor\(dq
name of the source monitor for the sink.
.TP
.B \(dqsource\-volume\(dq
the volume of a source.
.TP
.B \(dqsource\-mute\(dq
muted state of the source.
.TP
.B \(dqsource\-icon\(dq
source icon.
.TP
.B \(dqsource\-form\(dq
the form of the source.
.TP
.B \(dqsource\-port\(dq
the port name of the source.
.TP
.B \(dqsource\-monitor\(dq
name of the sink monitor for the source.
.UNINDENT
.SH ACTIONS
.SS PulseCmd [Interface,],Command
.sp
Manipulate the state of the interface, if the interface isn\(aqt specified, the
Command will be applied to the current interface.
.INDENT 0.0
.TP
.B \(dqsink\-volume +/\-X\(dq
Adjust the volume of the sink by X%.
.TP
.B \(dqsink\-mute State\(dq
Change the state of the sink, State can be On, Off or Toggle.
.TP
.B \(dqsource\-volume +/\-X\(dq
Adjust the volume of the source by X%.
.TP
.B \(dqsource\-mute State\(dq
Change the state of the source, State can be On, Off or Toggle.
.UNINDENT
.SH TRIGGERS
.sp
The module defines one trigger \(dqPulse\(dq which is emitted whenever the state of
the pulse server changes.
.SH COPYRIGHT
GPLv3+
.\" Generated by docutils manpage writer.
.