Remove default.jpg.

[paraslash.git] / README.afs

diff --git a/README.afs b/README.afs
index 9e588a6a6c7a888168bf61af239823e81c98f560..46e30c4542f3ba619e8b5109ac3ddab98214623b 100644 (file)
--- a/README.afs
+++ b/README.afs
@@ -78,10 +78,10 @@ A mood consists of a unique name and its *mood definition*, which is
 a set of *mood lines* containing expressions in terms of attributes
 and other data contained in the database.
 
 a set of *mood lines* containing expressions in terms of attributes
 and other data contained in the database.
 

-A mood defines a subset of audio files called the *admissible audio
-files* for that mood. At any time, at most one mood can be *active*
-which means that para_server is going to select only files from that
-subset of admissible files.
+A mood defines a subset of audio files called the *admissible audio files*
+for that mood. At any time, at most one mood can be *active* which
+means that para_server is going to select only files from that subset
+of admissible files.

 
 So in order to create a mood definition one has to write a set of
 mood lines. Mood lines come in three flavours: Accept lines, deny
 
 So in order to create a mood definition one has to write a set of
 mood lines. Mood lines come in three flavours: Accept lines, deny


@@ -156,20 +156,43 @@ List of mood_methods
 Takes no arguments and matches an audio file if and only if no
 attributes are set.
 
 Takes no arguments and matches an audio file if and only if no
 attributes are set.
 

-       played_rarely
-
-Takes no arguments and matches all audio files where the number of
-times this audio file was selected is below the average.
-
-       is_set attribute_name
+       is_set <attribute_name>

 
 Takes the name of an attribute and matches iff that attribute is set.
 
 
 Takes the name of an attribute and matches iff that attribute is set.
 

-       path_matches pattern
+       path_matches <pattern>

 
 Takes a filename pattern and matches iff the path of the audio file
 matches the pattern.
 
 
 Takes a filename pattern and matches iff the path of the audio file
 matches the pattern.
 

+       artist_matches <pattern>
+       album_matches <pattern>
+       title_matches <pattern>
+       comment_matches <pattern>
+
+Takes an extended regular expression and matches iff the text of the
+corresponding tag of the audio file matches the pattern. If the tag
+is not set, the empty string is matched against the pattern.
+
+       year ~ <num>
+       bitrate ~ <num>
+       frequency ~ <num>
+       channels ~ <num>
+       num_played ~ <num>
+
+Takes a comparator ~ of the set {<, =, <=, >, >=, !=} and a number
+<num>. Matches an audio file iff the condition <val> ~ <num> is
+satisfied where val is the corresponding value of the audio file
+(value of the year tag, bitrate in kbit/s, frequency in Hz, channel
+count, play count).
+
+The year tag is special as its value is undefined if the audio file
+has no year tag or the content of the year tag is not a number. Such
+audio files never match. Another difference is the special treatment
+if the year tag is a two-digit number. In this case either 1900 or
+2000 are added to the tag value depending on whether the number is
+greater than 2000 plus the current year.
+

 
 ----------
 Mood usage
 
 ----------
 Mood usage


@@ -225,10 +248,10 @@ songs is
 Troubles?
 ---------
 
 Troubles?
 ---------
 

-Use loglevel one (option -l 1 for most commands) to show debugging
-info. Almost all paraslash executables have a brief online help which
-is displayed by using the -h switch. The --detailed-help option prints
-the full help text.
+Use the debug loglevel (option -l debug for most commands) to show
+debugging info. Almost all paraslash executables have a brief online
+help which is displayed by using the -h switch. The --detailed-help
+option prints the full help text.

 
 para_fsck tries to fix your database. Use --force (even if your name
 isn't Luke) to clean up after a crash. However, first make sure
 
 para_fsck tries to fix your database. Use --force (even if your name
 isn't Luke) to clean up after a crash. However, first make sure