aboutsummaryrefslogtreecommitdiffstats
path: root/kwin-type.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--kwin-type.156
1 files changed, 56 insertions, 0 deletions
diff --git a/kwin-type.1 b/kwin-type.1
new file mode 100644
index 0000000..3a51a4a
--- /dev/null
+++ b/kwin-type.1
@@ -0,0 +1,56 @@
+.\" SPDX-License-Identifier: GPL-2.0
+.\" Copyright (C) 2026 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved.
+
+.TH KWIN-TYPE 1 "2026 October 26" ZX2C4 "kwin-type"
+
+.SH NAME
+kwin-type \- type text from standard input using KWin
+
+.SH SYNOPSIS
+.B kwin-type
+
+.SH DESCRIPTION
+
+.B kwin-type
+reads UTF-8 text from standard input and types it into the focused application
+using KWin's fake input protocol. It takes no command-line arguments.
+
+Each character is sent as a key press and release. Newlines are sent as Enter
+key presses. If caps lock is enabled, it is temporarily disabled and restored
+on exit.
+
+The compositor must provide version 6 or later of
+.I org_kde_kwin_fake_input
+and version 1 or later of
+.IR org_kde_kwin_keystate .
+
+.SH EXAMPLES
+
+Type the contents of a file into the focused application:
+
+\fB $ kwin-type < text.txt\fP
+
+Type a line of text, followed by Enter:
+
+\fB $ printf \(aqHello, world!\en\(aq | kwin-type\fP
+
+Wait two seconds before typing, allowing time to focus another window:
+
+\fB $ sleep 2; kwin-type < text.txt\fP
+
+.SH EXIT STATUS
+
+.B kwin-type
+exits with status 0 on success, 1 on error, or 128 plus the signal number when
+interrupted by SIGINT, SIGTERM, or SIGHUP.
+
+.SH AUTHOR
+.B kwin-type
+was written by
+.MT Jason@zx2c4.com
+Jason A. Donenfeld
+.ME .
+For updates and more information, a project page is available on the
+.UR https://\:git.zx2c4.com/\:kwin-type/\:about/
+World Wide Web
+.UE .