-h|--help
Show help.
--version
Show version information.
--dump-conf
Load the daemon configuration file daemon.conf (see below), parse remaining configuration options
on the command line and dump the resulting daemon configuration, in a format that is compatible
with daemon.conf.
--dump-modules
List available loadable modules. Combine with -v for a more elaborate listing.
--dump-resample-methods
List available audio resamplers.
--cleanup-shm
Identify stale PulseAudio POSIX shared memory segments in /dev/shm and remove them if possible.
This is done implicitly whenever a new daemon starts up or a client tries to connect to a daemon.
It should normally not be necessary to issue this command by hand. Only available on systems with
POSIX shared memory segments implemented via a virtual file system mounted to /dev/shm (e.g.
Linux).
--start
Start PulseAudio if it is not running yet. This is different from starting PulseAudio without
--start which would fail if PA is already running. PulseAudio is guaranteed to be fully
initialized when this call returns. Implies --daemonize.
-k|--kill
Kill an already running PulseAudio daemon of the calling user (Equivalent to sending a SIGTERM).
--check
Return 0 as return code when the PulseAudio daemon is already running for the calling user, or
non-zero otherwise. Produces no output on the console except for errors to stderr.
Note that a non-zero return value doesn't necessarily mean that PulseAudio is not usable. Even if
the server is not running, it may get automatically started via PulseAudio's autospawning
mechanism or systemd's socket activation, or the environment might be such that checking for
processes doesn't work (for example, the running server might not show up in a container, even if
the server is accessible via a socket). Also disabling PID files with --use-pid-file=no prevents
--check from detecting running servers.
A more robust check in most situations would be to try establishing a client connection to the
server. Unfortunately there's currently no --check-connection option to replace --check, but
running "pactl info" could be a pretty good substitute.
--system[=BOOL]
Run as system-wide instance instead of per-user. Please note that this disables certain features
of PulseAudio and is generally not recommended unless the system knows no local users (e.g. is a
thin client). This feature needs special configuration and a dedicated UNIX user set up. It is
highly recommended to combine this with --disallow-module-loading (see below).
-D|--daemonize[=BOOL]
Daemonize after startup, i.e. detach from the terminal. Note that when running as a systemd
service you should use --daemonize=no for systemd notification to work.
--fail[=BOOL]
Fail startup when any of the commands specified in the startup script default.pa (see below)
fails.
--high-priority[=BOOL]
Try to acquire a high Unix nice level. This will only succeed if the calling user has a non-zero
RLIMIT_NICE resource limit set (on systems that support this), or we're configured to be run as
system daemon (see --system above). It is recommended to enable this, since it is only a
negligible security risk (see below).
--realtime[=BOOL]
Try to acquire a real-time scheduling for PulseAudio's I/O threads. This will only succeed if the
calling user has a non-zero RLIMIT_RTPRIO resource limit set (on systems that support this), or
rtkit is available and allows PulseAudio to enable real-time scheduling, or we are configured to
be run as system daemon (see --system above).
--disallow-module-loading[=BOOL]
Disallow module loading after startup. This is a security feature since it disallows additional
module loading during runtime and on user request. It is highly recommended when --system is used
(see above). Note however, that this breaks certain features like automatic module loading on hot
plug.
--disallow-exit[=BOOL]
Disallow user requested exit
--exit-idle-time=SECS
Terminate the daemon after the last client quit and this time in seconds passed. Use a negative
value to disable this feature. Defaults to 20.
When PulseAudio runs in the per-user mode and detects a login session, then any positive value
will be reset to 0 so that PulseAudio will terminate immediately on logout. A positive value
therefore has effect only in environments where there's no support for login session tracking (or
if the user is logged in without a session spawned, a.k.a. lingering). A negative value can still
be used to disable any automatic exit.
When PulseAudio runs in the system mode, automatic exit is always disabled, so this option does
nothing.
--scache-idle-time=SECS
Unload autoloaded samples from the cache when they haven't been used for the specified number of
seconds.
--log-level[=LEVEL]
If an argument is passed, set the log level to the specified value, otherwise increase the
configured verbosity level by one. The log levels are numerical from 0 to 4, corresponding to
error, warn, notice, info, debug. Default log level is notice, i.e. all log messages with lower
log levels are printed: error, warn, notice.
-v|--verbose
Increase the configured verbosity level by one (see --log-level above). Specify multiple times to
increase log level multiple times.
--log-target={auto,syslog,journal,stderr,file:PATH,newfile:PATH}
Specify the log target. If set to auto (which is the default), then logging is directed to syslog
when --daemonize is passed, otherwise to STDERR. If set to journal logging is directed to the
systemd journal. If set to file:PATH, logging is directed to the file indicated by PATH.
newfile:PATH is otherwise the same as file:PATH, but existing files are never overwritten. If the
specified file already exists, a suffix is added to the file name to avoid overwriting.
--log-meta[=BOOL]
Show source code location in log messages.
--log-time[=BOOL]
Show timestamps in log messages.
--log-backtrace=FRAMES
When FRAMES is greater than 0, log for each message a stack trace up to the number of specified
stack frames.
-p|--dl-search-path=PATH
Set the search path for dynamic shared objects (plugins).
--resample-method=METHOD
Use the specified resampler by default (See --dump-resample-methods above for possible values).
--use-pid-file[=BOOL]
Create a PID file. If this options is disabled it is possible to run multiple sound servers per
user.
--no-cpu-limit[=BOOL]
Do not install CPU load limiter on platforms that support it. By default, PulseAudio will
terminate itself when it notices that it takes up too much CPU time. This is useful as a
protection against system lockups when real-time scheduling is used (see below). Disabling this
mechanism is useful when debugging PulseAudio with tools like valgrind(1) which slow down
execution.
--disable-shm[=BOOL]
PulseAudio clients and the server can exchange audio data via POSIX or memfd shared memory
segments (on systems that support this). If disabled PulseAudio will communicate exclusively over
sockets. Please note that data transfer via shared memory segments is always disabled when
PulseAudio is running with --system enabled (see above).
--enable-memfd[=BOOL]
PulseAudio clients and the server can exchange audio data via memfds - the anonymous Linux Kernel
shared memory mechanism (on kernels that support this). If disabled PulseAudio will communicate
via POSIX shared memory.
-L|--load="MODULEARGUMENTS"
Load the specified plugin module with the specified arguments.
-F|--file=FILENAME
Run the specified script on startup. May be specified multiple times to specify multiple scripts
to be run in order. Combine with -n to disable loading of the default script default.pa (see
below).
-C Open a command interpreter on STDIN/STDOUT after startup. This may be used to configure PulseAudio
dynamically during runtime. Equivalent to --load=module-cli.
-n Don't load default script file default.pa (see below) on startup. Useful in conjunction with -C or
--file.