From 64f61254a63d19ec74e0bde96ba9e1faa4d3d151 Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Sat, 3 Nov 2018 19:21:02 +0100
Subject: doc/dome-key.1.txt: Add a rough description

* Make "OPTIONS" in the Synopsis section lowercase to match other man
  pages
* Add a description of the program. Still not happy with it yet, but
  it's a start.
* Add a "See Also" section that refers to an uncreated man page that
  should describe the syntax of the dkmap mappings file.
---
 doc/dome-key.1.txt | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

(limited to 'doc')

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]
-- 
cgit v1.2.3