summaryrefslogtreecommitdiff
path: root/README.md
blob: 6685c2e9079cb15fc507a9583388ad692885208f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# xmouseless

This program is a replacement for the physical mouse in Linux.

Features:
- move the mouse with different speeds
- click and grab
- scroll
- execute shell commands


## Installation
```
make
sudo make install
```

If you are not using an Arch based distro you might have to install some headers, e.g. on
Debian based distros:
```
sudo apt-get install libx11-dev libxtst-dev
```

## Usage

When starting xmouseless, it grabs the keyboard and all defined bindings are
available. When pressing an exit key, the program exits.

The usage is quite intuitive and with some practice, you can move the pointer to
a specific location very fast. Basically, you move the pointer by pressing some
keys (the defaults are i, k, j and l for up, down, left and right)
and change the speed by pressing modifier keys.
The keys f, d and s (by default) are used to simulate mouse clicks and grabbing.
With some other keys, you can scroll up, down, left and right and execute 
previously defined shell commands.

You probably want to define a key binding to start xmouseless.


## Configuration

The configuration is done in config.h, which is a C header file,
but you don't need any programming knowledge to edit it.
After you edited the file, you have to run make again.