diff options
| author | Teddy Wing | 2018-11-02 21:14:37 +0100 |
|---|---|---|
| committer | Teddy Wing | 2018-11-02 21:14:37 +0100 |
| commit | 9075ddcdf74dd8de070a99cf801c851e383050c4 (patch) | |
| tree | 71192f6590db60d1c508d8d0b0a984979c54d255 | |
| parent | 8d47ac87e38bbdba3d5b6f1c5422a6c7756797f6 (diff) | |
| download | DomeKey-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.
| -rw-r--r-- | Makefile | 6 | ||||
| -rw-r--r-- | doc/dome-key.1.txt | 42 |
2 files changed, 48 insertions, 0 deletions
@@ -37,3 +37,9 @@ DomeKey/sound_data.h: sounds/*.mp3 $(foreach f,$^,xxd -include $(f) >> $@;) echo >> $@ echo '#endif /* SOUND_DATA_H */' >> $@ + +doc/dome-key.1: doc/dome-key.1.txt + a2x --no-xmllint --format manpage $< + +.PHONY: doc +doc: doc/dome-key.1 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] |