|
 |
e8cf31b |
diff -ruN ydotool-0.2.0-orig/manpage/ydotool.1.scd ydotool-0.2.0/manpage/ydotool.1.scd
|
|
|
e8cf31b |
--- ydotool-0.2.0-orig/manpage/ydotool.1.scd 2021-01-09 19:31:54.000000000 +1000
|
|
|
e8cf31b |
+++ ydotool-0.2.0/manpage/ydotool.1.scd 2021-01-20 18:35:11.920031708 +1000
|
|
|
e8cf31b |
@@ -6,14 +6,16 @@
|
|
|
e8cf31b |
|
|
|
e8cf31b |
# SYNOPSIS
|
|
|
e8cf31b |
|
|
|
e8cf31b |
-*ydotool* *cmd* _args..._
|
|
|
e8cf31b |
+*ydotool* *cmd* _args_ [ , *cmd* _args_ ... ]
|
|
|
e8cf31b |
|
|
|
e8cf31b |
-*ydotool* *cmd* --help\fR
|
|
|
e8cf31b |
+*ydotool* *cmd* --help
|
|
|
e8cf31b |
|
|
|
e8cf31b |
# DESCRIPTION
|
|
|
e8cf31b |
|
|
|
e8cf31b |
*ydotool* lets you programmatically (or manually) simulate keyboard input and mouse activity, etc. It does this by writing directly to _/dev/uinput_ so it generally needs to run as root.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
+It's possible to chain multiple commands together, separated by a comma between two spaces.
|
|
|
e8cf31b |
+
|
|
|
e8cf31b |
Currently implemented command(s):
|
|
|
e8cf31b |
|
|
|
e8cf31b |
*type*
|
|
|
e8cf31b |
@@ -22,19 +24,15 @@
|
|
|
e8cf31b |
Press keys
|
|
|
e8cf31b |
*mousemove*
|
|
|
e8cf31b |
Move mouse pointer to absolute position
|
|
|
e8cf31b |
-*mousemove_relative*
|
|
|
e8cf31b |
- Move mouse pointer to relative position
|
|
|
e8cf31b |
*click*
|
|
|
e8cf31b |
Click on mouse buttons
|
|
|
e8cf31b |
*recorder*
|
|
|
e8cf31b |
Record/replay input events
|
|
|
e8cf31b |
-*mouseup*
|
|
|
e8cf31b |
- Send a mouse up event.
|
|
|
e8cf31b |
-*mousedown*
|
|
|
e8cf31b |
- Send a mouse down event.
|
|
|
e8cf31b |
+*sleep*
|
|
|
e8cf31b |
+ sleep for a while
|
|
|
e8cf31b |
|
|
|
e8cf31b |
# KEYBOARD COMMANDS
|
|
|
e8cf31b |
-*key* [*--up*] [*--down*] [*--delay* _<ms>_] [*--key-delay* _<ms>_] [*--repeat* _<times>_] [*--repeat-delay <ms>*] [*--persist-delay <ms>*] _<key sequence>_
|
|
|
e8cf31b |
+*key* [*--up*] [*--down*] [*--next-delay* _<ms>_] [*--key-delay* _<ms>_] [*--repeat* _<times>_] [*--repeat-delay <ms>*] _<key sequence>_
|
|
|
e8cf31b |
|
|
|
e8cf31b |
Type a given keystroke. Examples being "alt+r", "ctrl+J",
|
|
|
e8cf31b |
"ctrl+alt+n", "backspace".
|
|
|
e8cf31b |
@@ -59,12 +57,10 @@
|
|
|
e8cf31b |
*--repeat-delay* _<ms>_
|
|
|
e8cf31b |
Delay time between repetitions. Default 0ms.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
- *--persist-delay* _<ms>_
|
|
|
e8cf31b |
- Keep virtual device alive for _<ms>_ ms. Should be used in conjunction with *--down* or *--up*
|
|
|
e8cf31b |
-
|
|
|
e8cf31b |
Generally, any valid name from _/usr/include/linux/input-event-codes.h_ will work. Multiple keys are separated by '+'.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
Each key sequence can be any number of modifiers and keys, separated by plus (+)
|
|
|
e8cf31b |
+
|
|
|
e8cf31b |
For example: alt+r Alt+F4 CTRL+alt+f3 aLT+1+2+3 ctrl+Backspace
|
|
|
e8cf31b |
|
|
|
e8cf31b |
Since we are emulating keyboard input, combinations like Shift+# is invalid because typing a `#' involves pressing Shift and 3.
|
|
|
e8cf31b |
@@ -75,20 +71,20 @@
|
|
|
e8cf31b |
Example: Close a window in graphical environment:
|
|
|
e8cf31b |
ydotool key Alt+F4
|
|
|
e8cf31b |
|
|
|
e8cf31b |
-*type* [*--delay* _<ms>_] [*--key-delay* _<ms>_] [*--args* _<N>_] [*--file* _<filepath>_] "_something to type_"
|
|
|
e8cf31b |
+*type* [*--next-delay* _<ms>_] [*--key-delay* _<ms>_] [*--texts* _arg_] [*--file* _<filepath>_] "_texts_"
|
|
|
e8cf31b |
|
|
|
e8cf31b |
Types text as if you had typed it on the keyboard.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
Options:
|
|
|
e8cf31b |
|
|
|
e8cf31b |
- *--delay* _<ms>_
|
|
|
e8cf31b |
+ *--next-delay* _<ms>_
|
|
|
e8cf31b |
Delay before starting typing. Default 100ms.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
*--key-delay* _<ms>_
|
|
|
e8cf31b |
Delay time between keystrokes. Default 12ms.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
- *--args* _<N>_
|
|
|
e8cf31b |
- ????
|
|
|
e8cf31b |
+ *--texts* _arg_
|
|
|
e8cf31b |
+ Texts to type
|
|
|
e8cf31b |
|
|
|
e8cf31b |
*--file* _<filepath>_
|
|
|
e8cf31b |
Specify a file, the contents of which will be typed as if passed as an argument. The filepath may also be '-' to read from stdin.
|
|
|
e8cf31b |
@@ -98,43 +94,39 @@
|
|
|
e8cf31b |
|
|
|
e8cf31b |
# MOUSE COMMANDS
|
|
|
e8cf31b |
|
|
|
e8cf31b |
-*mousemove* [*--delay* _<ms>_] _<x> <y>_
|
|
|
e8cf31b |
- Move the mouse to the specific X and Y coordinates on the screen.
|
|
|
e8cf31b |
+*mousemove* _<x> <y>_
|
|
|
e8cf31b |
+ Move the mouse to the specific relative X and Y coordinates on the screen.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
Options:
|
|
|
e8cf31b |
- *--delay* _<ms>_
|
|
|
e8cf31b |
- Delay before starting move. Default 100ms.
|
|
|
e8cf31b |
+ *--absolute*
|
|
|
e8cf31b |
+ Use absolute position
|
|
|
e8cf31b |
|
|
|
e8cf31b |
Example: to move the cursor to absolute coordinates (100,100):
|
|
|
e8cf31b |
- ydotool mousemove 100 100
|
|
|
e8cf31b |
+ ydotool mousemove --absolute 100 100
|
|
|
e8cf31b |
|
|
|
e8cf31b |
-*mousemove_relative* [*--delay* _<ms>_] _<x>_ _<y>_
|
|
|
e8cf31b |
- Move the mouse x,y pixels relative to the current position of the mouse cursor.
|
|
|
e8cf31b |
+*click* [*--next-delay* _<ms>_] _button_
|
|
|
e8cf31b |
+ Send a click. Buttons are: _left_, _right_ or _middle_
|
|
|
e8cf31b |
|
|
|
e8cf31b |
Options:
|
|
|
e8cf31b |
- *--delay* _<ms>_
|
|
|
e8cf31b |
- Delay before starting move. Default 100ms.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
- Example: Relatively move mouse pointer to -100,100:
|
|
|
e8cf31b |
- ydotool mousemove_relative -- -100 100
|
|
|
e8cf31b |
+ *--next-delay* _<ms>_
|
|
|
e8cf31b |
+ Delay before click. Default 100ms.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
-*click* [*--delay* _<ms>_] _button_
|
|
|
e8cf31b |
- Send a click. Buttons are: 1=left 2=right 3=middle
|
|
|
e8cf31b |
+ *--up*
|
|
|
e8cf31b |
+ Only mouseup
|
|
|
e8cf31b |
|
|
|
e8cf31b |
- Options:
|
|
|
e8cf31b |
-
|
|
|
e8cf31b |
- *--delay* _<ms>_
|
|
|
e8cf31b |
- Delay before click. Default 100ms.
|
|
|
e8cf31b |
+ *--down*
|
|
|
e8cf31b |
+ Only mousedown
|
|
|
e8cf31b |
|
|
|
e8cf31b |
- Example: Mouse right click:
|
|
|
e8cf31b |
- ydotool click 2
|
|
|
e8cf31b |
+ *--buttons* _<arg>_
|
|
|
e8cf31b |
+ Buttons to press (left, right, middle)
|
|
|
e8cf31b |
|
|
|
e8cf31b |
-*recorder* [*--delay* _<ms>_] [*--record* _<devices>_] [*--replay* _<input files>_] [*--display*] [*--duration* _<ms>_]
|
|
|
e8cf31b |
+ Example: Mouse middle click:
|
|
|
e8cf31b |
+ ydotool click middle
|
|
|
e8cf31b |
|
|
|
e8cf31b |
- Options:
|
|
|
e8cf31b |
+*recorder* [*--record* _<devices>_] [*--replay* _<input files>_] [*--display*] [*--duration* _<ms>_] [*--devices* _<path>_] [*--file* _<path>_]
|
|
|
e8cf31b |
|
|
|
e8cf31b |
- *--delay* _<ms>_
|
|
|
e8cf31b |
- Delay time before start recording/replaying. Default 5000ms.
|
|
|
e8cf31b |
+ Options:
|
|
|
e8cf31b |
|
|
|
e8cf31b |
*--record* _<devices>_
|
|
|
e8cf31b |
Devices to record from. Default is all, including non-keyboard devices.
|
|
|
e8cf31b |
@@ -143,32 +135,16 @@
|
|
|
e8cf31b |
The record file can't be replayed on an architecture with different endianness.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
*--display*
|
|
|
e8cf31b |
- ????
|
|
|
e8cf31b |
+ Display
|
|
|
e8cf31b |
|
|
|
e8cf31b |
*--duration* _<ms>_
|
|
|
e8cf31b |
Record duration. Otherwise use SIGINT to stop recording.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
-*mouseup* [*--delay* _<ms>_] _button_
|
|
|
e8cf31b |
- Send a mouse up event. Buttons are: 1=left 2=right 3=middle
|
|
|
e8cf31b |
-
|
|
|
e8cf31b |
- Options:
|
|
|
e8cf31b |
-
|
|
|
e8cf31b |
- *--delay* _<ms>_
|
|
|
e8cf31b |
- Delay before click. Default 100ms.
|
|
|
e8cf31b |
-
|
|
|
e8cf31b |
- Example: Mouse right click:
|
|
|
e8cf31b |
- ydotool click 2
|
|
|
e8cf31b |
-
|
|
|
e8cf31b |
-*mousedown* [*--delay* _<ms>_] _button_
|
|
|
e8cf31b |
- Send a mouse down event. Buttons are: 1=left 2=right 3=middle
|
|
|
e8cf31b |
-
|
|
|
e8cf31b |
- Options:
|
|
|
e8cf31b |
-
|
|
|
e8cf31b |
- *--delay* _<ms>_
|
|
|
e8cf31b |
- Delay before click. Default 100ms.
|
|
|
e8cf31b |
+ *--devices* _<path>_
|
|
|
e8cf31b |
+ Devices, separated by comma, to record from. Default is all devices (default: "")
|
|
|
e8cf31b |
|
|
|
e8cf31b |
- Example: Mouse right click:
|
|
|
e8cf31b |
- ydotool click 2
|
|
|
e8cf31b |
+ *--file* _<path>_
|
|
|
e8cf31b |
+ File to record to / replay from
|
|
|
e8cf31b |
|
|
|
e8cf31b |
# AUTHOR
|
|
|
e8cf31b |
|
|
|
e8cf31b |
@@ -184,8 +160,8 @@
|
|
|
e8cf31b |
|
|
|
e8cf31b |
In order to solve this problem, there is a persistent background service, *ydotoold*(1), to hold a persistent virtual device, and accept input from *ydotool*(1). When *ydotoold*(1) is unavailable, *ydotool*(1) will work without it.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
-# COPYRIGHT
|
|
|
e8cf31b |
-MIT License
|
|
|
e8cf31b |
+# LICENCE
|
|
|
e8cf31b |
+AGPLv3
|
|
|
e8cf31b |
|
|
|
e8cf31b |
# SEE ALSO
|
|
|
e8cf31b |
|
|
|
e8cf31b |
diff -ruN ydotool-0.2.0-orig/manpage/ydotoold.8.scd ydotool-0.2.0/manpage/ydotoold.8.scd
|
|
|
e8cf31b |
--- ydotool-0.2.0-orig/manpage/ydotoold.8.scd 2021-01-09 19:31:54.000000000 +1000
|
|
|
e8cf31b |
+++ ydotool-0.2.0/manpage/ydotoold.8.scd 2021-01-20 18:33:48.815128767 +1000
|
|
|
e8cf31b |
@@ -6,7 +6,7 @@
|
|
|
e8cf31b |
|
|
|
e8cf31b |
# SYNOPSIS
|
|
|
e8cf31b |
|
|
|
e8cf31b |
-*ydotoold*
|
|
|
e8cf31b |
+*ydotoold* _[OPTION...]_
|
|
|
e8cf31b |
|
|
|
e8cf31b |
# DESCRIPTION
|
|
|
e8cf31b |
|
|
|
e8cf31b |
@@ -20,15 +20,23 @@
|
|
|
e8cf31b |
|
|
|
e8cf31b |
In order to solve this problem, the *ydotoold* background service holds a persistent virtual device, and accepts input from *ydotool*(1). When *ydotoold*(1) is unavailable, *ydotool*(1) will work without it.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
+# OPTIONS
|
|
|
e8cf31b |
+
|
|
|
e8cf31b |
+ *--socket-path arg* _<path>_
|
|
|
e8cf31b |
+ Socket path (default: /tmp/.ydotool_socket)
|
|
|
e8cf31b |
+
|
|
|
e8cf31b |
+ *--socket-perm arg* _<perms>_
|
|
|
e8cf31b |
+ Socket permission (default: 0600)
|
|
|
e8cf31b |
+
|
|
|
e8cf31b |
# AUTHOR
|
|
|
e8cf31b |
|
|
|
e8cf31b |
*ydotool*(1) and *ydotoold*(8) were written by ReimuNotMoe.
|
|
|
e8cf31b |
|
|
|
e8cf31b |
This man page by bob.hepple@gmail.com
|
|
|
e8cf31b |
|
|
|
e8cf31b |
-# COPYRIGHT
|
|
|
e8cf31b |
+# LICENCE
|
|
|
e8cf31b |
|
|
|
e8cf31b |
-MIT License
|
|
|
e8cf31b |
+AGPLv3
|
|
|
e8cf31b |
|
|
|
e8cf31b |
# SEE ALSO
|
|
|
e8cf31b |
|