1 <?xml version=
"1.0"?><!--*-nxml-*-->
2 <!DOCTYPE manpage SYSTEM
"xmltoman.dtd">
3 <?xml-stylesheet type=
"text/xsl" href=
"xmltoman.xsl" ?>
6 This file is part of PulseAudio.
8 PulseAudio is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as
10 published by the Free Software Foundation; either version 2.1 of the
11 License, or (at your option) any later version.
13 PulseAudio is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
16 Public License for more details.
18 You should have received a copy of the GNU Lesser General Public
19 License along with PulseAudio; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
24 <manpage name=
"pulse-cli-syntax" section=
"5" desc=
"PulseAudio Command Line Interface Syntax">
27 <p><file>~/.config/pulse/default.pa
</file></p>
28 <p><file>@PA_DEFAULT_CONFIG_DIR@/default.pa
</file></p>
29 <p><file>@PA_DEFAULT_CONFIG_DIR@/system.pa
</file></p>
34 PulseAudio provides a simple command line language used by configuration
35 scripts, the pacmd interactive shell, and the modules module-cli and
36 module-cli-protocol-{unix,tcp}. Empty lines and lines beginning with a
37 hashmark (#) are silently ignored. Several commands are supported.
41 Note that any boolean arguments can be given positively as '
1', 't', 'y',
42 'true', 'yes' or 'on'. Likewise, negative values can be given as '
0',
43 'f', 'n', 'false', 'no' or 'off'. Case is ignored.
47 <section name=
"General Commands">
50 <p><opt>help
</opt></p>
51 <optdesc><p>Show a quick help on the commands available.
</p></optdesc>
55 <section name=
"Status_Commands">
57 <p><opt>list-modules
</opt></p>
58 <optdesc><p>Show all currently loaded modules with their arguments.
</p></optdesc>
62 <p><opt>list-cards
</opt></p>
63 <optdesc><p>Show all currently registered cards
</p></optdesc>
67 <p><opt>list-sinks
</opt> or
<opt>list-sources
</opt></p>
68 <optdesc><p>Show all currently registered sinks (resp. sources).
</p></optdesc>
72 <p><opt>list-clients
</opt></p>
73 <optdesc><p>Show all currently active clients.
</p></optdesc>
77 <p><opt>list-sink-inputs
</opt> or
<opt>list-source-outputs
</opt></p>
78 <optdesc><p>Show all currently active inputs to sinks a.k.a. playback
79 streams (resp. outputs of sources a.k.a. recording streams).
</p></optdesc>
83 <p><opt>stat
</opt></p>
84 <optdesc><p>Show some simple statistics about the allocated memory blocks and the space used by them.
</p></optdesc>
88 <p><opt>info
</opt> or
<opt>ls
</opt> or
<opt>list
</opt></p>
89 <optdesc><p>A combination of all status commands described above (all
90 three commands are synonyms).
</p></optdesc>
94 <section name=
"Module Management">
96 <p><opt>load-module
</opt> <arg>name
</arg> [
<arg>arguments...
</arg>]
</p>
97 <optdesc><p>Load a module specified by its name and arguments. For most
98 modules it is OK to be loaded more than once.
</p></optdesc>
102 <p><opt>unload-module
</opt> <arg>index|name
</arg></p>
103 <optdesc><p>Unload a module, specified either by its index in the module
104 list or its name.
</p></optdesc>
108 <p><opt>describe-module
</opt> <arg>name
</arg></p>
109 <optdesc><p>Give information about a module specified by its name.
</p></optdesc>
113 <section name=
"Volume Commands">
115 <p><opt>set-sink-volume|set-source-volume
</opt> <arg>index|name
</arg> <arg>volume
</arg></p>
116 <optdesc><p>Set the volume of the specified sink (resp. source). You may
117 specify the sink (resp. source) either by its index in the sink/source list
118 or by its name. The volume should be an integer value greater or equal than
119 0 (muted). Volume
65536 (
0x10000) is 'normal' volume a.k.a.
100%. Values
120 greater than this amplify the audio signal (with clipping).
</p></optdesc>
124 <p><opt>set-sink-mute|set-source-mute
</opt> <arg>index|name
</arg> <arg>boolean
</arg></p>
125 <optdesc><p>Mute or unmute the specified sink (resp. source). You may
126 specify the sink (resp. source) either by its index or by its name.
127 The mute value is either
0 (not muted) or
1 (muted).
</p></optdesc>
131 <p><opt>set-sink-input-volume|set-source-output-volume
</opt> <arg>index
</arg> <arg>volume
</arg></p>
132 <optdesc><p>Set the volume of a sink input (resp. source output) specified
133 by its index. The same volume rules apply as with set-sink-volume.
</p></optdesc>
137 <p><opt>set-sink-input-mute|set-source-output-mute
</opt> <arg>index
</arg> <arg>boolean
</arg></p>
138 <optdesc><p>Mute or unmute a sink input (resp. source output) specified
139 by its index. The same mute rules apply as with set-sink-mute.
</p></optdesc>
143 <section name=
"Configuration Commands">
145 <p><opt>set-default-sink|set-default-source
</opt> <arg>index|name
</arg></p>
146 <optdesc><p>Make a sink (resp. source) the default. You may specify the
147 sink (resp. source) by its index in the sink (resp. source) list or by its
148 name.
</p><p>Note that defaults may be overridden by various policy modules
149 or by specific stream configurations.
</p></optdesc>
153 <p><opt>set-card-profile
</opt> <arg>index|name
</arg> <arg>profile-name
</arg></p>
154 <optdesc><p>Change the profile of a card.
</p></optdesc>
158 <p><opt>set-sink-port|set-source-port
</opt> <arg>index|name
</arg> <arg>port-name
</arg></p>
159 <optdesc><p>Change the profile of a sink (resp. source).
</p></optdesc>
163 <p><opt>set-port-latency-offset
</opt> <arg>card-index|card-name
</arg> <arg>port-name
</arg> <arg>offset
</arg> </p>
164 <optdesc><p>Change the latency offset of a port belonging to the specified card
</p></optdesc>
168 <p><opt>suspend-sink|suspend-source
</opt> <arg>index|name
</arg> <arg>boolean
</arg></p>
169 <optdesc><p>Suspend (i.e. disconnect from the underlying hardware) a sink
170 (resp. source).
</p></optdesc>
174 <p><opt>suspend
</opt> <arg>boolean
</arg></p>
175 <optdesc><p>Suspend all sinks and sources.
</p></optdesc>
179 <section name=
"Moving streams">
181 <p><opt>move-sink-input|move-source-output
</opt> <arg>index
</arg> <arg>sink-index|sink-name
</arg></p>
182 <optdesc><p>Move sink input (resp. source output) to another sink
183 (resp. source).
</p></optdesc>
187 <section name=
"Property lists">
189 <p><opt>update-sink-proplist|update-source-proplist
</opt> <arg>index|name
</arg> <arg>properties
</arg></p>
190 <optdesc><p>Update the properties of a sink (resp. source) specified by
191 name or index. The property is specified as e.g. device.
description=
"My
192 Preferred Name"</p></optdesc>
196 <p><opt>update-sink-input-proplist|update-source-output-proplist
</opt> <arg>index
</arg> <arg>properties
</arg></p>
197 <optdesc><p>Update the properties of a sink input (resp. source output)
198 specified by index. The properties are specified as above.
</p></optdesc>
202 <section name=
"Sample Cache">
204 <p><opt>list-samples
</opt></p>
205 <optdesc><p>Lists the contents of the sample cache.
</p></optdesc>
209 <p><opt>play-sample
</opt> <arg>name
</arg> <arg>sink-index|sink-name
</arg></p>
210 <optdesc><p>Play a sample cache entry to a sink.
</p></optdesc>
214 <p><opt>remove-sample
</opt> <arg>name
</arg></p>
215 <optdesc><p>Remove an entry from the sample cache.
</p></optdesc>
219 <p><opt>load-sample
</opt> <arg>name
</arg> <arg>filename
</arg></p>
220 <optdesc><p>Load an audio file to the sample cache.
</p></optdesc>
224 <p><opt>load-sample-lazy
</opt> <arg>name
</arg> <arg>filename
</arg></p>
225 <optdesc><p>Create a new entry in the sample cache, but don't load the
226 sample immediately. The sample is loaded only when it is first used.
227 After a certain idle time it is freed again.
</p></optdesc>
231 <p><opt>load-sample-dir-lazy
</opt> <arg>path
</arg></p>
232 <optdesc><p>Load all entries in the specified directory into the sample
233 cache as lazy entries. A shell globbing expression (e.g. *.wav) may be
234 appended to the path of the directory to add.
</p></optdesc>
238 <section name=
"Killing Clients/Streams">
240 <p><opt>kill-client
</opt> <arg>index
</arg></p>
241 <optdesc><p>Remove a client forcibly from the server. There is no protection
242 against the client reconnecting immediately.
</p></optdesc>
246 <p><opt>kill-sink-input|kill-source-output
</opt> <arg>index
</arg></p>
247 <optdesc><p>Remove a sink input (resp. source output) forcibly from the
248 server. This will not remove the owning client or any other streams opened
249 by the same client from the server.
</p></optdesc>
253 <section name=
"Log Commands">
255 <p><opt>set-log-level
</opt> <arg>numeric-level
</arg></p>
256 <optdesc><p>Change the log level.
</p></optdesc>
260 <p><opt>set-log-meta
</opt> <arg>boolean
</arg></p>
261 <optdesc><p>Show source code location in log messages.
</p></optdesc>
265 <p><opt>set-log-target
</opt> <arg>target
</arg></p>
266 <optdesc><p>Change the log target (null, auto, syslog, stderr, file:PATH, newfile:PATH).
</p></optdesc>
270 <p><opt>set-log-time
</opt> <arg>boolean
</arg></p>
271 <optdesc><p>Show timestamps in log messages.
</p></optdesc>
275 <p><opt>set-log-backtrace
</opt> <arg>num-frames
</arg></p>
276 <optdesc><p>Show backtrace in log messages.
</p></optdesc>
280 <section name=
"Miscellaneous Commands">
282 <p><opt>play-file
</opt> <arg>filename
</arg> <arg>sink-index|sink-name
</arg></p>
283 <optdesc><p>Play an audio file to a sink.
</p></optdesc>
287 <p><opt>dump
</opt></p>
288 <optdesc><p>Dump the daemon's current configuration in CLI commands.
</p></optdesc>
292 <p><opt>dump-volumes
</opt></p>
293 <optdesc><p>Debug: Shows the current state of all volumes.
</p></optdesc>
297 <p><opt>shared
</opt></p>
298 <optdesc><p>Debug: Show shared properties.
</p></optdesc>
302 <p><opt>exit
</opt></p>
303 <optdesc><p>Terminate the daemon. If you want to terminate a CLI
304 connection (
"log out") you might want to use ctrl+d
</p></optdesc>
308 <section name=
"Meta Commands">
310 In addition to the commands described above there are a few meta directives
311 supported by the command line interpreter.
314 <p><opt>.include
</opt> <arg>filename|folder
</arg></p>
315 <optdesc><p>Executes the commands from the specified script file or in all
316 of the *.pa file within the folder.
</p></optdesc>
319 <p><opt>.fail
</opt> and
<opt>.nofail
</opt></p>
320 <optdesc><p>Enable (resp. disable) that following failing commands will
321 cancel the execution of the current script file. This is a ignored when
322 used on the interactive command line.
</p></optdesc>
326 <section name=
"Authors">
327 <p>The PulseAudio Developers
<@PACKAGE_BUGREPORT@
>;
328 PulseAudio is available from
<url href=
"@PACKAGE_URL@"/></p>
331 <section name=
"See also">
333 <manref name=
"default.pa" section=
"5"/>,
334 <manref name=
"pacmd" section=
"1"/>,
335 <manref name=
"pulseaudio" section=
"1"/>