]> git.tuebingen.mpg.de Git - paraslash.git/blobdiff - afs.cmd
server: Convert com_addatt() to lopsub.
[paraslash.git] / afs.cmd
diff --git a/afs.cmd b/afs.cmd
index 9a4bbdcd93f858cbc8a8802b75f0da1fedb476f5..6047dbd9cc1af997745bd5a9e8e36d810ac96f08 100644 (file)
--- a/afs.cmd
+++ b/afs.cmd
-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.
-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
-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
+N: ls
 P: AFS_READ
 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 ...]
+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: -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: -l=mode     Change listing mode. Defaults to short listing if not given.
 H:
-H: -a  List only file that are admissible with respect to the current mood or
-H:     playlist.
+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: -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
-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: 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: 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
-D: FIXME
-U: FIXME
-H: FIXME
----
-N: afs_rm
-P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-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: -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:             touch -l $(date +%s) file
+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:     sets the lastplayed time of 'file' to the current time
+H: -a  List only files that are admissible with respect to the current mood or
+H:     playlist.
 H:
-H: -y  Set the lyrics id. Specify the lyrics data file associated with
-H:     this audio file.
+H: -r  Reverse sort order.
 H:
-H: -i  Set the image id. Same as -y, but sets the image.
+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
 ---
 T: add
 N: add@member@
-O: int com_add@member@(int fd, int argc, char * const * const argv);
+O: int com_add@member@(struct command_context *cc);
 P: AFS_READ | AFS_WRITE
-D: FIXME
+D: Add stdin as a blob to the @member@ table.
 U: add@member@ @member@_name
-H: FIXME
+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: ls@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.