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
--------
Mappings are defined in '~/.config/dome-key/mappings.dkmap'. See
dome-key-mappings(7) for a complete explanation of the syntax.

If a button is not mapped, it retains its normal function. The following
mappings apply when undefined, even without a mappings file:

	map <Up> <VolumeUp>
	map <Play> <Play>
	map <Down> <VolumeDown>

LAUNCHD
-------
It’s recommended that you run the program in the background using
launchd(8). Here’s an example plist:

${PLIST}

You can also use *brew services* to do this automatically if the program
was installed with Homebrew.

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

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