diff options
author | Přemysl Eric Janouch <p@janouch.name> | 2020-10-26 13:24:46 +0100 |
---|---|---|
committer | Přemysl Eric Janouch <p@janouch.name> | 2020-10-26 14:53:55 +0100 |
commit | 5cb95590b00c7190eaeb5a66b9dab4c6d45c945a (patch) | |
tree | fd0969956348c669823440908a27c44b657991d5 /nncmpp.adoc | |
parent | 4c8c0f831b2b689140236a9f56a9cde385680337 (diff) | |
download | nncmpp-5cb95590b00c7190eaeb5a66b9dab4c6d45c945a.tar.gz nncmpp-5cb95590b00c7190eaeb5a66b9dab4c6d45c945a.tar.xz nncmpp-5cb95590b00c7190eaeb5a66b9dab4c6d45c945a.zip |
WIP: Add a real manual page
WIP: need to actually write it
WIP: some content may be eligible to be moved from the README
Closes #3
Diffstat (limited to 'nncmpp.adoc')
-rw-r--r-- | nncmpp.adoc | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/nncmpp.adoc b/nncmpp.adoc new file mode 100644 index 0000000..0514bc6 --- /dev/null +++ b/nncmpp.adoc @@ -0,0 +1,39 @@ +nncmpp(1) +========= +:doctype: manpage +:manmanual: nncmpp Manual +:mansource: nncmpp {release-version} + +Name +---- +nncmpp - an MPD client + +Synopsis +-------- +*nncmpp* [_OPTION_]... + +Options +------- +*-d*, *--debug*:: + Adds a "Debug" tab showing all MPD communication and other information + that help debug various issues. + +*-h*, *--help*:: + Display a help message and exit. + +*-V*, *--version*:: + Output version information and exit. + +Files +----- +_~/.config/nncmpp/nncmpp.conf_:: + The configuration file. + +// TODO: I'll have to describe the contents. It seems like liberty should +// contain an includable snippet about the format. At least it'd be good +// to include an example file, such as the one in the README. + +Reporting bugs +-------------- +Use https://git.janouch.name/p/nncmpp to report bugs, request features, +or submit pull requests. |