dotool/README.md

59 lines
1.4 KiB
Markdown
Raw Normal View History

2022-10-20 15:21:20 +02:00
# dotool
dotool reads commands from stdin and simulates keyboard and mouse events.
It works everywhere on Linux, including in X11, Wayland and TTYs.
It takes about half a second to register the virtual device, but it can be
kept using the daemon.
2022-10-20 15:21:20 +02:00
2022-10-24 11:29:35 +02:00
## Install From Source
2022-10-20 15:21:20 +02:00
2023-01-07 00:03:48 +01:00
With go (>=1.19) run:
sudo ./install.sh
2022-10-20 15:21:20 +02:00
## Usage
2022-10-24 11:29:35 +02:00
dotool will require root permissions unless you are in group input.
2023-01-07 00:03:48 +01:00
See:
dotool --help
2022-10-20 15:21:20 +02:00
This greets the world:
2023-01-07 00:03:48 +01:00
echo 'type Sup, Lads!' | dotool
2022-10-20 15:21:20 +02:00
This screams for three seconds:
2023-01-07 00:03:48 +01:00
{ echo keydown A; sleep 3; echo key H shift+1; } | dotool
2022-10-20 15:21:20 +02:00
This drags the mouse:
2023-01-07 00:03:48 +01:00
printf %s\\n 'buttondown left' 'mousemove 0 100' 'buttonup left' | dotool
2022-10-20 15:21:20 +02:00
The daemon and client, `dotoold` and `dotoolc`, can used to keep a persistent
virtual device for a quicker initial response:
2023-01-07 00:03:48 +01:00
dotoold &
echo 'type super' | dotoolc
echo 'type speedy' | dotoolc
2022-10-20 15:21:20 +02:00
2023-01-06 23:58:41 +01:00
## Numen, Chat and Contact
2022-10-20 15:21:20 +02:00
2023-01-06 23:58:41 +01:00
dotool was written for [Numen Voice Control](https://numenvoice.com)
and you're very welcome to join the Matrix chat at
[#numen:matrix.org](https://matrix.to/#/#numen:matrix.org).
You can also send questions, thoughts or patches by composing an email to
[~geb/public-inbox@lists.sr.ht](https://lists.sr.ht/~geb/public-inbox).
## Support Me
[Thank you!](https://liberapay.com/geb)
2022-11-19 11:08:08 +01:00
## License
GPLv3 only, see [LICENSE](./LICENSE).
2023-01-09 14:28:39 +01:00
Copyright (c) 2022-2023 John Gebbie