.\" Generated by scdoc 1.11.5
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "wlrctl" "1" "2026\-10\-30"
.PP
.SH NAME
.PP
wlrctl \- A command line utility for miscellaneous wlroots extensions
.PP
.SH SYNOPSIS
.PP
wlrctl [options.\&.\&.\&] [command]
.PP
.SH OPTIONS
.PP
\fB\-h, \-\-help\fR
.RS 4
Show a help message and quit.\&
.PP
.RE
\fB\-v, \-\-version\fR
.RS 4
Show the wlrctl version and quit.\&
.PP
.RE
.SH COMMANDS
.PP
\fBkeyboard\fR <action>
.RS 4
Use a virtual keyboard.\&
.PP
.RE
\fBpointer\fR <action>
.RS 4
Use a virtual pointer device.\&
.PP
.RE
\fBwindow|toplevel\fR <action>
.RS 4
Use the foreign toplevel interface.\&
.PP
.RE
\fBoutput\fR { <action> | <identifier> [config_action] }
.RS 4
Use the output management interface.\&
.PP
.RE
.SH KEYBOARD ACTIONS
.PP
\fBtype\fR <string> [modifiers .\&.\&.\&]
.RS 4
Send a string to be typed into the focused client
.PP
\fBmodifiers\fR <SHIFT,CTRL,ALT,SUPER>
Comma\-separated list of modifiers that will be depressed on the
virtual keyboard while string is being typed.\&
.PP
.RE
.SH POINTER ACTIONS
.PP
\fBclick\fR [button]
.RS 4
Click a mouse button.\& If unspecified, clicks the default (left) button.\&
.PP
.RE
\fBmove\fR <dx> <dy>
.RS 4
Move the cursor.\& \fIdx\fR is the displacement in positive\-right direction,
\fIdy\fR is the displacement in the positive\-downward direction.\& Negative
numbers are allowed.\& Units are pixels.\&
.PP
.RE
\fBscroll\fR <dy> <dx>
.RS 4
Scroll the cursor.\& \fIdy\fR is the amount of vertical scroll, \fIdx\fR is the
amount of horizontal scroll.\& Negative numbers are allowed.\&
.PP
.RE
.SH TOPLEVEL ACTIONS
.PP
\fBminimize\fR [matches.\&.\&.\&]
.RS 4
Instruct the compositor to minimize matching windows.\&
.PP
.RE
\fBmaximize\fR [matches.\&.\&.\&]
.RS 4
Instruct the compositor to maximize matching windows.\&
.PP
.RE
\fBfullscreen\fR [matches.\&.\&.\&]
.RS 4
Instruct the compositor to fullscreen matching windows.\&
.PP
.RE
\fBfocus\fR [matches.\&.\&.\&]
.RS 4
Instruct the compositor to focus matching windows.\&
.PP
.RE
\fBfind\fR [matches.\&.\&.\&]
.RS 4
Exit with a successful return code iff there is at least one window
matching the provided criteria.\&
.PP
.RE
\fBwait\fR [matches.\&.\&.\&]
.RS 4
Wait to return a successful return code until all the matching windows
have closed.\& If there are no matches, exit with a failing return code
immediately.\&
.PP
.RE
\fBwaitfor\fR [matches.\&.\&.\&]
.RS 4
Wait to return a successful return code until there is at least one
window that matches the requested criteria.\&
.PP
.RE
.SH OUTPUT ACTIONS
.PP
\fBlist\fR
.RS 4
List the names of all known outputs
.PP
.RE
.SH TOPLEVEL MATCHSPEC
.PP
A match is a colon separated attribute/value pair.\& e.\&g.\& To match a firefox
window, a suitable match value is \fIapp_id:firefox\fR.\& You may give any number of
match specifiers, and a window must match all of them to be considered.\& If the
app_id or title keys are specified more than once, a window may match any of
the given values.\& Otherwise later key value pairs override previous ones.\& A
match without a key is assumed to be an app_id, so just \fIfirefox\fR works in the
example above.\&
.PP
Currently supported attributes are: \fIapp_id\fR, \fItitle\fR, and \fIstate\fR.\&
.PP
Supported state values are: \fImaximized\fR, \fIminimized\fR, \fIactive\fR, and
\fIfullscreen\fR, and their negations: \fIunmaximized\fR, \fIunminimized\fR, \fIinactive\fR,
and \fIunfullscreen\fR.\&  You can also use a '\&\-'\& prefix, for example
\fIstate:\-fullscreen\fR.\&
.PP
.SH AUTHOR
.PP
Written by Ronan Pigott <rpigott@berkeley.\&edu>