.\" 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 "wlcctrl" "1" "2026\-11\-07"
.PP
.SH NAME
.PP
wlcctrl \- A command line utility for kylin\-wayland\-compositor
.PP
.SH SYNOPSIS
.PP
wlcctrl [command] [options.\&.\&.\&]
.PP
.SH GLOBAL OPTIONS
.PP
\fB\-\-help\fR
.RS 4
Show a help message and quit.\&
.PP
.RE
\fB\-v, \-\-version\fR
.RS 4
Show a wlcctrl version and quit.\&
.PP
.RE
\fB\-\-exec\fR <str>
.RS 4
Execute a shell command.\&
.PP
.RE
\fB\-\-sleep\fR <int_ms>
.RS 4
Set sleep time in milliseconds.\& Can be combined with other commands.\&
.PP
example:
.RS 4
wlcctrl \-\-keydown a \-\-sleep 1000 \-\-keyup a
wlcctrl \-\-mousepress 1 \-\-sleep 200 \-\-mouserelease 1
.PP
.RE
.RE
\fB\-\-path\fR <str>
.RS 4
Set screenshot save path (PNG format).\& Uses last value when set multiple times.\&
.PP
with \fB\-\-windowcapture\fR:
.RS 4
Set the window screenshot saved path.\&
.RE
with \fB\-\-workspacecapture\fR:
.RS 4
Set the workspace screenshot saved path.\&
.RE
with \fB\-\-fullscreencapture\fR:
.RS 4
Set the screen/output screenshot saved path.\&
.PP
.RE
example: wlcctrl \-\-windowcapture uuid \-\-path "/home/kylin/xxx.\&png"
.PP
.RE
\fB\-o\fR <o_uuid>
.RS 4
Specify output device by UUID.\& Uses last value when set multiple times.\&
.PP
.RE
.SH KEYBOARD OPTIONS
.PP
\fB\-\-keystring\fR <string>
.RS 4
Send a string to be typed into the focused client.\& No commands can chain after '\&keystring'\&.\&
.PP
.RE
\fB\-\-key\fR <key>
.RS 4
Send key events.\& Single key or key combination.\&
.PP
Note: CapsLock(58), NumLock(69), ScrollLock(70) may not switch states normally.\&
For reliable lock key functionality, use ydotool instead.\&
.PP
Key mappings:
.RS 4
"PrintScreen" \-> "sys_req"
"esc" \-> "escape"
"ctrl" \-> "control_l"
"shift" \-> "shift_l"
"alt" \-> "alt_l"
"winleft" \-> "super_l"
"enter" \-> "return"
.PP
.RE
Valid keys: escape, return, shift_l, shift_r, control_l, control_r,
meta_l, meta_r, alt_l, alt_r, page_up, page_down, menu, caps_lock,
pause, break, print, sys_req, scroll_lock, num_lock, etc.\&
.PP
Multiple keys separated by '\&+'\&.\&
.PP
examples:
.RS 4
wlcctrl \-\-key control_l+alt_l+t
wlcctrl \-\-key ctrl+alt+t
wlcctrl \-\-key super_l
.PP
.RE
.RE
\fB\-\-keyup\fR <key>
.RS 4
Release a single key.\&
.PP
.RE
\fB\-\-keydown\fR <key>
.RS 4
Press a single key.\&
.PP
with \fB\-\-keyup\fR:
.RS 4
Indicate pressing and releasing a key.\&
.RE
otherwise: Indicate the state of a key being pressed individually.\&
The command defaults to releasing the key upon completion.\&
.PP
.RE
.SH POINTER OPTIONS
.PP
\fB\-\-mousebutton\fR <button>
.RS 4
Click mouse button.\&
.PP
Button codes:
.RS 4
1 = BTN_LEFT
2 = BTN_RIGHT
3 = BTN_MIDDLE
4 = BTN_EXTRA
5 = BTN_SIDE
6 = BTN_FORWARD
7 = BTN_BACK
.PP
.RE
example:
.RS 4
wlcctrl \-\-mousebutton 2
.PP
.RE
.RE
\fB\-\-mousepress\fR [button]
.RS 4
Press a mouse button.\&
.PP
Button codes:
.RS 4
1 = BTN_LEFT
2 = BTN_RIGHT
3 = BTN_MIDDLE
4 = BTN_EXTRA
5 = BTN_SIDE
6 = BTN_FORWARD
7 = BTN_BACK
.PP
.RE
with \fB\-\-mouserelease\fR
.RS 4
Indicate pressing and releasing a mouse button.\&
.RE
width \fB\-\-mousemove\fR
.RS 4
Can be combined into a drag\-and\-drop action.\&
.RE
otherwise: Indicate the state of an individual mouse button being pressed.\&
The command defaults to releasing the mouse button upon completion.\&
.PP
example: Click a mouse button.\&
.RS 4
wlcctrl \-\-mousepress 2 \-\-mouserelease 2
.RE
example: Complete a drag\-and\-drop action.\&
.RS 4
/wlcctrl \-\-mousemove 500,600 \-\-mousepress 1 \-\-mousemove 100,200 \-\-mouserelease 1
.PP
.RE
.RE
\fB\-\-mouserelease\fR [button]
.RS 4
Release a mouse button.\&
.PP
Button codes: BTN_LEFT\->1 | BTN_RIGHT\->2 | BTN_MIDDLE\->3 | BTN_EXTRA\->4 |
BTN_SIDE\->5 | BTN_FORWARD\->6 | BTN_BACK\->7
.PP
.RE
\fB\-\-mousemove\fR <dx,dy>
.RS 4
Move cursor.\& dx = right displacement, dy = down displacement.\&
Only non\-negative numbers allowed.\& Units: pixels.\&
.PP
example:
.RS 4
wlcctrl \-\-mousemove 100,500
.PP
.RE
.RE
\fB\-\-scroll\fR [\fB\-x\fR <dx>] [\fB\-y\fR <dy>]
.RS 4
Scroll cursor.\& Negative numbers allowed.\&
.PP
examples:
.RS 4
wlcctrl \-\-scroll \-y 10
wlcctrl \-\-scroll \-x 10 \-y 20
.PP
.RE
.RE
\fB\-\-getmouselocation\fR
.RS 4
Get the current mouse position.\&
.PP
.RE
.SH TOPLEVEL OPTIONS
.PP
\fB\-l, \-\-list\fR
.RS 4
List the names of all known toplevel.\&
.PP
.RE
\fB\-\-windowmove\fR <w_uuid> [options.\&.\&.\&]
.RS 4
Move the window to a specified position.\&
.PP
\fB\-x\fR <dx>
.RS 4
\fIdx\fR is the displacement in positive\-right direction.\&
.RE
\fB\-y\fR <dy>
.RS 4
\fIdy\fR is the displacement in the positive\-downward direction.\&
.RE
Only non\-negative numbers are allowed.\&
.PP
example: wlcctrl \-\-windowmove 182fcd8f\-6136\-413b\-aa1b\-c77b066ebe23 \-x 200 \-y 400
.PP
.RE
\fB\-\-windowsize\fR <w_uuid> [options.\&.\&.\&]
.RS 4
Resize the window.\&
\fIw_uuid\fR: This is the UUID of the toplevel device.\&
.PP
\fB\-w\fR <width>
.RS 4
\fIwidth\fR is the desired window width.\&
.RE
\fB\-h\fR <height>
.RS 4
\fIheight\fR is the desired window height.\&
.RE
Units are pixels.\&
.PP
example: wlcctrl \-\-windowsize 182fcd8f\-6136\-413b\-aa1b\-c77b066ebe23 \-w 800 \-h 600
.PP
.RE
\fB\-\-windowminimize\fR <w_uuid>
.RS 4
Minimize window.\&
\fIw_uuid\fR is the UUID of the toplevel.\&
.PP
.RE
\fB\-\-windowmaximize\fR <w_uuid>
.RS 4
Maximize window.\&
The default output device is the primary display.\&
\fIw_uuid\fR is the UUID of the toplevel.\&
.PP
with \fB\-o\fR
.RS 4
Set the output device for the action.\&
.RE
example: wlcctrl \-\-windowmaximize <w_uuid> \-o <o_uuid>
.PP
.RE
\fB\-\-windowfullscreen\fR <w_uuid>
.RS 4
Fullscreen window.\&
The default output device is the primary display.\&
\fIw_uuid\fR is the UUID of the toplevel.\&
.PP
with \fB\-o\fR
.RS 4
Set the output device for the action.\&
.RE
example: wlcctrl \-\-windowfullscreen <w_uuid> \-o <o_uuid>
.PP
.RE
\fB\-\-windowenter\fR <w_uuid:uuid>
.RS 4
Add the window into the specified workspace.\&
\fIw_uuid\fR is the UUID of the toplevel.\&
\fIuuid\fR is the workspace that window to be entered.\&
.PP
.RE
\fB\-\-windowleave\fR <w_uuid:uuid>
.RS 4
Remove the window from the specified workspace.\&
\fIw_uuid\fR is the UUID of the toplevel.\&
\fIuuid\fR is the workspace that window to be left.\&
.PP
.RE
\fB\-\-movewindowtoworkspace\fR <w_uuid:uuid>
.RS 4
Move the window to the specified workspace.\&
\fIw_uuid\fR is the UUID of the toplevel.\&
\fIuuid\fR is the workspace that window moved to.\&
.PP
.RE
\fB\-\-movewindowtooutput\fR <w_uuid:o_uuid>
.RS 4
Move the window to the specified output device.\&
\fIw_uuid\fR is the UUID of the toplevel.\&
\fIo_uuid\fR is the UUID of the output device.\&
.PP
.RE
\fB\-\-windowmap\fR <w_uuid>
.RS 4
Restore window.\&
\fIw_uuid\fR is the UUID of the toplevel.\&
.PP
.RE
\fB\-\-windowclose\fR <w_uuid>
.RS 4
Close window.\&
\fIw_uuid\fR is the UUID of the toplevel.\&
.PP
.RE
\fB\-\-windowkill\fR <app_id>
.RS 4
Force close all windows of the specified app_id.\&
.PP
.RE
\fB\-\-windowactivate\fR <w_uuid>
.RS 4
Activate the specified window.\&
\fIw_uuid\fR is the UUID of the toplevel.\&
.PP
.RE
\fB\-\-windowcapture\fR <w_uuid>
.RS 4
Take a screenshot of a window.\& Saved by default in the current working directory.\&
\fIw_uuid\fR is the UUID of the toplevel.\&
.PP
.RE
\fB\-\-getactivewindow\fR
.RS 4
Get the current active window.\&
.PP
.RE
\fB\-\-getwindowname\fR <w_uuid>
.RS 4
Query the app ID, title, icon and pid of a specific window.\&
\fIw_uuid\fR is the UUID of the toplevel.\&
.PP
.RE
\fB\-\-getwindowgeometry\fR <w_uuid>
.RS 4
Query the geometry of a specific window.\&
\fIw_uuid\fR is the UUID of the toplevel.\&
.PP
.RE
\fB\-\-search\fR <name>
.RS 4
Obtain the window UUID list by checking if the regular expression pattern matches the window app_id, icon and title.\&
.PP
.RE
.SH OUTPUT OPTIONS
.PP
\fB\-\-outputs\fR
.RS 4
List the name of all known outputs.\&
.PP
.RE
\fB\-\-getdisplaygeometry\fR <o_uuid>
.RS 4
Get the geometry of a specified output.\&
\fIo_uuid\fR is the UUID of the output device.\&
.PP
.RE
\fB\-\-fullscreencapture\fR
.RS 4
Take a fullscreen screenshot.\& Saved the file to the current working directory by default.\&
By default, capture a fullscreen image of the primary display.\&
.PP
example: wlcctrl \-\-fullscreencapture
.PP
with \fB\-o\fR
.RS 4
Set the output device for the action.\&
.RE
example: wlcctrl \-\-fullscreencapture \-o <o_uuid>
.PP
.RE
\fB\-\-setarea\fR <x,y,width,height>
.RS 4
Area screenshot.\& Set the position and size of the rectangular region.\&
The default output device is the primary display.\&
.PP
\fIx\fR is X coordinate of the screenshot area in output coordinate.\&
\fIy\fR is Y coordinate of the screenshot area in output coordinate.\&
\fIwidth\fR is Width of the screenshot area.\&
\fIheight\fR is Height of the screenshot area.\&
.PP
with \fB\-o\fR
.RS 4
Set the output device for the area.\&
.RE
with \fB\-\-path\fR
.RS 4
Set the screenshot save path.\&
.RE
example: wlcctrl \-\-setarea 10,40,500,100 \-\-path "/home/kylin/xxx.\&png"
.RS 4
wlcctrl \-\-setarea 10,40,500,500 \-\-path "/home/kylin/xxx111.\&png" \-o d4d40b7b\-5e2e\-396a\-eaa2\-7b5efea5a3ec
.PP
.RE
.RE
\fB\-\-getpixelcolor\fR <x,y>
.RS 4
Get the RGBA value of a pixel at a specified position.\&
The default output device is the primary display.\&
\fIx\fR is X coordinate of the point in output coordinate.\&
\fIy\fR is Y coordinate of the point in output coordinate.\&
.PP
with \fB\-o\fR
.RS 4
Set the output device for the pixel location.\&
.RE
example: wlcctrl \-\-getpixelcolor 100,3
.PP
.RE
.SH WORKSPACE OPTIONS
.PP
\fB\-\-workspace\fR
.RS 4
List the name of all known workspaces.\&
.PP
.RE
\fB\-\-workspacecapture\fR <uuid:o_uuid>
.RS 4
Take a screenshot of a workspace.\& Saved the file to the current working directory by default.\&
\fIuuid\fR is the workspace that needs to be captured.\&
\fIo_uuid\fR is the UUID of the output device.\&
.PP
.RE
\fB\-\-workspaceadd\fR <num>
.RS 4
Add new workspaces.\& If \fInum\fR is unspecified, a workspace will be added by default.\&
.PP
.RE
\fB\-\-workspaceremove\fR <uuid>
.RS 4
Remove the specified workspace.\&
\fIuuid\fR: The workspace that needs to be operated on.\&
.PP
.RE
\fB\-\-workspaceactive\fR <uuid>
.RS 4
Activate the specified workspace.\&
\fIuuid\fR is the workspace that needs to be operated on.\&
.RE