---
N: add
P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
+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.
+H:
+H: Options:
+H:
+H: -a Add all files. The default is to add only files ending in a known suffix
+H: for a supported audio format.
+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: FIXME
-U: FIXME
-H: FIXME
+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
P: AFS_READ
-D: FIXME
-U: FIXME
-H: FIXME
+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...]
+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:
+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: 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 bit rate.
+H:
+H: -sd: sort by duration.
+H:
+H: -sa: sort by audio format.
+---
+N: lsatt
+P: AFS_READ
+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:
+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: FIXME
-U: FIXME
-H: FIXME
+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+ 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: FIXME
-U: FIXME
-H: FIXME
+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.
+---
+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:
+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 file system. Moreover, it checks
+H: whether the lyrics id and all entries in the audio file table are
+H: valid.
+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.
---
N: rmatt
P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
+D: Remove attribute(s).
+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
P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
+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: 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: FIXME
-U: FIXME
-H: FIXME
+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.
+H:
+H: Options:
+H:
+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 seconds since the epoch. Example:
+H:
+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:
+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)).
+---
+T: add
+N: add@member@
+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:
+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.
---
T: cat
N: cat@member@
-O: int com_cat@member@(int fd, int argc, char **argv);
+O: int com_cat@member@(int fd, int argc, char * const * const argv);
P: AFS_READ
-D: FIXME
+D: Dump the contents of a blob to stdout.
U: cat@member@ @member@_name
-H: FIXME
+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.
---
T: ls
N: ls@member@
-O: int com_ls@member@(int fd, int argc, char **argv);
+O: int com_ls@member@(int fd, int argc, char * const * const argv);
P: AFS_READ
-D: FIXME
-U: cat@member@ <pattern>
-H: FIXME
+D: List blobs of an osl table matching 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:
+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@
-O: int com_rm@member@(int fd, int argc, char **argv);
+O: int com_rm@member@(int fd, int argc, char * const * const argv);
P: AFS_READ | AFS_WRITE
-D: FIXME
-U: rm@member@ @member@_name
-H: FIXME
+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.
---
T: mv
N: mv@member@
-O: int com_mv@member@(int fd, int argc, char **argv);
+O: int com_mv@member@(int fd, int argc, char * const * const argv);
P: AFS_READ | AFS_WRITE
-D: FIXME
+D: Rename a blob.
U: mv@member@ old_@member@_name new_@member@_name
-H: FIXME
+H: Rename the blob identified by the first name as the second name.
projects / paraslash.git / blobdiff