afs.cmd: Add documentation for lsatt.

[paraslash.git] / afs.cmd

diff --git a/afs.cmd b/afs.cmd
index fdf65523b5147eff59dbcb3f3cdcd70c1489fb32..79cb84ee6554fb280ae21d19b7b548f79bfa87a3 100644 (file)
--- a/afs.cmd
+++ b/afs.cmd
@@ -9,9 +9,22 @@ TM: mood lyr img pl
 ---
 N: add
 P: AFS_READ | AFS_WRITE
 ---
 N: add
 P: AFS_READ | AFS_WRITE

-D: FIXME
-U: FIXME
-H: FIXME
+D: Add new audio files to the database.
+U: add [-l] [-f] [-v] path1 ...
+H: Each given path may be either the full path to an audio file, or the full path
+H: of a directory. In case of a directory, all audio files in that directory
+H: are added recursivly.
+H:
+H: Options:
+H:
+H: -l  Add files lazily. If a file already exists in the database, skip this file.
+H:     This operation is really cheap. Use it when adding large directories if only a
+H:     few files where added.
+H:
+H:-f   Force adding/updating. Recompute the audio format handler data
+H:     even if a file with the same path and the same hash value exists.
+H:
+H: -v  Verbose mode. Print what is being done.

 ---
 N: init
 P: AFS_READ | AFS_WRITE
 ---
 N: init
 P: AFS_READ | AFS_WRITE


@@ -21,9 +34,51 @@ H: FIXME
 ---
 N: afs_ls
 P: AFS_READ
 ---
 N: afs_ls
 P: AFS_READ

-D: FIXME
-U: FIXME
-H: FIXME
+D: List audio files.
+U: ls [-l[s|l|v|m]] -p -a -r -s{p|s|l|n|f|c|i|y|b|d|a} [pattern ...]
+H: Print a list of all audio files matching pattern.
+H:
+H: Options:
+H: -l  Change listing mode. Defaults to short listing if not given.
+H:     -ls: short listing mode
+H:     -ll: long listing mode (equivalent to -l)
+H:     -lv: verbose listing mode
+H:     -lm: mbox listing mode
+H:
+H: -p  List full path of audio file. If not specified, only the basename
+H:     of each file is printed.
+H:
+H: -a  List only file that are admissible with respect to the current mood or
+H:     playlist.
+H:
+H: -r  Reverse sort order.
+H:
+H: -s  Change sort order. Defaults to alphabetical path sort if not given.
+H:     -sp:  sort by path.
+H:     -sl:  sort by last played time.
+H:     -ss:  sort by score (implies -a).
+H:     -sn:  sort by number of times the file was played.
+H:     -sf:  sort by frequency.
+H:     -sc:  sort by number of channels.
+H:     -si:  sort by image id.
+H:     -sy:  sort by lyrics id.
+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 attribute
+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
 ---
 N: setatt
 P: AFS_READ | AFS_WRITE


@@ -57,7 +112,7 @@ H: FIXME
 ---
 T: cat
 N: cat@member@
 ---
 T: cat
 N: cat@member@

-O: int com_cat@member@(int fd, int argc, char **argv);
+O: int com_cat@member@(int fd, int argc, char * const * const argv);

 P: AFS_READ
 D: FIXME
 U: cat@member@ @member@_name
 P: AFS_READ
 D: FIXME
 U: cat@member@ @member@_name


@@ -65,7 +120,7 @@ H: FIXME
 ---
 T: ls
 N: ls@member@
 ---
 T: ls
 N: ls@member@

-O: int com_ls@member@(int fd, int argc, char **argv);
+O: int com_ls@member@(int fd, int argc, char * const * const argv);

 P: AFS_READ
 D: FIXME
 U: cat@member@ <pattern>
 P: AFS_READ
 D: FIXME
 U: cat@member@ <pattern>


@@ -73,7 +128,7 @@ H: FIXME
 ---
 T: rm
 N: rm@member@
 ---
 T: rm
 N: rm@member@

-O: int com_rm@member@(int fd, int argc, char **argv);
+O: int com_rm@member@(int fd, int argc, char * const * const argv);

 P: AFS_READ | AFS_WRITE
 D: FIXME
 U: rm@member@ @member@_name
 P: AFS_READ | AFS_WRITE
 D: FIXME
 U: rm@member@ @member@_name


@@ -81,7 +136,7 @@ H: FIXME
 ---
 T: mv
 N: mv@member@
 ---
 T: mv
 N: mv@member@

-O: int com_mv@member@(int fd, int argc, char **argv);
+O: int com_mv@member@(int fd, int argc, char * const * const argv);

 P: AFS_READ | AFS_WRITE
 D: FIXME
 U: mv@member@ old_@member@_name new_@member@_name
 P: AFS_READ | AFS_WRITE
 D: FIXME
 U: mv@member@ old_@member@_name new_@member@_name