.TH "pipewire" 1 "1.0.5" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pipewire \- The PipeWire media server
.PP
.SH "SYNOPSIS"
.PP
.PP
\fBpipewire\fP [\fIoptions\fP]
.PP
.SH "DESCRIPTION"
.PP
.PP
PipeWire is a service that facilitates sharing of multimedia content between devices and applications\&.
.PP
The \fBpipewire\fP daemon reads a config file that is further documented in \fBpipewire\&.conf(5)\fP manual page\&.
.PP
.SH "OPTIONS"
.PP
.PP
\fB-h | --help\fP
.RS 4
Show help\&.
.RE
.PP
\fB-v | --verbose\fP
.RS 4
Increase the verbosity by one level\&. This option may be specified multiple times\&.
.RE
.PP
\fB--version\fP
.RS 4
Show version information\&.
.RE
.PP
\fB-c | --config=FILE\fP
.RS 4
Load the given config file (Default: pipewire\&.conf)\&.
.RE
.PP
.SH "RUNTIME SETTINGS"
.PP
A PipeWire daemon will also expose a settings metadata object that can be used to change some settings at runtime\&.
.PP
Normally these settings can bypass any of the restrictions listed in the config options above, such as quantum and samplerate values\&.
.PP
The settings can be modified using \fBpw-metadata(1)\fP: 
.PP
.nf
pw\-metadata \-n settings                  # list settings
pw\-metadata \-n settings 0                # list server settings
pw\-metadata \-n settings 0 log\&.level 2    # modify a server setting

.fi
.PP
.PP
\fBlog\&.level = INTEGER\fP
.RS 4
Change the log level of the PipeWire daemon\&.
.RE
.PP
\fBclock\&.rate = INTEGER\fP
.RS 4
The default samplerate\&.
.RE
.PP
\fBclock\&.allowed-rates = [ RATE1 RATE2\&.\&.\&. ]\fP
.RS 4
The allowed samplerates\&.
.RE
.PP
\fBclock\&.force-rate = INTEGER\fP
.RS 4
Temporarily forces the graph to operate in a fixed sample rate\&. Both DSP processing and devices will switch to the new rate immediately\&. Running streams (PulseAudio, native and ALSA applications) will automatically resample to match the new rate\&.
.PP
Set the value to 0 to allow the sample rate to vary again\&. 
.RE
.PP
.PP
\fBclock\&.quantum = INTEGER\fP
.RS 4
The default quantum (buffer size)\&.
.RE
.PP
\fBclock\&.min-quantum = INTEGER\fP
.RS 4
Smallest quantum to be used\&.
.RE
.PP
\fBclock\&.max-quantum = INTEGER\fP
.RS 4
Largest quantum to be used\&.
.RE
.PP
\fBclock\&.force-quantum = INTEGER\fP
.RS 4
Temporarily force the graph to operate in a fixed quantum\&.
.PP
Set the value to 0 to allow the quantum to vary again\&. 
.RE
.PP
.SH "ENVIRONMENT VARIABLES"
.PP
.SS "Socket directories"
.PP
\fBPIPEWIRE_RUNTIME_DIR \fP
.RS 4

.RE
.PP
\fBXDG_RUNTIME_DIR \fP
.RS 4

.RE
.PP
\fBUSERPROFILE \fP
.RS 4
Used to find the PipeWire socket on the server (and native clients)\&.
.RE
.PP
\fBPIPEWIRE_CORE \fP
.RS 4
Name of the socket to make\&.
.RE
.PP
\fBPIPEWIRE_REMOTE \fP
.RS 4
Name of the socket to connect to\&.
.RE
.PP
\fBPIPEWIRE_DAEMON \fP
.RS 4
If set to true then the process becomes a new PipeWire server\&.
.RE
.PP
.SS "Config directories, config file name and prefix"
.PP
\fBPIPEWIRE_CONFIG_DIR \fP
.RS 4

.RE
.PP
\fBXDG_CONFIG_HOME \fP
.RS 4

.RE
.PP
\fBHOME \fP
.RS 4
Used to find the config file directories\&.
.RE
.PP
\fBPIPEWIRE_CONFIG_PREFIX \fP
.RS 4

