Skip to content

Commit c6daa79

Browse files
committed
Expand manpage
1 parent 21528f2 commit c6daa79

File tree

1 file changed

+36
-11
lines changed

1 file changed

+36
-11
lines changed

man/wtype.1

+36-11
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,50 @@
11
.\" Manpage for wtype.
2-
.TH man 1 "23 November 2020" "0.2" "wtype man page"
2+
.TH wtype 1 "23 November 2020" "0.2" "wtype man page"
33
.SH NAME
44
wtype \- xdotool type for Wayland
55
.SH SYNOPSIS
6-
wtype [text]
6+
.B wtype
7+
[TEXT]
8+
9+
.B wtype
10+
[OPTION_OR_TEXT]... -- [TEXT]...
11+
712
.SH DESCRIPTION
8-
wtype is a Wayland tool that allows you to simulate keyboard input like xdotool for X11.
13+
.PP
14+
wtype is a Wayland tool that allows you to simulate keyboard input like xdotool type for X11.
15+
This is accomplished via the virtual-keyboard Wayland protocol.
916

1017
.SH OPTIONS
18+
Modifier can be one of "shift", "capslock", "ctrl", "logo", "win", "alt", "altgr".
19+
Beware that the modifiers get released automatically once the program terminates.
20+
21+
Named keys are resolved by libxkbcommon, valid identifiers include "Left" and
22+
"Home".
23+
24+
.TP
25+
.BR \-M\ \fIMOD\fR
26+
Press modifier MOD.
27+
28+
.TP
29+
.BR \-m\ \fIMOD\fR
30+
Release modifier MOD.
1131

12-
.BR \-M
13-
Press modifier.
32+
.TP
33+
.BR \-P\ \fIKEY\fR
34+
Press key KEY.
1435

15-
.BR \-m
16-
Release modifier.
36+
.TP
37+
.BR \-p\ \fIKEY\fR
38+
Release key KEY.
1739

18-
.BR \-P
19-
Press named key.
40+
.TP
41+
.BR \-k\ \fIKEY\fR
42+
Type (press and release) key KEY.
2043

21-
.BR \-p
22-
Release named key.
44+
.TP
45+
.BR \-s\ \fITIME\fR
46+
Sleep for TIME milliseconds before interpreting the following options. This
47+
can be used to perform more complicated modifier sequences.
2348

2449
.SH LIMITATIONS
2550
To support arbitrary unicode characters, wtype generates a keymap on the fly and submits it to the compositor for distribution. Unfortunately this is broken under Xwayland as X has an upper limit on the amount of defined keycode-keysym pairs.

0 commit comments

Comments
 (0)