Add a check for libosl to configure.ac.
[paraslash.git] / afs.cmd
diff --git a/afs.cmd b/afs.cmd
index 15a30d0..de9782a 100644 (file)
--- a/afs.cmd
+++ b/afs.cmd
@@ -3,7 +3,8 @@ 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
+SI: openssl/rc4 osl
+IN: para error crypt command string afh afs server list user_list
 SN: list of afs commands
 TM: mood lyr img pl
 ---
@@ -38,10 +39,10 @@ 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[s|l|v|m]] [-p] [-a] [-r] [-d] [-s{p|s|l|n|f|c|i|y|b|d|a}] [pattern...]
 H: Print a list of all audio files matching pattern.
 H:
 H: Options:
@@ -54,16 +55,22 @@ H:          -ll:   long listing mode (equivalent to -l)
 H:
 H:             -lv:   verbose listing mode
 H:
+H:             -lp:   parser-friendly mode
+H:
 H:             -lm:   mbox listing mode
 H:
+H:             -lc:   chunk-table listing mode
+H:
 H: -p  List full path of audio file. If 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: -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:  sort by path.
@@ -90,7 +97,7 @@ H:            -sa:  sort by audio format.
 ---
 N: lsatt
 P: AFS_READ
-D: List attributes
+D: List 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
@@ -134,8 +141,8 @@ 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.
+H: Check the audio file table, the mood definitions and all
+H: defined playlists and report any inconsistencies found.
 H:
 H: Options:
 H:
@@ -158,7 +165,7 @@ 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...
@@ -180,7 +187,7 @@ 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
+U: touch [-n=numplayed] [-l=lastplayed] [-y=lyrics_id] [-i=image_id] [-a=amp] [-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.
@@ -202,6 +209,14 @@ H:         this audio file.
 H:
 H: -i  Set the image id. Same as -y, but sets the image.
 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:     This value is used by the compress filter.
+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
@@ -232,11 +247,22 @@ 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 rc4_context *rc4c, 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.
+D: Read data from stdin and add it as a blob to the @member@ table.
 U: add@member@ @member@_name
 H: Read arbitrary binary data from stdin and send that data to
 H: the audio file selector process which creates a new blob for
@@ -247,9 +273,9 @@ H: given name already exists, its contents are replaced by 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 rc4_context *rc4c, int argc, char * const * const argv);
 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: This command may be used to retrieve the blob identified by
 H: the given name from the corresponding osl table to which
@@ -257,9 +283,9 @@ H: they were previously added.
 ---
 T: ls
 N: ls@member@
-O: int com_ls@member@(int fd, int argc, char * const * const argv);
+O: int com_ls@member@(struct rc4_context *rc4c, int argc, char * const * const argv);
 P: AFS_READ
-D: List blobs of an osl table matching a pattern.
+D: List blobs of type @member@ matching a pattern.
 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
@@ -267,26 +293,27 @@ 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: -i  Sort attributes by id. The default is to sort
+H:     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 a long listing containing both identifier and
+H:     attribute 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 rc4_context *rc4c, int argc, char * const * const argv);
 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
 H: any given pattern.
 ---
 T: mv
 N: mv@member@
-O: int com_mv@member@(int fd, int argc, char * const * const argv);
+O: int com_mv@member@(struct rc4_context *rc4c, int argc, char * const * const argv);
 P: AFS_READ | AFS_WRITE
-D: Rename a blob.
+D: Rename a blob of type @member@.
 U: mv@member@ old_@member@_name new_@member@_name
 H: Rename the blob identified by the first name as the second name.