X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.cmd;h=92f2e56a6703aa57fc874a94de32c7d4611937a8;hp=fca60466e347f3243e298afd3c11479871a45ef4;hb=61250cf03241bf73662dac3753e44660a572fa2a;hpb=ad9ff4973f843b8f1eaf3d6cd132450be683e4a3

diff --git a/afs.cmd b/afs.cmd
index fca60466..92f2e56a 100644
--- a/afs.cmd
+++ b/afs.cmd
@@ -3,23 +3,28 @@ 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
+IN: para error string afh afs 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 recursively.
+U: add [-l] [-f] [-v] path...
+H: Each given path may be either the full path to an audio
+H: file, or the full path of a directory. In case of a
+H: directory, all audio files in that directory are added
+H: recursively. Only absolute paths are accepted.
 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: -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.
+H:	Use it when adding large directories if only a few files
+H:	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.
@@ -42,10 +47,14 @@ H:
 H: Options:
 H:
 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: 		-ls:   short listing mode
+H:
+H:	 	-ll:   long listing mode (equivalent to -l)
+H:
+H: 		-lv:   verbose listing mode
+H:
+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.
@@ -73,7 +82,7 @@ H: 		-si:  sort by image id.
 H:
 H: 		-sy:  sort by lyrics id.
 H:
-H: 		-sb:  sort by bitrate.
+H: 		-sb:  sort by bit rate.
 H:
 H: 		-sd:  sort by duration.
 H:
@@ -82,17 +91,19 @@ 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.
+U: lsatt [-i] [-l] [-r] [pattern]
+H: Print the list of all defined attributes which match the
+H: given pattern. If no pattern is given, the full list is
+H: printed.
 H:
 H: Options:
 H:
-H: -a	Sort attributes alphabetically by name. The default is to sort by
-H: 	identifier.
+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
@@ -101,7 +112,7 @@ U: setatt attribute{+|-}... 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:         setatt 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'.
@@ -109,21 +120,27 @@ 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.
+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: This command checks the audio file table, the mood definitions and all
-H: defined playlists and reports any inconsistencies found.
+H: Check the audio file table, the mood definitions and all defined playlists and
+H: report any inconsistencies found.
 H:
 H: Options:
 H:
 H: -a 	Run audio file table checks. Checks for entries in the audio file
-H: 	table which are not present in the filesystem. Moreover, it checks
+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:
@@ -144,17 +161,29 @@ H: about this attribute in the audio file table is lost.
 N: afs_rm
 P: AFS_READ | AFS_WRITE
 D: Remove entries from the audio file table.
-U: rm pattern...
+U: rm [-v] [-f] [-p] pattern...
 H: Delete all entries in the audio file table that match any given pattern.
 H: Note that affects the table entries only; paraslash won't touch your
 H: audio files in any way.
+H: Options:
+H:
+H: -v	Verbose mode. Explain what is being done.
+H:
+H: -f	Force mode. Ignore nonexistent files. Don't complain if nothing
+H:	was removed.
+H:
+H: -p	Pathname match. Match a slash in the path only with a slash
+H: 	in pattern and not by an asterisk (*) or a question mark
+H: 	(?) metacharacter, nor by a bracket expression ([]) containing
+H: 	a slash (see fnmatch(3)).
 ---
 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
-H: If no option is given, lastplayed is set to the current time and numplayed is
-H: increased by one. Otherwise, only the given options are taken into account.
+D: Manipulate the afs data for all audio files matching a pattern.
+U: touch [-n numplayed] [-l lastplayed] [-y lyrics_id] [-i image_id] [-v] [-p] pattern
+H: If no option is given, lastplayed is set to the current time
+H: and numplayed is increased by one. Otherwise, only the given
+H: options are taken into account.
 H:
 H: Options:
 H:
@@ -162,7 +191,7 @@ 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: 	Must be given as the number of seconds since the epoch. Example:
 H:
 H: 		touch -l $(date +%s) file
 H:
@@ -172,6 +201,36 @@ H: -y	Set the lyrics id. Specify the lyrics data file associated with
 H: 	this audio file.
 H:
 H: -i	Set the image id. Same as -y, but sets the image.
+H:
+H: -v	Verbose mode. Explain what is being done.
+H:
+H: -p	Pathname match. Match a slash in the path only with a slash
+H: 	in pattern and not by an asterisk (*) or a question mark
+H: 	(?) metacharacter, nor by a bracket expression ([]) containing
+H: 	a slash (see fnmatch(3)).
+---
+N: cpsi
+P: AFS_READ | AFS_WRITE
+D: Copy audio file selector info.
+U: cpsi [-a] [-y] [-i] [-l] [-n] [-v] source pattern...
+H: If no option, or only the -v option is given, all fields of
+H: the audio file selector info are copied to all files
+H: matching pattern.  Otherwise, only the given options are
+H: taken into account.
+H:
+H: Options:
+H:
+H: -a	Copy attributes.
+H:
+H: -y	Copy the lyrics id.
+H:
+H: -i	Copy the image id.
+H:
+H: -l	Copy the lastplayed time.
+H:
+H: -n	Copy the numplayed count.
+H:
+H: -v	Verbose mode.
 ---
 T: add
 N: add@member@
@@ -179,15 +238,12 @@ O: int com_add@member@(int fd, int argc, char * const * const argv);
 P: AFS_READ | AFS_WRITE
 D: Read data from stdin and add it as a blob to an osl table.
 U: add@member@ @member@_name
-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: Read arbitrary binary data from stdin and send that data to
+H: the audio file selector process which creates a new blob for
+H: the data in the corresponding osl table.
 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.
+H: The names of the blobs of a table are unique. If an entry with the
+H: given name already exists, its contents are replaced by the new data.
 ---
 T: cat
 N: cat@member@
@@ -195,18 +251,28 @@ O: int com_cat@member@(int fd, int argc, char * const * const argv);
 P: AFS_READ
 D: Dump the contents of a blob to stdout.
 U: cat@member@ @member@_name
-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.
+H: This command may be used to retrieve the blob identified by
+H: the given name from the corresponding osl table to which
+H: 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: 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.
+U: ls@member@ [-i] [-l] [-r] [pattern]
+H: Print a list of the names of all blobs in the corresponding
+H: osl table which match the given pattern. If no pattern is
+H: 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.
 ---
 T: rm
 N: rm@member@
@@ -214,7 +280,8 @@ O: int com_rm@member@(int fd, int argc, char * const * const argv);
 P: AFS_READ | AFS_WRITE
 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.
+H: Remove all blobs from the corresponding table which match
+H: any given pattern.
 ---
 T: mv
 N: mv@member@