aboutsummaryrefslogtreecommitdiffstats
path: root/doc/user.xml
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2015-01-10 08:58:31 +0100
committerMax Kellermann <max@duempel.org>2015-01-14 22:03:26 +0100
commite8debd2e454f9a7399104b5c77e44d5dce6aa203 (patch)
treeed143b771fabe096e3bbcd4521ada68f77f6a73b /doc/user.xml
parent1caa41a623ccadb2f019f901f98c07e01ea0c9e2 (diff)
downloadmpd-e8debd2e454f9a7399104b5c77e44d5dce6aa203.tar.gz
mpd-e8debd2e454f9a7399104b5c77e44d5dce6aa203.tar.xz
mpd-e8debd2e454f9a7399104b5c77e44d5dce6aa203.zip
output/recorder: dynamic file name
Diffstat (limited to '')
-rw-r--r--doc/user.xml44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/user.xml b/doc/user.xml
index e5b89e27d..74c169c11 100644
--- a/doc/user.xml
+++ b/doc/user.xml
@@ -3091,6 +3091,50 @@ buffer_size: 16384</programlisting>
Write to this file.
</entry>
</row>
+
+ <row>
+ <entry>
+ <varname>format_path</varname>
+ <parameter>P</parameter>
+ </entry>
+ <entry>
+ <para>
+ An alternative to <varname>path</varname> which
+ provides a format string referring to tag values.
+ Every time a new song starts or a new tag gets
+ received from a radio station, a new file is
+ opened. If the format does not render a file
+ name, nothing is recorded.
+ </para>
+
+ <para>
+ A tag name enclosed in percent signs ('%') is
+ replaced with the tag value. Example:
+ <parameter>~/.mpd/recorder/%artist% -
+ %title%.ogg</parameter>
+ </para>
+
+ <para>
+ Square brackets can be used to group a substring.
+ If none of the tags referred in the group can be
+ found, the whole group is omitted. Example:
+ <parameter>[~/.mpd/recorder/[%artist% -
+ ]%title%.ogg]</parameter> (this omits the dash
+ when no artist tag exists; if title also doesn't
+ exist, no file is written)
+ </para>
+
+ <para>
+ The operators "|" (logical "or") and "&amp;"
+ (logical "and") can be used to select portions of
+ the format string depending on the existing tag
+ values. Example:
+ <parameter>~/.mpd/recorder/[%title|%name%].ogg</parameter>
+ (use the "name" tag if no title exists)
+ </para>
+ </entry>
+ </row>
+
<row>
<entry>
<varname>encoder</varname>