aboutsummaryrefslogtreecommitdiffstats
path: root/doc/dome-key.1.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/dome-key.1.txt')
-rw-r--r--doc/dome-key.1.txt12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/dome-key.1.txt b/doc/dome-key.1.txt
index 47257b8..e7bfbaf 100644
--- a/doc/dome-key.1.txt
+++ b/doc/dome-key.1.txt
@@ -7,11 +7,17 @@ dome-key - Custom mappings for headphone buttons
SYNOPSIS
--------
-*dome-key* ['OPTIONS']
+*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
-------
@@ -37,6 +43,10 @@ MAPPINGS
LAUNCHD
-------
+SEE ALSO
+--------
+dome-key-mappings(7).
+
COPYRIGHT
---------
[TODO: mention AquaticPrime as per license]