doxify acl.c.
[paraslash.git] / README.afs
index e627ca7..d77f6bf 100644 (file)
@@ -2,9 +2,13 @@ The audio file selector
 =======================
 
 Paraslash comes with a sophisticated audio file selector called afs.
 =======================
 
 Paraslash comes with a sophisticated audio file selector called afs.
-In the installation notes, only the "dummy" mode of afs was used which
-gets activated automatically if nothing else was specified. In this
-section the various features of afs are described.
+In the
+<<
+<a href="INSTALL.html">installation notes</a>,
+>>
+only the "dummy" mode of afs was used which gets activated automatically if
+nothing else was specified. In this section the various features of afs are
+described.
 
 ----------
 Attributes
 
 ----------
 Attributes
@@ -146,21 +150,21 @@ special treatment:
 List of mood_methods
 ~~~~~~~~~~~~~~~~~~~~
 
 List of mood_methods
 ~~~~~~~~~~~~~~~~~~~~
 
-       no_attributes_set()
+       no_attributes_set
 
 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()
+       played_rarely
 
 Takes no arguments and matches all audio files where the number of
 times this audio file was selected is below the average.
 
 
 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.
 
-       name_like(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.
@@ -219,12 +223,33 @@ songs is
 ---------
 Troubles?
 ---------
 ---------
 Troubles?
 ---------
-If something went wrong, look at the output. If that does not give
-you a clue, 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.
-
-Still not working? Mail the author Andre Noll <maan@systemlinux.org>
-(english, german, or spanish language). Please provide enough info
-such as the version of paraslash you are using and relevant parts of
-the logs.
+
+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.
+
+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_server isn't running before executing para_fsck if para_fsck
+complains about busy (dirty) tables. para_fsck also contains an option
+to dump the contents of your the contents of the database to the file
+system.
+
+If you don't mind to recreate your database you can start
+from scratch by removing the entire database directory, i.e.
+
+       rm -rf ~/.paraslash/afs_database
+
+Note that this removes all tables, in particular attribute definitions
+and data, and all playlist and mood definitions.
+
+para_fsck operates on the osl-layer, i.e. it fixes inconsistencies
+in the database but doesn't know about the contents of the tables
+contained therein. Use
+
+       para_client check
+
+to print out bad entries, e.g.missing audio files or invalid mood
+definitions.
+
+Still having problems? mailto: Andre Noll <maan@systemlinux.org>