aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2018-11-14 16:58:41 +0100
committerTeddy Wing2018-11-14 16:58:41 +0100
commitbab4279a04e57c5c7143e2b059e70ebd75fde17c (patch)
tree0563a00d59a00ff8f5dc64de8fdb8f314fde4f32
parent856a162d6458d8883fef0bb4d251fcb6049d9b74 (diff)
downloadDomeKey-bab4279a04e57c5c7143e2b059e70ebd75fde17c.tar.bz2
doc/dome-key.1.txt: Add real descriptions of command line options
-rw-r--r--doc/dome-key.1.txt23
1 files changed, 17 insertions, 6 deletions
diff --git a/doc/dome-key.1.txt b/doc/dome-key.1.txt
index 0c87465..a7a2be7 100644
--- a/doc/dome-key.1.txt
+++ b/doc/dome-key.1.txt
@@ -22,17 +22,28 @@ dome-key-mappings(7) for more information.
OPTIONS
-------
--audio::
- play interface 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
+ Run the daemon in the current shell to listen for headphone button
+ events. The program will run in the foreground.
+
-h, --help::
- print this help menu
+ Print usage help.
+
--license 'file'::
- register the software using a license plist file
+ Register the software using the license plist file at path 'file'.
+
-r, --reload-mappings::
- reload the mappings file
+ 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
+ Print the program version.
CONFIGURATION
-------------