blob: 41e3220478d141fb824a35f1fbe8c6095f758bd9 (
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
69
70
71
72
73
74
75
76
77
78
79
|
dome-key(1)
===========
NAME
----
dome-key - Custom mappings for headphone buttons
SYNOPSIS
--------
*dome-key* ['options']
DESCRIPTION
-----------
Enables customisation of headphone buttons. The *dome-key* program runs
in the background listening to button events, executing user-defined
actions in response to these events.
Headphone button mappings are defined in a file called
'~/.config/dome-key/mappings.dkmap'. See 'MAPPINGS' or
dome-key-mappings(7) for more information.
OPTIONS
-------
--audio::
Play interface audio. Sounds will play to provide feedback when a mode
is activated or deactivated.
-d, --daemon::
Run the daemon in the current shell to listen for headphone button
events. The program will run in the foreground.
-h, --help::
Print usage help.
--license 'file'::
Register the software using the license plist file at path 'file'.
-r, --reload-mappings::
Reload the mappings file. If an instance of *dome-key* is running, no
updates to the mappings file are taken into account automatically.
Executing the program with this flag will cause the running daemon to
reload the mappings file into its memory. This is typically easier
than killing and relaunching the daemon.
-v, --version::
Print the program version.
CONFIGURATION
-------------
An optional configuration file can be added at
'~/.config/dome-key/config.toml'.
Presently, only one configuration option is available. Here’s an example
config:
timeout = 400
timeout::
Sets the speed of multi-button mappings. To run an action mapped to
'<Play><Down>', you first press the ‘play’ button, then the ‘down’
button on your headphones. The time allowed between each button press
is defined by this option. By default, it’s set to 500 milliseconds.
It can be changed to any positive integer amount of milliseconds.
Setting it to '0' will prevent multi-button mappings and cause button
actions to be executed immediately.
MAPPINGS
--------
LAUNCHD
-------
SEE ALSO
--------
dome-key-mappings(7).
COPYRIGHT
---------
[TODO: mention AquaticPrime as per license]
|
