X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.cmd;h=584ba809235c825cb9e1a3afdadd0644eea4d2c5;hp=e6e0d3e1bb7c8a9f828ee12e17048a5b14c5cba2;hb=5ff39998bf0ce71bd8fc8d0f002ceb81b711992f;hpb=be557cb0c7593e2b67fda79d0c34853862e5f4d9

diff --git a/afs.cmd b/afs.cmd
index e6e0d3e1..584ba809 100644
--- a/afs.cmd
+++ b/afs.cmd
@@ -1,27 +1,27 @@
-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 recursively.
+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: -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:-f	Force adding/updating. Recompute the audio format handler data
+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.
@@ -33,59 +33,55 @@ 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:
-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: -l=mode	Change listing mode. Defaults to short listing if not given.
+H:
+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 path of audio file. If not specified, only the basename
+H: -p	List full paths. If this option is not specified, only the basename
 H:	of each file is printed.
 H:
-H: -a	List only file that are admissible with respect to the current mood or
+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: -s	Change sort order. Defaults to alphabetical path sort if not given.
-H:
-H: 		-sp:  sort by path.
-H:
-H: 		-sl:  sort by last played time.
-H:
-H:	 	-ss:  sort by score (implies -a).
-H:
-H: 		-sn:  sort by num played count.
-H:
-H: 		-sf:  sort by frequency.
-H:
-H: 		-sc:  sort by number of channels.
-H:
-H: 		-si:  sort by image id.
-H:
-H: 		-sy:  sort by lyrics id.
-H:
-H: 		-sb:  sort by bitrate.
-H:
-H: 		-sd:  sort by duration.
-H:
-H: 		-sa:  sort by audio format.
+H: -d	Print dates as seconds after the epoch.
+H:
+H: -s=order	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: lsatt
 P: AFS_READ
-D: List attributes
+D: List attributes.
 U: lsatt [-i] [-l] [-r] [pattern]
-H:
-H: Print the list of all defined attributes which match the given pattern. If no
-H: pattern is given, the full list is printed.
+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:
@@ -103,24 +99,30 @@ U: setatt attribute{+|-}... pattern
 H: Set ('+') or unset ('-') the given attributes for all audio files matching
 H: pattern.  Example:
 H:
-H:         setatt rock+ punk+ classic- '*foo.mp3'
+H:         setatt rock+ punk+ pop- '*foo.mp3'
 H:
-H: sets the 'rock' and the 'punk' attribute but unsets the 'classic'
+H: sets the 'rock' and the 'punk' attribute and unsets the 'pop'
 H: attribute of all files ending with 'foo.mp3'.
 ---
 N: addatt
 P: AFS_READ | AFS_WRITE
 D: Add new attribute(s).
 U: addatt attribute1...
-H: This adds new attributes to the attribute table. At most 64 attributes
-H: may be defined.
+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 defined playlists and
-H: 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 +131,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
@@ -143,13 +150,14 @@ U: rmatt pattern...
 H: Remove all attributes matching any given pattern. All information
 H: about this attribute in the audio file table is lost.
 ---
-N: afs_rm
+N: rm
 P: AFS_READ | AFS_WRITE
 D: Remove entries from the audio file table.
 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: Delete all entries in the audio file table that match any given pattern.  Note
+H: that this affects the table entries only; the command won't touch your audio
+H: files on disk.
+H:
 H: Options:
 H:
 H: -v	Verbose mode. Explain what is being done.
@@ -164,27 +172,37 @@ H: 	a slash (see fnmatch(3)).
 ---
 N: touch
 P: AFS_READ | AFS_WRITE
-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 and numplayed is
-H: increased by one. Otherwise, only the given options are taken into account.
+D: Manipulate the afs entry of audio files.
+U: touch [-n=numplayed] [-l=lastplayed] [-y=lyrics_id] [-i=image_id] [-a=amp] [-v] [-p] pattern
+H: If no option is given, the lastplayed field is set to the current time
+H: and the value of the numplayed field is increased by one. Otherwise,
+H: only the given options are taken into account.
 H:
 H: Options:
 H:
-H: -n	Set numplayed count. The number of times afs has selected this
-H: 	audio file for streaming.
+H: -n	Set the numplayed count, i.e. the number of times this audio
+H:	file was selected for streaming so far.
 H:
-H: -l	Set lastplayed time. The last time this audio file was selected.
-H: 	Must be given as the number of seconds since the epoch. Example:
+H: -l	Set the lastplayed time, i.e. the last time this audio file was
+H:	selected for streaming. The argument must be a number of seconds
+H:	since the epoch. Example:
 H:
-H: 		touch -l $(date +%s) file
+H: 		touch -l=$(date +%s) file
 H:
 H: 	sets the lastplayed time of 'file' to the current time.
 H:
-H: -y	Set the lyrics id. Specify the lyrics data file associated with
-H: 	this audio file.
+H: -y	Set the lyrics ID which specifies the lyrics data file associated
+H:	with the audio file.
+H:
+H: -i	Like -y, but sets the image ID.
+H:
+H: -a	Set the amplification value (0-255). This determines a scaling
+H:	factor by which the amplitude should be multiplied in order to
+H:	normalize the volume of the audio file.  A value of zero means
+H:	no amplification, 64 means the amplitude should be multiplied
+H:	by a factor of two, 128 by three and so on.
 H:
-H: -i	Set the image id. Same as -y, but sets the image.
+H:	This value is used by the amp filter.
 H:
 H: -v	Verbose mode. Explain what is being done.
 H:
@@ -193,61 +211,88 @@ 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 the
+H: audio file selector info are copied to all files matching pattern.
+H: Otherwise, only the given options are 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.
+---
+N: select
+P: AFS_READ | AFS_WRITE
+D: Activate a mood or a playlist.
+U: select specifier/name
+H: The specifier is either 'm' or 'p' to indicate whether a playlist or
+H: a mood should be activated. Example:
+H:
+H:	select m/foo
+H:
+H: loads the mood named 'foo'.
+---
 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: Read data from stdin and add it as a blob to an osl table.
+D: Add stdin as a blob to the @member@ 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:
-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: 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: Dump the contents of a blob to stdout.
+D: Dump the contents of a blob of type @member@ 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: 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: List blobs of an osl table matching a pattern.
+D: List blobs of type @member@ which match a pattern.
 U: ls@member@ [-i] [-l] [-r] [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.
+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 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 attribute name. The
-H: 	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.
 ---
 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: Remove blob(s) from an osl table.
+D: Remove blob(s) of type @member@ from the @member@ table.
 U: rm@member@ pattern...
-H: Remove all blobs from the corresponding table which match any given 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: Rename a blob.
-U: mv@member@ old_@member@_name new_@member@_name
-H: Rename the blob identified by the first name as the second name.
+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.