.TH "pw-container" 1 "1.6.8" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pw-container \- The PipeWire container utility

.PP
.SH "SYNOPSIS"
.PP

.PP
\fBpw-container\fP [\fIoptions\fP] [\fIPROGRAM\fP]

.PP
.SH "DESCRIPTION"
.PP

.PP
Run a program in a new security context [1]\&.

.PP
\fBpw-container\fP will create a new temporary unix socket and uses the SecurityContext extension API to create a server on this socket with the given properties\&. Clients created from this server socket will have the security properties attached to them\&.

.PP
This can be used to simulate the behaviour of Flatpak or other containers\&.

.PP
Without any arguments, \fBpw-container\fP simply creates the new socket and prints the address on stdout\&. Other PipeWire programs can then be run with \fRPIPEWIRE_REMOTE=<socket-address>\fP to connect through this security context\&.

.PP
When \fIPROGRAM\fP is given, the \fRPIPEWIRE_REMOTE\fP env variable will be set and \fIPROGRAM\fP will be passed to system()\&. Argument to \fIPROGRAM\fP need to be properly quoted\&.

.PP
.SH "OPTIONS"
.PP

.PP
\fB-P | --properties=VALUE\fP
.RS 4
Set extra context properties as a JSON object\&.
.RE
.PP
\fB-r | --remote=NAME\fP
.RS 4
The name the \fIremote\fP instance to connect to\&. If left unspecified, a connection is made to the default PipeWire instance\&.
.RE
.PP
\fB-h | --help\fP
.RS 4
Show help\&.
.RE
.PP
\fB--version\fP
.RS 4
Show version information\&.
.RE
.PP
.SH "EXIT STATUS"
.PP

.PP
If the security context was successfully created, \fBpw-container\fP does not exit until terminated with a signal\&. It exits with status 0 if terminated by SIGINT or SIGTERM in this case\&.

.PP
Otherwise, it exits with nonzero exit status\&.

.PP
.SH "EXAMPLES"
.PP

.PP
\fBpw-container\fP 'pw-dump i 0'

.PP
Run pw-dump of the Core object\&. Note the difference in the object permissions when running pw-dump with and without \fBpw-container\fP\&.

.PP
\fBpw-container\fP 'pw-dump pw-dump'

.PP
Run pw-dump of itself\&. Note the difference in the Client security tokens when running pw-dump with and without \fBpw-container\fP\&.

.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
[1] https://gitlab.freedesktop.org/wayland/wayland-protocols/-/blob/main/staging/security-context/security-context-v1.xml - Creating a security context