aboutsummaryrefslogtreecommitdiffstats
path: root/doc/dome-key.1.txt
blob: 0c874659d0098609111a4f4828b3edccc0614e55 (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
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
-d, --daemon::
	run the daemon in the current shell
-h, --help::
	print this help menu
--license 'file'::
	register the software using a license plist file
-r, --reload-mappings::
	reload the mappings file
-v, --version::
	print the program version

CONFIGURATION
-------------

MAPPINGS
--------

LAUNCHD
-------

SEE ALSO
--------
dome-key-mappings(7).

COPYRIGHT
---------
[TODO: mention AquaticPrime as per license]