summaryrefslogtreecommitdiff
path: root/README.ans
blob: fbe214cae045f8d8214bc0e6d5cf0f1feed21311 (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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

                               ..
                              .$$S.             .,.
                              .S$$$$;     .,,,,,,,.
                                ;$$$$. .,,;;,,,,.
                                   ;S;,;;,,.
                                   .;;,;,
                                   ,s, s$;
                                   .,.;$$S
                                    .s$$$,
                                  .;S$$$;.
                                  s$s;. ,;.
                               .;S$$S   .,;,.
                              .s$S;.     .,;;.
.;sS$S;.                     ,$$s.         .;;.                  .,S$;.
.;sS$$$$$$$s,.              ,$$S.           .;;.            .;S$SSS$$;.
    .;S$$$$$$$$$Ss;.       ,$$$.             .;,        s$$$$$$$Ss;,.
          ,sS$$$$$$$$$Ss;,.,s;.               ,,  ,$$$$$$$$$$S;.
               .,;S$$$$$$$$$$$S,           .sSSSsS$$$$$$$;
                     .,;s$$$$$$$,          .S$$$SS$$,
                          .;;,sS,           .,ss,.,,,.
                     .,,,,s$$s.             ..,;..,,;;,,,,,.
           .,,,,,,,,,;;,,,;$$$,             .,;;.   .,,,,,;;,,,,,.
   .,,,,,,,;;,,,,,,,,,.    .s$$.           .,;;.          .,,,,,;;,,,,.
 .,;;,,,,,,,.               .$$$s         .;;,.                 .,,,,,.
 .,,.                        ,$$$$.      .;;.
                              .$$$$s    .;;.
                                S$$$.  .;;.
                                 ;$S,,,,,.
                                   .;;;,
                                 .,;;.S$s
                                .;;,. $$$
                                .;, .s$$;
                                 ..,$$$;
                                 ,s$$$;.
                               ,S$$$S.,;.
                              .S$$S,. .;;.
                              .;;,.    .,.


shibari is a program that reads inputs from various devices and
executes user-specified bindings.

It uses the evdev interface exposed by the Linux kernel, which means
it can handle keyboards as well as mouse and gamepad buttons and that
it can function indiferrently of being run in X11, Wayland or in a
headless setup.

shibari requires read access to files in /dev/input and
/sys/class/input.

Bindings are specified in a bindings file searched for at, in order of
preference:
 - the path given as argument to the "-c" option
 - $XDG_CONFIG_HOME/shibari/bindings.conf
 - $HOME/.config/shibari/bindings.conf

The bindings file expects one binding per line of the form:

"<code>[+<code>...] <press|release> <cmd>"

where <code> is the key code which can be seen by running shibari with
the "-t" option or a combination of such codes, <press|release>
specifies wether the binding should be run when the key/combination is
pressed or released and <cmd> is a command string that will be run by
/bin/sh when the binding is activated.

Empty lines and anything after a "#" is ignored.