X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.cmd;h=5a265d6164678d2758ab3d2cdb512d91f9750dee;hp=7bb005454049617f43c1c9cac8efc7f4c4bf7cca;hb=3f696a82bbb79cb07bfdb8e510bb4f3515570cec;hpb=97ad8ac8735dfd7a514aa66e9de54f253440c17d

diff --git a/afs.cmd b/afs.cmd
index 7bb00545..5a265d61 100644
--- a/afs.cmd
+++ b/afs.cmd
@@ -3,55 +3,31 @@ SF: afs.c aft.c attribute.c
 SN: list of afs commands
 TM: mood lyr img pl
 ---
-N: add
-P: AFS_READ | AFS_WRITE
-D: Add or update audio files.
-U: add [-a] [-l] [-f] [-v] path...
-H: Each path must be absolute and refer to either an audio file, or a
-H: directory. In case of a directory, all audio files in that directory
-H: are added recursively. Only absolute paths are accepted.
-H:
-H: Options:
-H:
-H: -a	Add all files. The default is to add only files ending in a
-H:	known suffix for a supported audio format.
-H:
-H: -l	Add files lazily. If the path already exists in the
-H:	database, skip this file.  This operation is really cheap. Useful
-H:	to update large directories after some files have been added or
-H:	deleted.
-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: ls
 P: AFS_READ
 D: List audio files.
-U: ls [-l[s|l|v|m]] [-p] [-a] [-r] [-d] [-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:
-H: -l	Change listing mode. Defaults to short listing if not given.
+H: -l=mode	Change listing mode. Defaults to short listing if not given.
 H:
-H:    -ls: short listing mode
-H:    -ll: long listing mode (equivalent to -l)
-H:    -lv: verbose listing mode
-H:    -lp: parser-friendly mode
-H:    -lm: mbox listing mode
-H:    -lc: chunk-table listing mode
+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: -p	List full paths. If this option is not specified, only the basename
+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.
@@ -60,47 +36,21 @@ H: -r	Reverse sort order.
 H:
 H: -d	Print dates as seconds after the epoch.
 H:
-H: -s	Change sort order. Defaults to alphabetical path sort if not given.
-H:
-H:    -sp: by path
-H:    -sl: by last played time
-H:    -ss: by score (implies -a)
-H:    -sn: by num played count
-H:    -sf: by frequency
-H:    -sc: by number of channels
-H:    -si: by image id
-H:    -sy: by lyrics id
-H:    -sb: by bit rate
-H:    -sd: by duration
-H:    -sa: by audio format
----
-N: lsatt
-P: AFS_READ
-D: List attributes.
-U: lsatt [-i] [-l] [-r] [pattern]
-H: Print the list of all defined attributes which match the given
-H: pattern. If no pattern is given, the full list is printed.
-H:
-H: Options:
-H:
-H: -i	Sort attributes by id. The default is to sort alphabetically by name.
-H:
-H: -l	Print a long listing containing both identifier and attribute name. The
-H: 	default is to print only the name.
-H:
-H: -r	Reverse sort order.
----
-N: setatt
-P: AFS_READ | AFS_WRITE
-D: Set attribute(s) for all files matching a pattern.
-U: setatt attribute{+|-}... pattern
-H: Set ('+') or unset ('-') the given attributes for all audio files matching
-H: pattern.  Example:
-H:
-H:         setatt rock+ punk+ pop- '*foo.mp3'
-H:
-H: sets the 'rock' and the 'punk' attribute and unsets the 'pop'
-H: attribute of all files ending with 'foo.mp3'.
+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
@@ -109,18 +59,12 @@ U: addatt attribute1...
 H: This adds new attributes to the attribute table. At most 64
 H: attributes may be defined.
 ---
-N: mvatt
-P: AFS_READ | AFS_WRITE
-D: Rename an attribute.
-U: mvatt old new
-H: Rename attribute old to new.
----
 N: check
 P: AFS_READ
 D: Run integrity checks against osl tables.
-U: check [-a] [-m] [-p]
-H: Check the audio file table, the mood definitions and all
-H: defined playlists and report any inconsistencies found.
+U: check [-a] [-A] [-m] [-p]
+H: Check the audio file table, the attribute table, the mood definitions
+H: and all defined playlists. Report any inconsistencies.
 H:
 H: Options:
 H:
@@ -129,12 +73,17 @@ H: 	table which are not present in the file system. Moreover, it checks
 H: 	whether the lyrics id and all entries in the audio file table are
 H: 	valid.
 H:
+H: -A	Check the attribute table against the afs attribute bitmask of
+H:	each audio file in the audio file table. Reports audio files
+H:	whose attribute bitmask is invalid, i.e., has a bit set which
+H:	does not correspond to any attribute of the attribute table.
+H:
 H: -m	Run syntax checks on all defined moods in the mood table.
 H:
 H: -p	Check all playlists for lines that correspond to files not contained
 H: 	in the audio file table.
 H:
-H: If called without arguments, all three checks are run.
+H: If called without arguments, all checks are run.
 ---
 N: rmatt
 P: AFS_READ | AFS_WRITE
@@ -259,18 +208,16 @@ T: ls
 N: ls@member@
 O: int com_ls@member@(struct command_context *cc);
 P: AFS_READ
-D: List blobs of type @member@ matching a pattern.
+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 attributes by id. The default is to sort
-H:	alphabetically by name.
+H: -i	Sort by identifier. The default is to sort alphabetically by name.
 H:
-H: -l	Print a long listing containing both identifier and
-H:	attribute name. The default is to print only the name.
+H: -l	Print identifier and name. The default is to print only the name.
 H:
 H: -r	Reverse sort order.
 ---
@@ -287,6 +234,7 @@ N: mv@member@
 O: int com_mv@member@(struct command_context *cc);
 P: AFS_READ | AFS_WRITE
 D: Rename a blob of type @member@.
-U: mv@member@ old_@member@_name new_@member@_name
-H: Rename the blob identified by old_@member@_name to new_@member@_name.
-H: This command fails if new_@member@_name already exists.
+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.