afs.cmd: Add documentation of addatt, touch.

[paraslash.git] / afs.cmd

diff --git a/afs.cmd b/afs.cmd
index e9d9cfe12c19d8a2e532d6a5a669fe88f021e570..9a4bbdcd93f858cbc8a8802b75f0da1fedb476f5 100644 (file)
--- a/afs.cmd
+++ b/afs.cmd
@@ -28,9 +28,10 @@ H: -v        Verbose mode. Print what is being done.
 ---
 N: init
 P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
+D: Initialize the osl tables for the audio file selector.
+U: init [table_name ...]
+H: When invoked without arguments, this command creates all tables. Otherwise
+H: only the tables given by table_name... are created.
 ---
 N: afs_ls
 P: AFS_READ
@@ -66,17 +67,39 @@ H:  -sb:  sort by bitrate.
 H:     -sd:  sort by duration.
 H:     -sa:  sort by audio format.
 ---
+N: lsatt
+P: AFS_READ
+D: List attributes
+U: lsatt [-a] [-l]
+H:
+H: Print the list of all defined attributes.
+H:
+H: Options:
+H: -a  Sort attributes alphabetically by name. The default is to sort by
+H:     identifier.
+H:
+H: -l  Print a long listing containing both identifier and attribute name. The
+H:     default is to print only the name.
+---
 N: setatt
 P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
+D: Set attribute(s) for all files matching a pattern.
+U: setatt attribute1{+|-} [attribute2{+|-}...] pattern
+
+H: Set ('+') or unset ('-') the given attributes for all audio files matching
+H: pattern.  Example:
+H:
+H:         sa rock+ punk+ classic- '*foo.mp3'
+H:
+H: sets the 'rock' and the 'punk' attribute but unsets the 'classic'
+H: attribute of all files ending with 'foo.mp3'.
 ---
 N: addatt
 P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
+D: Add new attribute(s).
+U: addatt attribute1 [attribute2 ...]
+H: This adds new attributes to the attribute table. At most 64 attributes
+H: may be defined.
 ---
 N: rmatt
 P: AFS_READ | AFS_WRITE
@@ -92,8 +115,33 @@ H: FIXME
 ---
 N: touch
 P: AFS_READ | AFS_WRITE
+D: Manupulate the afs data for all audio files matching a pattern.
+U: touch [-n numplayed] [-l lastplayed] [-y lyrics_id] [-i image_id] pattern
+If neither of the optional options is given, lastplayed is set to the current
+time and numplayed is increased by one. Otherwise, only the given options are
+taken into account.
+Options:
+H: -n  Set numplayed count. The number of times afs has selected this
+H:     audio file for streaming.
+H:
+H: -l  Set lastplayed time. The last time this audio file was selected.
+H:     Must be given as the number of sectonds since the epoch. Example:
+H:
+H:             touch -l $(date +%s) file
+H:
+H:     sets the lastplayed time of 'file' to the current time
+H:
+H: -y  Set the lyrics id. Specify the lyrics data file associated with
+H:     this audio file.
+H:
+H: -i  Set the image id. Same as -y, but sets the image.
+---
+T: add
+N: add@member@
+O: int com_add@member@(int fd, int argc, char * const * const argv);
+P: AFS_READ | AFS_WRITE
 D: FIXME
-U: FIXME
+U: add@member@ @member@_name
 H: FIXME
 ---
 T: cat
@@ -109,7 +157,7 @@ N: ls@member@
 O: int com_ls@member@(int fd, int argc, char * const * const argv);
 P: AFS_READ
 D: FIXME
-U: cat@member@ <pattern>
+U: ls@member@ pattern
 H: FIXME
 ---
 T: rm