« get me outta code hell

Add --filter to man page - http-music - Command-line music player + utils (not a server!)
about summary refs log tree commit diff
path: root/man
diff options
context:
space:
mode:
authorFlorrie <towerofnix@gmail.com>2017-09-28 22:06:16 -0300
committerFlorrie <towerofnix@gmail.com>2017-09-28 22:06:16 -0300
commitd16f7efae8f7b9a142ca9514bc98b41eb4ee16c8 (patch)
tree17e144082393498542e3ee03fe034dd670012983 /man
parent94c68dbdca1bb57086cd5921f87f47b8a30e21fa (diff)
Add --filter to man page
Diffstat (limited to 'man')
-rw-r--r--man/http-music-play.17
1 files changed, 7 insertions, 0 deletions
diff --git a/man/http-music-play.1 b/man/http-music-play.1
index 8d64bde..8aa8cae 100644
--- a/man/http-music-play.1
+++ b/man/http-music-play.1
@@ -107,6 +107,13 @@ By default, they are enabled.
 See also \fB\-\-disable\-converter\-options\fR.
 
 .TP
+.BR \-f ", " \-\-filter " \fIproperty\fR \fIvalue\fR"
+Filters the playlist so that only tracks with the given property-value pair are kept.
+If the property is an array, it checks if the given value is contained within that array.
+For example, this is useful for adding "tags" to songs.
+Try adding \fB"tag": ["cool"]\fR to a track in a playlist file, then use \fB\-\-filter tag cool\fR to only play that track (and other tracks whose \fB"tag"\fR property contains \fB"cool"\fR).
+
+.TP
 .BR \-h ", " \-? ", " \-\-help
 Presents a help message, directing the user to the \fBman\fR page.
 If this is the last option used, nothing plays (see \fB\-\-play\fR).