From 3aff781a610e69a4e49d5db386b9885f1f167451 Mon Sep 17 00:00:00 2001
From: Lars-Dominik Braun <lars@6xq.net>
Date: Mon, 16 May 2011 13:25:08 +0200
Subject: Update documentation

Describe new config keys, add an example to contrib config file
---
 contrib/config-example |  4 ++++
 contrib/pianobar.1     | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 57 insertions(+)

(limited to 'contrib')

diff --git a/contrib/config-example b/contrib/config-example
index f96440b..0a52dd6 100644
--- a/contrib/config-example
+++ b/contrib/config-example
@@ -41,3 +41,7 @@
 #love_icon = [+]
 #ban_icon = [-]
 #volume = 0
+
+# Format strings
+#format_nowplaying_song = %t by %a on %l%r%@%s
+#format_nowplaying_station = Station %n
diff --git a/contrib/pianobar.1 b/contrib/pianobar.1
index 4d63dcd..8df569e 100644
--- a/contrib/pianobar.1
+++ b/contrib/pianobar.1
@@ -171,6 +171,59 @@ will use this proxy. The music is streamed directly.
 File that is executed when event occurs. See section
 .B EVENTCMD
 
+.TP
+.B format_nowplaying_song = \[dq]%t\[dq] by \[dq]%a\[dq] on \[dq]%l\[dq]%r%@%s
+Now playing song message format. Available format characters are:
+
+.B %t
+Song title
+
+.B %a
+Song artist
+
+.B %l
+Album name
+
+.B %r
+Rating icon (only love icon)
+
+.B %@
+@-sign if station is quickmix
+
+.B %s
+Real station name if quickmix
+
+.B %u
+Song detail url
+
+.TP
+.B format_nowplaying_station = Station \[dq]%n\[dq] (%i)
+Now playing station format. Available format characters are:
+
+.B %n
+Station name
+
+.B %i
+Station id
+
+.TP
+.B format_msg_none = %s
+.TQ
+.B format_msg_info = (i) %s
+.TQ
+.B format_msg_nowplaying = |>  %s
+.TQ
+.B format_msg_time = #   %s
+.TQ
+.B format_msg_err = /!\\\\ %s
+.TQ
+.B format_msg_question = [?] %s
+.TQ
+.B format_msg_list = \\t%s
+Message format strings.
+.B %s
+is replaced with the actual message.
+
 .TP
 .B history = 5
 Keep a history of the last n songs (5, by default). You can rate these songs.
-- 
cgit v1.2.3