.\" Man page generated from reStructuredText.
.
.TH PW-LINK 1 "" "" "General Commands Manual"
.SH NAME
pw-link \- The PipeWire Link Command
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.nf
\fBpw\-link\fP [\fIoptions\fP] \-o|\-i|\-l [\fIout\-pattern\fP] [\fIin\-pattern\fP]
.fi
.sp
.nf
\fBpw\-link\fP [\fIoptions\fP] \fIoutput\fP \fIinput\fP
.fi
.sp
.nf
\fBpw\-link\fP [\fIoptions\fP] \-d \fIoutput\fP \fIinput\fP
.fi
.sp
.nf
\fBpw\-link\fP [\fIoptions\fP] \-d \fIlink\-id\fP
.fi
.sp
.SH DESCRIPTION
.sp
List, create and destroy links between PipeWire ports.
.SH COMMON OPTIONS
.INDENT 0.0
.TP
.B \-r | \-\-remote=NAME
The name the \fIremote\fP instance to monitor. If left unspecified,
a connection is made to the default PipeWire instance.
.TP
.B \-h | \-\-help
Show help.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version
Show version information.
.UNINDENT
.SH LISTING PORTS AND LINKS
.sp
Specify one of \-o, \-i or \-l to list the matching optional input and
output ports and their links.
.INDENT 0.0
.TP
.B \-o | \-\-output
List output ports
.TP
.B \-i | \-\-input
List output ports
.TP
.B \-l | \-\-links
List links
.TP
.B \-m | \-\-monitor
Monitor links and ports. \fBpw\-link\fP will not exit but monitor and
print new and destroyed ports or links.
.TP
.B \-I | \-\-id
List IDs. Also list the unique link and port ids.
.TP
.B \-v | \-\-verbose
Verbose port properties. Also list the port\-object\-path and the port\-alias.
.UNINDENT
.SH CONNECTING PORTS
.sp
Without any list option (\-i, \-o or \-l), the given ports will be linked.
Valid port specifications are:
.INDENT 0.0
.TP
.B \fIport\-id\fP
As obtained with the \-I option when listing ports.
.TP
.B \fInode\-name:port\-name\fP
As obtained when listing ports.
.TP
.B \fIport\-object\-path\fP
As obtained from the first alternative name for the port when listing
them with the \-v option.
.TP
.B \fIport\-alias\fP
As obtained from the second alternative name for the ports when listing
them with the \-v option.
.UNINDENT
.sp
Extra options when linking can be given:
.INDENT 0.0
.TP
.B \-L | \-\-linger
Linger. Will create a link that exists after \fBpw\-link\fP is destroyed.
This is the default behaviour, unless the \-m option is given.
.TP
.B \-P | \-\-passive
Passive link. A passive link will keep both nodes it links inactive
unless another non\-passive link is activating the nodes. You can use this
to link a sink to a filter and have them both suspended when nothing else
is linked to either of them.
.TP
.B \-p | \-\-props=PROPS
Properties as JSON object. Give extra properties when creaing the link.
.UNINDENT
.SH DISCONNECTING PORTS
.sp
When the \-d option is given, an existing link between port is destroyed.
.sp
To disconnect port, a single \fIlink\-id\fP, as obtained when listing links with
the \-I option, or two port specifications can be given. See the connecting
ports section for valid port specifications.
.INDENT 0.0
.TP
.B \-d | \-\-disconnect
Disconnect ports
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
.TP
.B \fBpw\-link\fP \-iol
List all port and their links.
.TP
.B \fBpw\-link\fP \-lm
List all links and monitor changes until \fBpw\-link\fP is stopped.
.TP
.B \fBpw\-link\fP paplay:output_FL alsa_output.pci\-0000_00_1b.0.analog\-stereo:playback_FL
Link the given output port to the input port.
.TP
.B \fBpw\-link\fP \-lI
List links and their Id.
.TP
.B \fBpw\-link\fP \-d 89
Destroy the link with id 89.
.UNINDENT
.SH AUTHORS
.sp
The PipeWire Developers <\fI\%https://gitlab.freedesktop.org/pipewire/pipewire/issues\fP>; PipeWire is available from \fI\%https://pipewire.org\fP
.SH SEE ALSO
.sp
\fBpipewire(1)\fP,
\fBpw\-cli(1)\fP,
.\" Generated by docutils manpage writer.
.