afs.cmd: Add documentation of all blob commands.
authorAndre Noll <maan@systemlinux.org>
Sun, 23 Sep 2007 20:20:54 +0000 (22:20 +0200)
committerAndre Noll <maan@systemlinux.org>
Sun, 23 Sep 2007 20:20:54 +0000 (22:20 +0200)
afs.cmd

diff --git a/afs.cmd b/afs.cmd
index b3d3ec9..87ec1a0 100644 (file)
--- a/afs.cmd
+++ b/afs.cmd
@@ -13,7 +13,7 @@ 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: are added recursively.
 H:
 H: Options:
 H:
@@ -146,38 +146,49 @@ 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
+D: Read data from stdin and add it as a blob to an osl table.
 U: add@member@ @member@_name
-H: FIXME
+H: Each command of this family reads arbitrary binary data from stdin and sends
+H: that data to the audio file selector process. The afs process then creates a
+H: new blob for the data in the corresponding osl table. Example:
+H:
+H:     addimg foo.jpg < bar.jpg
+H:
+H: adds the contents of the file 'bar.jpg' as a blob named 'foo.jpg' to the image
+H: table.  The names of the blobs of a table must be unique, i.e. it is an error
+H: if an entry named 'foo.jpg' already exists.
 ---
 T: cat
 N: cat@member@
 O: int com_cat@member@(int fd, int argc, char * const * const argv);
 P: AFS_READ
-D: FIXME
+D: Dump the contents of a blob to stdout.
 U: cat@member@ @member@_name
-H: FIXME
+H: These commands may be used to retrieve the blob identified by the given name from
+H: the corresponding osl table to which they were previously added.
 ---
 T: ls
 N: ls@member@
 O: int com_ls@member@(int fd, int argc, char * const * const argv);
 P: AFS_READ
-D: FIXME
-U: ls@member@ pattern
-H: FIXME
+D: List blobs of an osl table matching a pattern.
+U: ls@member@ [-v] [pattern]
+H: Print a list of the names of all blobs in the corresponding osl table which
+H: match the given pattern. If no pattern is given, the full list is printed. If
+H: the optional -v pattern is given, the blob id is printed as well.
 ---
 T: rm
 N: rm@member@
 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
-H: FIXME
+D: Remove blob(s) from an osl table.
+U: rm@member@ pattern...
+H: Remove all blobs from the corresponding table which match any given pattern.
 ---
 T: mv
 N: mv@member@
 O: int com_mv@member@(int fd, int argc, char * const * const argv);
 P: AFS_READ | AFS_WRITE
-D: FIXME
+D: Rename a blob.
 U: mv@member@ old_@member@_name new_@member@_name
-H: FIXME
+H: Rename the blob identified by the first name as the second name.