.RE
.PP
\fBPIPEWIRE_CONFIG_NAME \fP
.RS 4
Used to override the application provided config prefix and config name\&.
.RE
.PP
\fBPIPEWIRE_NO_CONFIG \fP
.RS 4
Enables (false) or disables (true) overriding on the default configuration\&.
.RE
.PP
.SS "Context information"
.PP
As part of a client context, the following information is collected from environment variables and placed in the context properties:
.PP
\fBLANG \fP
.RS 4
The current language in \fRapplication\&.language\fP\&.
.RE
.PP
\fBXDG_SESSION_ID \fP
.RS 4
Set as the \fRapplication\&.process\&.session-id\fP property\&.
.RE
.PP
\fBDISPLAY \fP
.RS 4
Is set as the \fRwindow\&.x11\&.display\fP property\&.
.RE
.PP
.SS "Modules"
.PP
\fBPIPEWIRE_MODULE_DIR \fP
.RS 4
Sets the directory where to find PipeWire modules\&.
.RE
.PP
\fBSPA_SUPPORT_LIB \fP
.RS 4
The name of the SPA support lib to load\&. This can be used to switch to an alternative support library, for example, to run on the EVL realtime kernel\&.
.RE
.PP
.SS "Logging options"
.PP
\fBJOURNAL_STREAM \fP
.RS 4
Is used to parse the stream used for the journal\&. This is usually configured by systemd\&.
.RE
.PP
\fBPIPEWIRE_LOG_LINE \fP
.RS 4
Enables the logging of line numbers\&. Default true\&.
.RE
.PP
\fBPIPEWIRE_LOG \fP
.RS 4
Specifies a log file to use instead of the default logger\&.
.RE
.PP
\fBPIPEWIRE_LOG_SYSTEMD \fP
.RS 4
Enables the use of systemd for the logger, default true\&.
.RE
.PP
.SS "Other settings"
.PP
\fBPIPEWIRE_CPU \fP
.RS 4
Selects the CPU and flags\&. This is a bitmask of any of the \fBCPU\fP flags
.RE
.PP
\fBPIPEWIRE_VM \fP
.RS 4
Selects the Virtual Machine PipeWire is running on\&. This can be any of the \fBVM\fP types\&.
.RE
.PP
\fBDISABLE_RTKIT \fP
.RS 4
Disables the use of RTKit or the Realtime Portal for realtime scheduling\&.
.RE
.PP
\fBNO_COLOR \fP
.RS 4
Disables the use of colors in the console output\&.
.RE
.PP
.SS "Debugging options"
.PP
\fBPIPEWIRE_DLCLOSE \fP
.RS 4
Enables (true) or disables (false) the use of dlclose when a shared library is no longer in use\&. When debugging, it might make sense to disable dlclose to be able to get debugging symbols from the object\&.
.RE
.PP
.SS "Stream options"
.PP
\fBPIPEWIRE_NODE \fP
.RS 4
Makes a stream connect to a specific \fRobject\&.serial\fP or \fRnode\&.name\fP\&.
.RE
.PP
\fBPIPEWIRE_PROPS \fP
.RS 4
Adds extra properties to a stream or filter\&.
.RE
.PP
\fBPIPEWIRE_QUANTUM \fP
.RS 4
Forces a specific rate and buffer-size for the stream or filter\&.
.RE
.PP
\fBPIPEWIRE_LATENCY \fP
.RS 4
Sets a specific latency for a stream or filter\&. This is only a suggestion but the configured latency will not be larger\&.
.RE
.PP
\fBPIPEWIRE_RATE \fP
.RS 4
Sets a rate for a stream or filter\&. This is only a suggestion\&. The rate will be switched when the graph is idle\&.
.RE
.PP
\fBPIPEWIRE_AUTOCONNECT \fP
.RS 4
Overrides the default stream autoconnect settings\&.
.RE
.PP
.SS "Plugin options"
.PP
\fBSPA_PLUGIN_DIR \fP
.RS 4
Is used to locate SPA plugins\&.
.RE
.PP
\fBSPA_DATA_DIR \fP
.RS 4
Is used to locate plugin specific config files\&. This is used by the bluetooth plugin currently to locate the quirks database\&.
.RE
.PP
\fBSPA_DEBUG \fP
.RS 4
Set the log level for SPA plugins\&. This is usually controlled by the \fRPIPEWIRE_DEBUG\fP variable when the plugins are managed by PipeWire but some standalone tools (like spa-inspect) uses this variable\&.
.RE
.PP
\fBACP_BUILDDIR \fP
.RS 4
If set, the ACP profiles are loaded from the builddir\&.
.RE
.PP
\fBACP_PATHS_DIR \fP
.RS 4

.RE
.PP
\fBACP_PROFILES_DIR \fP
.RS 4
Used to locate the ACP paths and profile directories respectively\&.
.RE
.PP
\fBLADSPA_PATH \fP
.RS 4
Comma separated list of directories where the ladspa plugins can be found\&.
.RE
.PP
\fBLIBJACK_PATH \fP
.RS 4
Directory where the jack1 or jack2 libjack\&.so can be found\&.
.RE
.PP
.SH "AUTHORS"
.PP
.PP
The PipeWire Developers <https://gitlab.freedesktop.org/pipewire/pipewire/issues>; PipeWire is available from <https://pipewire.org>
.PP
.SH "SEE ALSO"
.PP
.PP
\fBpw-top(1)\fP, \fBpw-dump(1)\fP, \fBpw-mon(1)\fP, \fBpw-cat(1)\fP, \fBpw-cli(1)\fP, \fBlibpipewire-modules(7)\fP