Skip to content
Browse files

updated readme

  • Loading branch information...
1 parent cbde34f commit 420e275d55bffcaffa1a322fb780947816b5c382 @trapd00r committed Oct 31, 2010
Showing with 29 additions and 9 deletions.
  1. +29 −9 README.md
View
38 README.md
@@ -14,6 +14,20 @@ pimpd is an MPD client written in Perl that aims to implement what the
excellent mpc client is lacking (for good reasons), as well as all the
regular functionality one would expect.
+### Local playback
+
+ If defined in the configuration file, an external player can be used for
+ playback of music running on another box (the MPD server). This is fully
+ transparent; when MPD is stopped, so is the external player.
+
+ When the --play flag is given, pimpd will connect to MPD and start playback
+ if neccessary, and at the same time connect to the stream with the specified
+ external player.
+
+ Issues with unreliable network connections/slow disks causing the external
+ player to exit is eliminated, as well as scenarios where the MPD playlist
+ might be temporary empty (no playback - external player exits).
+
### Regular expression based queries
You can search the database and playlist using regular expressions. There are
@@ -26,18 +40,17 @@ regular functionality one would expect.
### Randomizing
- -r will create a new playlist with <num> randomly selected tracks from the
- database added.
+ -r will create a new playlist with <num> randomly selected tracks from the
+ database added.
- -rt will play a random track from the current playlist.
+ -rt will play a random track from the current playlist.
### Favorites
Favorites are handled in several ways. When the -f flag is used, pimpd will
check for the genre tag of the song and, if existing, save it in the playlist
directory with a year-month_genre-notation.
-
- If there's no genre tag, the $fallback_playlist variable, specified in the
+ If there's no genre tag, the $fallback_playlist, specified in the
configuration file, is used.
pimpd will also keep a CSV-style database updated with more additional data on
@@ -86,11 +99,13 @@ regular functionality one would expect.
### Now playing
- There are two options that will yeild some info on the current track:
+ There are three options that will yeild some info on the current track:
+
+ -i print all information available.
- -i print all information available.
+ -np print information on the currently playing track only, on a single line.
- -np print information on the currently playing track only, on a single line.
+ -nprt print information on the currently playing track in realtime mode.
### Colors
@@ -103,6 +118,7 @@ regular functionality one would expect.
-i, --info show all info for the currently playing song
-np, --current print basic song info on a single line
+ --np-rt print updating song info on a single line
-r, --random randomize a new playlist with <num> tracks
-rt, --random-track play a random track from the playlist
-cp, --copy copy the current track to specified location
@@ -113,7 +129,7 @@ regular functionality one would expect.
-l, --listalbums list all albums featuring artist
-lsa, --listsongs list all songs on the current album
-lsp, --list-pl list all available playlists
- -p, --playlist show the current playlist
+ -pls --playlist show the current playlist
-t, --track play track <num> from playlist
-a, --add add playlist <str>. If <str> eq "all", add all
-aa, --add-album add the current album to the playlist
@@ -129,6 +145,10 @@ regular functionality one would expect.
-sal, --search-album search the database for [<album>]
-set, --search-title search the database for [<title>]
-sap, --favsearch search the favlists for artist, album, title, file
+ -c, --clear clear the playlist before performing any action that
+ generates a new playlist
+ --play start remote/local playback
+ --stop stop remote/local playback
-no, --no-color turn colors off
--mpd-kill shut down the MPD server
--host remote MPD host

0 comments on commit 420e275

Please sign in to comment.
Something went wrong with that request. Please try again.