Skip to content

Commit cae3557

Browse files
committed
man: unify pactl and pacmd suspend command documentation
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
1 parent b1d74c8 commit cae3557

File tree

2 files changed

+28
-19
lines changed

2 files changed

+28
-19
lines changed

man/pactl.1.xml.in

+16-16
Original file line numberDiff line numberDiff line change
@@ -129,27 +129,27 @@ License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
129129
</option>
130130

131131
<option>
132-
<p><opt>suspend-sink</opt> <arg>SINK</arg> <arg>1|0</arg></p>
132+
<p><opt>suspend-sink</opt> <arg>SINK</arg> <arg>true|false</arg></p>
133133
<optdesc><p>Suspend or resume the specified sink (which may be
134-
specified either by its symbolic name, or by its numeric index),
135-
depending whether 1 (suspend) or 0 (resume) is passed as last
136-
argument. Suspending a sink will pause all playback. Depending
137-
on the module implementing the sink this might have the effect
138-
that the underlying device is closed, making it available for
139-
other applications to use. The exact behaviour depends on the
140-
module.</p></optdesc>
134+
specified either by its name or index), depending whether true
135+
(suspend) or false (resume) is passed as last argument. Suspending
136+
a sink will pause all playback. Depending on the module implementing
137+
the sink this might have the effect that the underlying device is
138+
closed, making it available for other applications to use. The exact
139+
behaviour depends on the module.
140+
</p></optdesc>
141141
</option>
142142

143143
<option>
144-
<p><opt>suspend-source</opt> <arg>SOURCE</arg> <arg>1|0</arg></p>
144+
<p><opt>suspend-source</opt> <arg>SOURCE</arg> <arg>true|false</arg></p>
145145
<optdesc><p>Suspend or resume the specified source (which may be
146-
specified either by its symbolic name, or by its numeric index),
147-
depending whether 1 (suspend) or 0 (resume) is passed as last
148-
argument. Suspending a source will pause all
149-
capturing. Depending on the module implementing the source this
150-
might have the effect that the underlying device is closed,
151-
making it available for other applications to use. The exact
152-
behaviour depends on the module.</p></optdesc>
146+
specified either by its name or index), depending whether true
147+
(suspend) or false (resume) is passed as last argument. Suspending
148+
a source will pause all capturing. Depending on the module implementing
149+
the source this might have the effect that the underlying device is
150+
closed, making it available for other applications to use. The exact
151+
behaviour depends on the module.
152+
</p></optdesc>
153153
</option>
154154

155155
<option>

man/pulse-cli-syntax.5.xml.in

+12-3
Original file line numberDiff line numberDiff line change
@@ -163,9 +163,18 @@ License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
163163
</option>
164164

165165
<option>
166-
<p><opt>suspend-sink|suspend-source</opt> <arg>index|name</arg> <arg>boolean</arg></p>
167-
<optdesc><p>Suspend (i.e. disconnect from the underlying hardware) a sink
168-
(resp. source).</p></optdesc>
166+
<p><opt>suspend-sink|suspend-source</opt> <arg>name|index</arg>
167+
<arg>true|false</arg>
168+
</p>
169+
<optdesc><p>Suspend or resume the specified sink or source (which may be
170+
specified either by its name or index), depending whether true
171+
(suspend) or false (resume) is passed as last argument. Suspending
172+
a sink will pause all playback and suspending a source will pause all
173+
capturing. Depending on the module implementing the sink or source this
174+
might have the effect that the underlying device is closed, making it
175+
available for other applications to use. The exact behaviour depends on
176+
the module.
177+
</p></optdesc>
169178
</option>
170179

171180
<option>

0 commit comments

Comments
 (0)