README: mention also pkg-config as a build dependency
[xicursorset.git] / README
1 xicursorset is a tool to set the cursor image for an XInput2 pointer.
2
3 The first argument to pass is a pointer id, you can get it by running
4 'xinput list' and analyzing its output.
5
6 You need to specify an image name supplied by the theme you are using, and you
7 can optionally pass a cursor theme name to pick up the image from it.
8
9 Examples of use:
10
11 Get the possible pointer ids with xinput:
12 $ xinput list | grep "master pointer"
13 ⎡ Virtual core pointer                          id=2    [master pointer  (3)]
14 ⎡ Extra pointer                                 id=13   [master pointer  (14)]
15
16 Set the cursor with id=13 to the 'left_ptr' image from the 'redglass' theme
17 $ ./xicursorset 13 left_ptr redglass
18
19 Set the cursor with id=2 to the 'right_ptr' image from the 'whiteglass' theme
20 $ ./xicursorset 2 right_ptr whiteglass
21
22 Set the cursor with id=2 to the 'left_ptr' image from the default theme
23 $ ./xicursorset 2 left_ptr
24
25
26 NOTE: the "redglass" and "whiteglass" cursor themes are sometimes provided in
27 a separate package called "xcursor-themes".
28
29 Dependencies:
30   - pkg-config
31   - libxcursor-dev
32   - libxi-dev