From 69df701e72f06819384a1d7328a522f4a5705fba Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Wed, 14 Nov 2018 17:28:22 +0100
Subject: doc/dome-key.1.txt: Add "Configuration" section

Describe the `timeout` configuration option.
---
 doc/dome-key.1.txt | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'doc')

diff --git a/doc/dome-key.1.txt b/doc/dome-key.1.txt
index a7a2be7..41e3220 100644
--- a/doc/dome-key.1.txt
+++ b/doc/dome-key.1.txt
@@ -47,6 +47,22 @@ OPTIONS
 
 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
 --------
-- 
cgit v1.2.3