2 SF: afs.c aft.c attribute.c
3 HC: Prototypes for the commands of the audio file selector.
4 CC: Array of commands for the audio file selector.
6 IN: para error string afh afs server list user_list
7 SN: list of afs commands
11 P: AFS_READ | AFS_WRITE
12 D: Add new audio files to the database.
13 U: add [-l] [-f] [-v] path...
14 H: Each given path may be either the full path to an audio
15 H: file, or the full path of a directory. In case of a
16 H: directory, all audio files in that directory are added
17 H: recursively. Only absolute paths are accepted.
21 H: -a Add all files. The default is to add only files ending in a
22 H: known suffix for a supported audio format.
24 H: -l Add files lazily. If the path already exists in the
25 H: database, skip this file. This operation is really cheap.
26 H: Use it when adding large directories if only a few files
29 H:-f Force adding/updating. Recompute the audio format handler data
30 H: even if a file with the same path and the same hash value exists.
32 H: -v Verbose mode. Print what is being done.
35 P: AFS_READ | AFS_WRITE
36 D: Initialize the osl tables for the audio file selector.
37 U: init [table_name ...]
38 H: When invoked without arguments, this command creates all tables. Otherwise
39 H: only the tables given by table_name... are created.
44 U: ls [-l[s|l|v|m]] -p -a -r -s{p|s|l|n|f|c|i|y|b|d|a} [pattern...]
45 H: Print a list of all audio files matching pattern.
49 H: -l Change listing mode. Defaults to short listing if not given.
51 H: -ls: short listing mode
53 H: -ll: long listing mode (equivalent to -l)
55 H: -lv: verbose listing mode
57 H: -lm: mbox listing mode
59 H: -p List full path of audio file. If not specified, only the basename
60 H: of each file is printed.
62 H: -a List only files that are admissible with respect to the current mood or
65 H: -r Reverse sort order.
67 H: -s Change sort order. Defaults to alphabetical path sort if not given.
71 H: -sl: sort by last played time.
73 H: -ss: sort by score (implies -a).
75 H: -sn: sort by num played count.
77 H: -sf: sort by frequency.
79 H: -sc: sort by number of channels.
81 H: -si: sort by image id.
83 H: -sy: sort by lyrics id.
85 H: -sb: sort by bit rate.
87 H: -sd: sort by duration.
89 H: -sa: sort by audio format.
94 U: lsatt [-i] [-l] [-r] [pattern]
95 H: Print the list of all defined attributes which match the
96 H: given pattern. If no pattern is given, the full list is
101 H: -i Sort attributes by id. The default is to sort alphabetically by name.
103 H: -l Print a long listing containing both identifier and attribute name. The
104 H: default is to print only the name.
106 H: -r Reverse sort order.
109 P: AFS_READ | AFS_WRITE
110 D: Set attribute(s) for all files matching a pattern.
111 U: setatt attribute{+|-}... pattern
112 H: Set ('+') or unset ('-') the given attributes for all audio files matching
115 H: setatt rock+ punk+ classic- '*foo.mp3'
117 H: sets the 'rock' and the 'punk' attribute but unsets the 'classic'
118 H: attribute of all files ending with 'foo.mp3'.
121 P: AFS_READ | AFS_WRITE
122 D: Add new attribute(s).
123 U: addatt attribute1...
124 H: This adds new attributes to the attribute table. At most 64
125 H: attributes may be defined.
128 P: AFS_READ | AFS_WRITE
129 D: Rename an attribute.
131 H: Rename attribute old to new.
135 D: Run integrity checks against osl tables.
136 U: check [-a] [-m] [-p]
137 H: Check the audio file table, the mood definitions and all
138 H: defined playlists and report any inconsistencies found.
142 H: -a Run audio file table checks. Checks for entries in the audio file
143 H: table which are not present in the file system. Moreover, it checks
144 H: whether the lyrics id and all entries in the audio file table are
147 H: -m Run syntax checks on all defined moods in the mood table.
149 H: -p Check all playlists for lines that correspond to files not contained
150 H: in the audio file table.
152 H: If called without arguments, all three checks are run.
155 P: AFS_READ | AFS_WRITE
156 D: Remove attribute(s).
158 H: Remove all attributes matching any given pattern. All information
159 H: about this attribute in the audio file table is lost.
162 P: AFS_READ | AFS_WRITE
163 D: Remove entries from the audio file table.
164 U: rm [-v] [-f] [-p] pattern...
165 H: Delete all entries in the audio file table that match any given pattern.
166 H: Note that affects the table entries only; paraslash won't touch your
167 H: audio files in any way.
170 H: -v Verbose mode. Explain what is being done.
172 H: -f Force mode. Ignore nonexistent files. Don't complain if nothing
175 H: -p Pathname match. Match a slash in the path only with a slash
176 H: in pattern and not by an asterisk (*) or a question mark
177 H: (?) metacharacter, nor by a bracket expression ([]) containing
178 H: a slash (see fnmatch(3)).
181 P: AFS_READ | AFS_WRITE
182 D: Manipulate the afs data for all audio files matching a pattern.
183 U: touch [-n numplayed] [-l lastplayed] [-y lyrics_id] [-i image_id] [-v] [-p] pattern
184 H: If no option is given, lastplayed is set to the current time
185 H: and numplayed is increased by one. Otherwise, only the given
186 H: options are taken into account.
190 H: -n Set numplayed count. The number of times afs has selected this
191 H: audio file for streaming.
193 H: -l Set lastplayed time. The last time this audio file was selected.
194 H: Must be given as the number of seconds since the epoch. Example:
196 H: touch -l $(date +%s) file
198 H: sets the lastplayed time of 'file' to the current time.
200 H: -y Set the lyrics id. Specify the lyrics data file associated with
203 H: -i Set the image id. Same as -y, but sets the image.
205 H: -v Verbose mode. Explain what is being done.
207 H: -p Pathname match. Match a slash in the path only with a slash
208 H: in pattern and not by an asterisk (*) or a question mark
209 H: (?) metacharacter, nor by a bracket expression ([]) containing
210 H: a slash (see fnmatch(3)).
213 P: AFS_READ | AFS_WRITE
214 D: Copy audio file selector info.
215 U: cpsi [-a] [-y] [-i] [-l] [-n] [-v] source pattern...
216 H: If no option, or only the -v option is given, all fields of
217 H: the audio file selector info are copied to all files
218 H: matching pattern. Otherwise, only the given options are
219 H: taken into account.
223 H: -a Copy attributes.
225 H: -y Copy the lyrics id.
227 H: -i Copy the image id.
229 H: -l Copy the lastplayed time.
231 H: -n Copy the numplayed count.
236 P: AFS_READ | AFS_WRITE
237 D: Activate a mood or a playlist.
238 U: select specifier:name
239 H: The specifier is either 'm' or 'p' to indicate whether a playlist or
240 H: a mood should be activated. Example:
244 H: loads the mood named 'foo'.
248 O: int com_add@member@(int fd, int argc, char * const * const argv);
249 P: AFS_READ | AFS_WRITE
250 D: Read data from stdin and add it as a blob to the @member@ table.
251 U: add@member@ @member@_name
252 H: Read arbitrary binary data from stdin and send that data to
253 H: the audio file selector process which creates a new blob for
254 H: the data in the corresponding osl table.
256 H: The names of the blobs of a table are unique. If an entry with the
257 H: given name already exists, its contents are replaced by the new data.
261 O: int com_cat@member@(int fd, int argc, char * const * const argv);
263 D: Dump the contents of a blob of type @member@ to stdout.
264 U: cat@member@ @member@_name
265 H: This command may be used to retrieve the blob identified by
266 H: the given name from the corresponding osl table to which
267 H: they were previously added.
271 O: int com_ls@member@(int fd, int argc, char * const * const argv);
273 D: List blobs of type @member@ matching a pattern.
274 U: ls@member@ [-i] [-l] [-r] [pattern]
275 H: Print a list of the names of all blobs in the corresponding
276 H: osl table which match the given pattern. If no pattern is
277 H: given, the full list is printed.
281 H: -i Sort attributes by id. The default is to sort
282 H: alphabetically by name.
284 H: -l Print a long listing containing both identifier and
285 H: attribute name. The default is to print only the name.
287 H: -r Reverse sort order.
291 O: int com_rm@member@(int fd, int argc, char * const * const argv);
292 P: AFS_READ | AFS_WRITE
293 D: Remove blob(s) of type @member@ from the @member@ table.
294 U: rm@member@ pattern...
295 H: Remove all blobs from the corresponding table which match
296 H: any given pattern.
300 O: int com_mv@member@(int fd, int argc, char * const * const argv);
301 P: AFS_READ | AFS_WRITE
302 D: Rename a blob of type @member@.
303 U: mv@member@ old_@member@_name new_@member@_name
304 H: Rename the blob identified by the first name as the second name.