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