.\"
.\" Copyright © 2018 Keith Packard
.\"
.\" Permission to use, copy, modify, distribute, and sell this software and its
.\" documentation for any purpose is hereby granted without fee, provided that
.\" the above copyright notice appear in all copies and that both that copyright
.\" notice and this permission notice appear in supporting documentation, and
.\" that the name of the copyright holders not be used in advertising or
.\" publicity pertaining to distribution of the software without specific,
.\" written prior permission.  The copyright holders make no representations
.\" about the suitability of this software for any purpose.  It is provided "as
.\" is" without express or implied warranty.
.\"
.\" THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
.\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
.\" EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
.\" CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
.\" DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
.\" OF THIS SOFTWARE.
.\"
.TH XLEASE 1 "xlease 0.1" "X Version 11"
.SH NAME
xlease \- lease an X output for another DRM application
.SH SYNOPSIS
.B "xlease"
.RI [\-\-help] [\-\-verbose]
.RI [\-\-output \fIoutput\fP]
.RI [\-\-display \fIdisplay\fP]
.RI [\-\-fd_arg \fIname\fP]
.IR <command> <arg> ...
.SH DESCRIPTION
.I Xlease
is used to borrow a set of DRM resources from the X server and hand
them to another application (potentially another X server) for
independent use. The resources are leased from the X server DRM master
and attached to a new DRM master associated with a file
descriptor. That file descriptor is passed on the command line to the
application which can then perform KMS operations on the descriptor to
configure it for display.
.IP \-\-help
Print out a usage summary and exit.
.IP \-\-verbose
Increase the verbosity of the application, printing out various
progress messages and other information.
.IP "\-\-output \fIoutput\fP"
Borrow the specified output for use. This option is required.
.IP "\-\-display \fIdisplay\fP"
Connect to the specified X server.
.IP "\-\-fd-arg \fIargument-name\fP"
.I Xlease
passes the DRM master file descriptor on the command line to the
application. This option allows the configuration of the flag for that
value, by default it is “-masterfd”.
.IP "<command> <arg> ..."
This specifies the program to be run. By default, this is “X -seat
seat1 :1”. The fd-arg parameter is added to this, and then the file
descriptor in decimal, so if no parameters are provided to
.I xlease
then the command that will be run is
.RS
X -seat seat1 :1 -masterfd 4
.RE
.PP
For this to be able to open suitable input devices, they must first be
assigned to the specified seat, perhaps by using loginctl, and the
devices must be accessible by the user running the application.
.SH EXAMPLES
Starts another X server on connection :1 for seat 1 using output HDMI-2
.RS
xlease --output HDMI-2
.RE
.PP
More verbose example that does exactly the same, just with all
parameters specified on the command line:
.RS
xlease --display :0 --output HDMI-2 -fd-arg -master-fd -- X -seat
seat1 :1
.SH "SEE ALSO"
Xrandr(1), X(1)
.SH AUTHORS
Keith Packard,
keithp@keithp.com