X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=afs.cmd;h=f05519989c9bd20ec4c9b7f5aa952b983efb39c2;hb=fdf416e9af730a1df9eec8d7acb108d7ca881926;hp=7dd3d15e2149f687468ddc7b8aa2761ec7fcfac8;hpb=57385d313c47bb37b3ac73940a43d47612a2c593;p=paraslash.git

diff --git a/afs.cmd b/afs.cmd
index 7dd3d15e..9ee51f17 100644
--- a/afs.cmd
+++ b/afs.cmd
@@ -1,101 +1,113 @@
-OF: afs_command_list
+BN: afs
 SF: afs.c aft.c attribute.c
-HC: Prototypes for the commands of the audio file selector.
-CC: Array of commands for the audio file selector.
-AT: server_command
-IN: para afh server list user_list
 SN: list of afs commands
 TM: mood lyr img pl
 ---
-N: add
-P: AFS_READ | AFS_WRITE
-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.
+N: ls
+P: AFS_READ
+D: List audio files.
+U: ls [-l=mode] [-p] [-a] [-r] [-d] [-s=order] [pattern...]
+H: Print a list of all audio files matching pattern.
 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: -l=mode	Change listing mode. Defaults to short listing if not given.
 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:    Available modes:
+H:    s: short listing mode
+H:    l: long listing mode (equivalent to -l)
+H:    v: verbose listing mode
+H:    p: parser-friendly mode
+H:    m: mbox listing mode
+H:    c: chunk-table listing mode
 H:
-H: -v	Verbose mode. Print what is being done.
----
-N: init
-P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
----
-N: afs_ls
-P: AFS_READ
-D: FIXME
-U: FIXME
-H: FIXME
----
-N: setatt
-P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
+H: -F	List full paths. If this option is not specified, only the basename
+H:	of each file is printed.
+H: -p	Synonym for -F. Deprecated.
+H:
+H: -b	Print only the basename of each matching file. This is the default, so
+H:	the option is currently a no-op. It is recommended to specify this option,
+H:	though, as the default might change in a future release.
+H:
+H: -a	List only files that are admissible with respect to the current mood or
+H:	playlist.
+H:
+H: -r	Reverse sort order.
+H:
+H: -d	Print dates as seconds after the epoch.
+H:
+H: -s=order
+H:	Change sort order. Defaults to alphabetical path sort if not given.
+H:
+H:   Possible values for order:
+H:   p: by path
+H:   l: by last played time
+H:   s: by score (implies -a)
+H:   n: by num played count
+H:   f: by frequency
+H:   c: by number of channels
+H:   i: by image id
+H:   y: by lyrics id
+H:   b: by bit rate
+H:   d: by duration
+H:   a: by audio format
 ---
 N: addatt
 P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
----
-N: rmatt
-P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
----
-N: afs_rm
-P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
+D: Add new attribute(s).
+U: addatt attribute1...
+H: This adds new attributes to the attribute table. At most 64
+H: attributes may be defined.
 ---
-N: touch
+T: add
+N: add@member@
+O: int com_add@member@(struct command_context *cc);
 P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
+D: Add stdin as a blob to the @member@ table.
+U: add@member@ @member@_name
+H: Read from stdin and ask the audio file selector to create a blob in the
+H: corresponding osl table. If the named blob already exists, it gets replaced
+H: with the new data.
 ---
 T: cat
 N: cat@member@
-O: int com_cat@member@(int fd, int argc, char * const * const argv);
+O: int com_cat@member@(struct command_context *cc);
 P: AFS_READ
-D: FIXME
+D: Dump the contents of a blob of type @member@ to stdout.
 U: cat@member@ @member@_name
-H: FIXME
+H: Retrieve the named blob and write it to stdout.
 ---
 T: ls
 N: ls@member@
-O: int com_ls@member@(int fd, int argc, char * const * const argv);
+O: int com_ls@member@(struct command_context *cc);
 P: AFS_READ
-D: FIXME
-U: cat@member@ <pattern>
-H: FIXME
+D: List blobs of type @member@ which match a pattern.
+U: ls@member@ [-i] [-l] [-r] [pattern]
+H: Print the list of all blobs which match the given pattern. If no
+H: pattern is given, the full list is printed.
+H:
+H: Options:
+H:
+H: -i	Sort by identifier. The default is to sort alphabetically by name.
+H:
+H: -l	Print identifier and name. The default is to print only the name.
+H:
+H: -r	Reverse sort order.
 ---
 T: rm
 N: rm@member@
-O: int com_rm@member@(int fd, int argc, char * const * const argv);
+O: int com_rm@member@(struct command_context *cc);
 P: AFS_READ | AFS_WRITE
-D: FIXME
-U: rm@member@ @member@_name
-H: FIXME
+D: Remove blob(s) of type @member@ from the @member@ table.
+U: rm@member@ pattern...
+H: Remove all blobs whose name matches any of the given patterns.
 ---
 T: mv
 N: mv@member@
-O: int com_mv@member@(int fd, int argc, char * const * const argv);
+O: int com_mv@member@(struct command_context *cc);
 P: AFS_READ | AFS_WRITE
-D: FIXME
-U: mv@member@ old_@member@_name new_@member@_name
-H: FIXME
+D: Rename a blob of type @member@.
+U: mv@member@ source_@member@_name dest_@member@_name
+H: Rename the blob identified by the source blob name to the destination blob
+H: name. The command fails if the source does not exist, or if the destination
+H: already exists.