.TH "pw-reserve" 1 "1.0.6" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pw-reserve \- The PipeWire device reservation utility
.PP
.SH "SYNOPSIS"
.PP
.PP
\fBpw-reserve\fP [\fIoptions\fP]
.PP
.SH "DESCRIPTION"
.PP
.PP
Reserves a device using the DBus \fRorg\&.freedesktop\&.ReserveDevice1\fP device reservation scheme [1], waiting until terminated by \fRSIGINT\fP or another signal\&.
.PP
It can also request other applications to release a device\&. This can be used to make audio servers such as PipeWire, Pulseaudio, JACK, or other applications that respect the device reservation protocol, to ignore a device, or to release a sound device they are already using so that it can be used by other applications\&.
.PP
.SH "OPTIONS"
.PP
.PP
\fB-r | --release\fP
.RS 4
Request any client currently holding the device to release it, and try to reserve it after that\&. If this option is not given and the device is already in use, \fBpw-reserve\fP will exit with error status\&.
.RE
.PP
\fB-n NAME | --name=NAME\fP
.RS 4
Name of the device to reserve\&. By convention, this is
.PP
.IP "\(bu" 2
Audio\fIN\fP: for ALSA card number \fIN\fP
.PP
.PP
\fBpw-reserve\fP can reserve any device name, however PipeWire does not currently support other values than listed above\&. 
.RE
.PP
.PP
\fB-a NAME | --appname=NAME\fP
.RS 4
Application name to use when reserving the device\&.
.RE
.PP
\fB-p PRIO | --priority=PRIO\fP
.RS 4
Priority to use when reserving the device\&.
.RE
.PP
\fB-m | --monitor\fP
.RS 4
Monitor reservations of a given device, instead of reserving it\&.
.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 device reservation succeeds, \fBpw-reserve\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-reserve\fP -n Audio0
.PP
Reserve ALSA card 0, and exit with error if it is already reserved\&.
.PP
\fBpw-reserve\fP -n Audio0 -r
.PP
Reserve ALSA card 0, requesting any applications that have reserved the device to release it for us\&.
.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://git.0pointer.net/reserve.git/tree/reserve.txt - A simple device reservation scheme with DBus