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.
7 IN: para error crypt command string afh afs server list user_list
8 SN: list of afs commands
12 P: AFS_READ | AFS_WRITE
13 D: Add new audio files to the database.
14 U: add [-l] [-f] [-v] path...
15 H: Each given path may be either the full path to an audio
16 H: file, or the full path of a directory. In case of a
17 H: directory, all audio files in that directory are added
18 H: recursively. Only absolute paths are accepted.
22 H: -a Add all files. The default is to add only files ending in a
23 H: known suffix for a supported audio format.
25 H: -l Add files lazily. If the path already exists in the
26 H: database, skip this file. This operation is really cheap.
27 H: Use it when adding large directories if only a few files
30 H:-f Force adding/updating. Recompute the audio format handler data
31 H: even if a file with the same path and the same hash value exists.
33 H: -v Verbose mode. Print what is being done.
36 P: AFS_READ | AFS_WRITE
37 D: Initialize the osl tables for the audio file selector.
38 U: init [table_name ...]
39 H: When invoked without arguments, this command creates all tables. Otherwise
40 H: only the tables given by table_name... are created.
45 U: ls [-l[s|l|v|m]] [-p] [-a] [-r] [-d] [-s{p|s|l|n|f|c|i|y|b|d|a}] [pattern...]
46 H: Print a list of all audio files matching pattern.
50 H: -l Change listing mode. Defaults to short listing if not given.
52 H: -ls: short listing mode
54 H: -ll: long listing mode (equivalent to -l)
56 H: -lv: verbose listing mode
58 H: -lp: parser-friendly mode
60 H: -lm: mbox listing mode
62 H: -lc: chunk-table listing mode
64 H: -p List full path of audio file. If not specified, only the basename
65 H: of each file is printed.
67 H: -a List only files that are admissible with respect to the current mood or
70 H: -r Reverse sort order.
72 H: -d Print dates as seconds after the epoch.
74 H: -s Change sort order. Defaults to alphabetical path sort if not given.
78 H: -sl: sort by last played time.
80 H: -ss: sort by score (implies -a).
82 H: -sn: sort by num played count.
84 H: -sf: sort by frequency.
86 H: -sc: sort by number of channels.
88 H: -si: sort by image id.
90 H: -sy: sort by lyrics id.
92 H: -sb: sort by bit rate.
94 H: -sd: sort by duration.
96 H: -sa: sort by audio format.
101 U: lsatt [-i] [-l] [-r] [pattern]
102 H: Print the list of all defined attributes which match the
103 H: given pattern. If no pattern is given, the full list is
108 H: -i Sort attributes by id. The default is to sort alphabetically by name.
110 H: -l Print a long listing containing both identifier and attribute name. The
111 H: default is to print only the name.
113 H: -r Reverse sort order.
116 P: AFS_READ | AFS_WRITE
117 D: Set attribute(s) for all files matching a pattern.
118 U: setatt attribute{+|-}... pattern
119 H: Set ('+') or unset ('-') the given attributes for all audio files matching
122 H: setatt rock+ punk+ classic- '*foo.mp3'
124 H: sets the 'rock' and the 'punk' attribute but unsets the 'classic'
125 H: attribute of all files ending with 'foo.mp3'.
128 P: AFS_READ | AFS_WRITE
129 D: Add new attribute(s).
130 U: addatt attribute1...
131 H: This adds new attributes to the attribute table. At most 64
132 H: attributes may be defined.
135 P: AFS_READ | AFS_WRITE
136 D: Rename an attribute.
138 H: Rename attribute old to new.
142 D: Run integrity checks against osl tables.
143 U: check [-a] [-m] [-p]
144 H: Check the audio file table, the mood definitions and all
145 H: defined playlists and report any inconsistencies found.
149 H: -a Run audio file table checks. Checks for entries in the audio file
150 H: table which are not present in the file system. Moreover, it checks
151 H: whether the lyrics id and all entries in the audio file table are
154 H: -m Run syntax checks on all defined moods in the mood table.
156 H: -p Check all playlists for lines that correspond to files not contained
157 H: in the audio file table.
159 H: If called without arguments, all three checks are run.
162 P: AFS_READ | AFS_WRITE
163 D: Remove attribute(s).
165 H: Remove all attributes matching any given pattern. All information
166 H: about this attribute in the audio file table is lost.
169 P: AFS_READ | AFS_WRITE
170 D: Remove entries from the audio file table.
171 U: rm [-v] [-f] [-p] pattern...
172 H: Delete all entries in the audio file table that match any given pattern.
173 H: Note that affects the table entries only; paraslash won't touch your
174 H: audio files in any way.
177 H: -v Verbose mode. Explain what is being done.
179 H: -f Force mode. Ignore nonexistent files. Don't complain if nothing
182 H: -p Pathname match. Match a slash in the path only with a slash
183 H: in pattern and not by an asterisk (*) or a question mark
184 H: (?) metacharacter, nor by a bracket expression ([]) containing
185 H: a slash (see fnmatch(3)).
188 P: AFS_READ | AFS_WRITE
189 D: Manipulate the afs data for all audio files matching a pattern.
190 U: touch [-n=numplayed] [-l=lastplayed] [-y=lyrics_id] [-i=image_id] [-a=amp] [-v] [-p] pattern
191 H: If no option is given, lastplayed is set to the current time
192 H: and numplayed is increased by one. Otherwise, only the given
193 H: options are taken into account.
197 H: -n Set numplayed count. The number of times afs has selected this
198 H: audio file for streaming.
200 H: -l Set lastplayed time. The last time this audio file was selected.
201 H: Must be given as the number of seconds since the epoch. Example:
203 H: touch -l=$(date +%s) file
205 H: sets the lastplayed time of 'file' to the current time.
207 H: -y Set the lyrics id. Specify the lyrics data file associated with
210 H: -i Set the image id. Same as -y, but sets the image.
212 H: -a Set the amplification value (0-255). This determines a scaling
213 H: factor by which the amplitude should be multiplied in order to
214 H: normalize the volume of the audio file. A value of zero means
215 H: no amplification, 64 means the amplitude should be multiplied
216 H: by a factor of two, 128 by three and so on.
218 H: This value is used by the compress filter.
220 H: -v Verbose mode. Explain what is being done.
222 H: -p Pathname match. Match a slash in the path only with a slash
223 H: in pattern and not by an asterisk (*) or a question mark
224 H: (?) metacharacter, nor by a bracket expression ([]) containing
225 H: a slash (see fnmatch(3)).
228 P: AFS_READ | AFS_WRITE
229 D: Copy audio file selector info.
230 U: cpsi [-a] [-y] [-i] [-l] [-n] [-v] source pattern...
231 H: If no option, or only the -v option is given, all fields of
232 H: the audio file selector info are copied to all files
233 H: matching pattern. Otherwise, only the given options are
234 H: taken into account.
238 H: -a Copy attributes.
240 H: -y Copy the lyrics id.
242 H: -i Copy the image id.
244 H: -l Copy the lastplayed time.
246 H: -n Copy the numplayed count.
251 P: AFS_READ | AFS_WRITE
252 D: Activate a mood or a playlist.
253 U: select specifier/name
254 H: The specifier is either 'm' or 'p' to indicate whether a playlist or
255 H: a mood should be activated. Example:
259 H: loads the mood named 'foo'.
263 O: int com_add@member@(struct command_context *cc);
264 P: AFS_READ | AFS_WRITE
265 D: Read data from stdin and add it as a blob to the @member@ table.
266 U: add@member@ @member@_name
267 H: Read arbitrary binary data from stdin and send that data to
268 H: the audio file selector process which creates a new blob for
269 H: the data in the corresponding osl table.
271 H: The names of the blobs of a table are unique. If an entry with the
272 H: given name already exists, its contents are replaced by the new data.
276 O: int com_cat@member@(struct command_context *cc);
278 D: Dump the contents of a blob of type @member@ to stdout.
279 U: cat@member@ @member@_name
280 H: This command may be used to retrieve the blob identified by
281 H: the given name from the corresponding osl table to which
282 H: they were previously added.
286 O: int com_ls@member@(struct command_context *cc);
288 D: List blobs of type @member@ matching a pattern.
289 U: ls@member@ [-i] [-l] [-r] [pattern]
290 H: Print a list of the names of all blobs in the corresponding
291 H: osl table which match the given pattern. If no pattern is
292 H: given, the full list is printed.
296 H: -i Sort attributes by id. The default is to sort
297 H: alphabetically by name.
299 H: -l Print a long listing containing both identifier and
300 H: attribute name. The default is to print only the name.
302 H: -r Reverse sort order.
306 O: int com_rm@member@(struct command_context *cc);
307 P: AFS_READ | AFS_WRITE
308 D: Remove blob(s) of type @member@ from the @member@ table.
309 U: rm@member@ pattern...
310 H: Remove all blobs from the corresponding table which match
311 H: any given pattern.
315 O: int com_mv@member@(struct command_context *cc);
316 P: AFS_READ | AFS_WRITE
317 D: Rename a blob of type @member@.
318 U: mv@member@ old_@member@_name new_@member@_name
319 H: Rename the blob identified by the first name as the second name.