mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-12-16 08:56:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

man: unify pactl and pacmd suspend command documentation

Browse source 
The suspend-sink and suspend-source documentation for pacmd was quite
terse, so I copied the more complete documentation from pactl. I
couldn't resist doing some other minor edits along the way too.

Bug-link: https://bugs.freedesktop.org/show_bug.cgi?id=105907
This commit is contained in:
Tanu Kaskinen 2018-04-08 13:23:11 +03:00
parent b1d74c86c2
commit cae3557c52
2 changed files with 28 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

32
man/pactl.1.xml.in
View file

@ -129,27 +129,27 @@ License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
</option> </option>
<option> <option>
<p><opt>suspend-sink</opt> <arg>SINK</arg> <arg>1|0</arg></p> <p><opt>suspend-sink</opt> <arg>SINK</arg> <arg>true|false</arg></p>
<optdesc><p>Suspend or resume the specified sink (which may be <optdesc><p>Suspend or resume the specified sink (which may be
specified either by its symbolic name, or by its numeric index), specified either by its name or index), depending whether true
depending whether 1 (suspend) or 0 (resume) is passed as last (suspend) or false (resume) is passed as last argument. Suspending
argument. Suspending a sink will pause all playback. Depending a sink will pause all playback. Depending on the module implementing
on the module implementing the sink this might have the effect the sink this might have the effect that the underlying device is
that the underlying device is closed, making it available for closed, making it available for other applications to use. The exact
other applications to use. The exact behaviour depends on the behaviour depends on the module.
module.</p></optdesc> </p></optdesc>
</option> </option>
<option> <option>
<p><opt>suspend-source</opt> <arg>SOURCE</arg> <arg>1|0</arg></p> <p><opt>suspend-source</opt> <arg>SOURCE</arg> <arg>true|false</arg></p>
<optdesc><p>Suspend or resume the specified source (which may be <optdesc><p>Suspend or resume the specified source (which may be
specified either by its symbolic name, or by its numeric index), specified either by its name or index), depending whether true
depending whether 1 (suspend) or 0 (resume) is passed as last (suspend) or false (resume) is passed as last argument. Suspending
argument. Suspending a source will pause all a source will pause all capturing. Depending on the module implementing
capturing. Depending on the module implementing the source this the source this might have the effect that the underlying device is
might have the effect that the underlying device is closed, closed, making it available for other applications to use. The exact
making it available for other applications to use. The exact behaviour depends on the module.
behaviour depends on the module.</p></optdesc> </p></optdesc>
</option> </option>
<option> <option>

15
man/pulse-cli-syntax.5.xml.in
View file

@ -163,9 +163,18 @@ License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
</option> </option>
<option> <option>
<p><opt>suspend-sink|suspend-source</opt> <arg>index|name</arg> <arg>boolean</arg></p> <p><opt>suspend-sink|suspend-source</opt> <arg>name|index</arg>
<optdesc><p>Suspend (i.e. disconnect from the underlying hardware) a sink <arg>true|false</arg>
(resp. source).</p></optdesc> </p>
<optdesc><p>Suspend or resume the specified sink or source (which may be
specified either by its name or index), depending whether true
(suspend) or false (resume) is passed as last argument. Suspending
a sink will pause all playback and suspending a source will pause all
capturing. Depending on the module implementing the sink or source this
might have the effect that the underlying device is closed, making it
available for other applications to use. The exact behaviour depends on
the module.
</p></optdesc>
</option> </option>
<option> <option>