aboutsummaryrefslogtreecommitdiffstats
path: root/doc/dome-key.1.txt
diff options
context:
space:
mode:
authorTeddy Wing2018-11-02 21:14:37 +0100
committerTeddy Wing2018-11-02 21:14:37 +0100
commit9075ddcdf74dd8de070a99cf801c851e383050c4 (patch)
tree71192f6590db60d1c508d8d0b0a984979c54d255 /doc/dome-key.1.txt
parent8d47ac87e38bbdba3d5b6f1c5422a6c7756797f6 (diff)
downloadDomeKey-9075ddcdf74dd8de070a99cf801c851e383050c4.tar.bz2
Add the beginning of a man page
Copy-pasted options from the `--help` output and reordered them alphabtically. Includes a few stub sections that I think are needed.
Diffstat (limited to 'doc/dome-key.1.txt')
-rw-r--r--doc/dome-key.1.txt42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/dome-key.1.txt b/doc/dome-key.1.txt
new file mode 100644
index 0000000..47257b8
--- /dev/null
+++ b/doc/dome-key.1.txt
@@ -0,0 +1,42 @@
+dome-key(1)
+===========
+
+NAME
+----
+dome-key - Custom mappings for headphone buttons
+
+SYNOPSIS
+--------
+*dome-key* ['OPTIONS']
+
+DESCRIPTION
+-----------
+
+
+OPTIONS
+-------
+--audio::
+ play interface audio
+-d, --daemon::
+ run the daemon in the current shell
+-h, --help::
+ print this help menu
+--license 'file'::
+ register the software using a license plist file
+-r, --reload-mappings::
+ reload the mappings file
+-v, --version::
+ print the program version
+
+CONFIGURATION
+-------------
+
+MAPPINGS
+--------
+
+LAUNCHD
+-------
+
+COPYRIGHT
+---------
+[TODO: mention AquaticPrime as per license]