diff options
author | Christian Hesse <mail@eworm.de> | 2014-08-28 15:48:16 +0200 |
---|---|---|
committer | Christian Hesse <mail@eworm.de> | 2014-08-28 15:48:16 +0200 |
commit | 0c57be224ee83f8b6f0f2a9b991c272dd618d0b6 (patch) | |
tree | b61bea18c3d25435826c4b29e6c73b82cd620f5b | |
parent | e7e4b628bf7c39213f0a14b4fe36a54265f4c70d (diff) | |
download | mpd-notification-0c57be224ee83f8b6f0f2a9b991c272dd618d0b6.tar.gz mpd-notification-0c57be224ee83f8b6f0f2a9b991c272dd618d0b6.tar.zst |
add some more documentation
-rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
@@ -52,3 +52,21 @@ Usage Just run `mpd-notification` after installation or re-login to desktop environment for autostart. + +`mpd-notification` accepts some arguments: + +* *-h*: show help +* *-H HOST*: connect to HOST +* *-m MUSIC-DIR*: use MUSIC-DIR for artwork lookup +* *-p PORT*: connect to PORT +* *-v*: verbose output + +Artwork +------- + +`mpd` does not provide any information where it finds its music files. To make +`mpd-notification` display album artwork you need to tell it where to look for +artwork. You can do that by exporting `XDG_MUSIC_DIR` to your environment or by +specifying `-m` or `--music-dir` on the command line. The image file containing +the artwork needs to be place in the same directory as the media file and named +`cover.jpg`, `cover.png`, `folder.jpg` or `folder.png`. |