3173404623ccd5768753bfe4773eb1eb6a834221
[paraslash.git] / afs.cmd
1 OF: afs_command_list
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.
5 AT: server_command
6 SI: openssl/rc4
7 IN: para error crypt command string afh afs server list user_list
8 SN: list of afs commands
9 TM: mood lyr img pl
10 ---
11 N: add
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.
19 H:
20 H: Options:
21 H:
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.
24 H:
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
28 H: where added.
29 H:
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.
32 H:
33 H: -v Verbose mode. Print what is being done.
34 ---
35 N: init
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.
41 ---
42 N: ls
43 P: AFS_READ
44 D: List audio files.
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.
47 H:
48 H: Options:
49 H:
50 H: -l Change listing mode. Defaults to short listing if not given.
51 H:
52 H: -ls: short listing mode
53 H:
54 H: -ll: long listing mode (equivalent to -l)
55 H:
56 H: -lv: verbose listing mode
57 H:
58 H: -lm: mbox listing mode
59 H:
60 H: -lc: chunk-table listing mode
61 H:
62 H: -p List full path of audio file. If not specified, only the basename
63 H: of each file is printed.
64 H:
65 H: -a List only files that are admissible with respect to the current mood or
66 H: playlist.
67 H:
68 H: -r Reverse sort order.
69 H:
70 H: -d Print dates as seconds after the epoch.
71 H:
72 H: -s Change sort order. Defaults to alphabetical path sort if not given.
73 H:
74 H: -sp: sort by path.
75 H:
76 H: -sl: sort by last played time.
77 H:
78 H: -ss: sort by score (implies -a).
79 H:
80 H: -sn: sort by num played count.
81 H:
82 H: -sf: sort by frequency.
83 H:
84 H: -sc: sort by number of channels.
85 H:
86 H: -si: sort by image id.
87 H:
88 H: -sy: sort by lyrics id.
89 H:
90 H: -sb: sort by bit rate.
91 H:
92 H: -sd: sort by duration.
93 H:
94 H: -sa: sort by audio format.
95 ---
96 N: lsatt
97 P: AFS_READ
98 D: List attributes.
99 U: lsatt [-i] [-l] [-r] [pattern]
100 H: Print the list of all defined attributes which match the
101 H: given pattern. If no pattern is given, the full list is
102 H: printed.
103 H:
104 H: Options:
105 H:
106 H: -i Sort attributes by id. The default is to sort alphabetically by name.
107 H:
108 H: -l Print a long listing containing both identifier and attribute name. The
109 H: default is to print only the name.
110 H:
111 H: -r Reverse sort order.
112 ---
113 N: setatt
114 P: AFS_READ | AFS_WRITE
115 D: Set attribute(s) for all files matching a pattern.
116 U: setatt attribute{+|-}... pattern
117 H: Set ('+') or unset ('-') the given attributes for all audio files matching
118 H: pattern. Example:
119 H:
120 H: setatt rock+ punk+ classic- '*foo.mp3'
121 H:
122 H: sets the 'rock' and the 'punk' attribute but unsets the 'classic'
123 H: attribute of all files ending with 'foo.mp3'.
124 ---
125 N: addatt
126 P: AFS_READ | AFS_WRITE
127 D: Add new attribute(s).
128 U: addatt attribute1...
129 H: This adds new attributes to the attribute table. At most 64
130 H: attributes may be defined.
131 ---
132 N: mvatt
133 P: AFS_READ | AFS_WRITE
134 D: Rename an attribute.
135 U: mvatt old new
136 H: Rename attribute old to new.
137 ---
138 N: check
139 P: AFS_READ
140 D: Run integrity checks against osl tables.
141 U: check [-a] [-m] [-p]
142 H: Check the audio file table, the mood definitions and all
143 H: defined playlists and report any inconsistencies found.
144 H:
145 H: Options:
146 H:
147 H: -a Run audio file table checks. Checks for entries in the audio file
148 H: table which are not present in the file system. Moreover, it checks
149 H: whether the lyrics id and all entries in the audio file table are
150 H: valid.
151 H:
152 H: -m Run syntax checks on all defined moods in the mood table.
153 H:
154 H: -p Check all playlists for lines that correspond to files not contained
155 H: in the audio file table.
156 H:
157 H: If called without arguments, all three checks are run.
158 ---
159 N: rmatt
160 P: AFS_READ | AFS_WRITE
161 D: Remove attribute(s).
162 U: rmatt pattern...
163 H: Remove all attributes matching any given pattern. All information
164 H: about this attribute in the audio file table is lost.
165 ---
166 N: rm
167 P: AFS_READ | AFS_WRITE
168 D: Remove entries from the audio file table.
169 U: rm [-v] [-f] [-p] pattern...
170 H: Delete all entries in the audio file table that match any given pattern.
171 H: Note that affects the table entries only; paraslash won't touch your
172 H: audio files in any way.
173 H: Options:
174 H:
175 H: -v Verbose mode. Explain what is being done.
176 H:
177 H: -f Force mode. Ignore nonexistent files. Don't complain if nothing
178 H: was removed.
179 H:
180 H: -p Pathname match. Match a slash in the path only with a slash
181 H: in pattern and not by an asterisk (*) or a question mark
182 H: (?) metacharacter, nor by a bracket expression ([]) containing
183 H: a slash (see fnmatch(3)).
184 ---
185 N: touch
186 P: AFS_READ | AFS_WRITE
187 D: Manipulate the afs data for all audio files matching a pattern.
188 U: touch [-n numplayed] [-l lastplayed] [-y lyrics_id] [-i image_id] [-a amp] [-v] [-p] pattern
189 H: If no option is given, lastplayed is set to the current time
190 H: and numplayed is increased by one. Otherwise, only the given
191 H: options are taken into account.
192 H:
193 H: Options:
194 H:
195 H: -n Set numplayed count. The number of times afs has selected this
196 H: audio file for streaming.
197 H:
198 H: -l Set lastplayed time. The last time this audio file was selected.
199 H: Must be given as the number of seconds since the epoch. Example:
200 H:
201 H: touch -l $(date +%s) file
202 H:
203 H: sets the lastplayed time of 'file' to the current time.
204 H:
205 H: -y Set the lyrics id. Specify the lyrics data file associated with
206 H: this audio file.
207 H:
208 H: -i Set the image id. Same as -y, but sets the image.
209 H:
210 H: -a Set the amplification value (0-255). This determines a scaling
211 H: factor by which the amplitude should be multiplied in order to
212 H: normalize the volume of the audio file. A value of zero means
213 H: no amplification, 64 means the amplitude should be multiplied
214 H: by a factor of two, 128 by three and so on.
215 H:
216 H: This value is used by the compress filter.
217 H:
218 H: -v Verbose mode. Explain what is being done.
219 H:
220 H: -p Pathname match. Match a slash in the path only with a slash
221 H: in pattern and not by an asterisk (*) or a question mark
222 H: (?) metacharacter, nor by a bracket expression ([]) containing
223 H: a slash (see fnmatch(3)).
224 ---
225 N: cpsi
226 P: AFS_READ | AFS_WRITE
227 D: Copy audio file selector info.
228 U: cpsi [-a] [-y] [-i] [-l] [-n] [-v] source pattern...
229 H: If no option, or only the -v option is given, all fields of
230 H: the audio file selector info are copied to all files
231 H: matching pattern. Otherwise, only the given options are
232 H: taken into account.
233 H:
234 H: Options:
235 H:
236 H: -a Copy attributes.
237 H:
238 H: -y Copy the lyrics id.
239 H:
240 H: -i Copy the image id.
241 H:
242 H: -l Copy the lastplayed time.
243 H:
244 H: -n Copy the numplayed count.
245 H:
246 H: -v Verbose mode.
247 ---
248 N: select
249 P: AFS_READ | AFS_WRITE
250 D: Activate a mood or a playlist.
251 U: select specifier/name
252 H: The specifier is either 'm' or 'p' to indicate whether a playlist or
253 H: a mood should be activated. Example:
254 H:
255 H: select m/foo
256 H:
257 H: loads the mood named 'foo'.
258 ---
259 T: add
260 N: add@member@
261 O: int com_add@member@(struct rc4_context *rc4c, int argc, char * const * const argv);
262 P: AFS_READ | AFS_WRITE
263 D: Read data from stdin and add it as a blob to the @member@ table.
264 U: add@member@ @member@_name
265 H: Read arbitrary binary data from stdin and send that data to
266 H: the audio file selector process which creates a new blob for
267 H: the data in the corresponding osl table.
268 H:
269 H: The names of the blobs of a table are unique. If an entry with the
270 H: given name already exists, its contents are replaced by the new data.
271 ---
272 T: cat
273 N: cat@member@
274 O: int com_cat@member@(struct rc4_context *rc4c, int argc, char * const * const argv);
275 P: AFS_READ
276 D: Dump the contents of a blob of type @member@ to stdout.
277 U: cat@member@ @member@_name
278 H: This command may be used to retrieve the blob identified by
279 H: the given name from the corresponding osl table to which
280 H: they were previously added.
281 ---
282 T: ls
283 N: ls@member@
284 O: int com_ls@member@(struct rc4_context *rc4c, int argc, char * const * const argv);
285 P: AFS_READ
286 D: List blobs of type @member@ matching a pattern.
287 U: ls@member@ [-i] [-l] [-r] [pattern]
288 H: Print a list of the names of all blobs in the corresponding
289 H: osl table which match the given pattern. If no pattern is
290 H: given, the full list is printed.
291 H:
292 H: Options:
293 H:
294 H: -i Sort attributes by id. The default is to sort
295 H: alphabetically by name.
296 H:
297 H: -l Print a long listing containing both identifier and
298 H: attribute name. The default is to print only the name.
299 H:
300 H: -r Reverse sort order.
301 ---
302 T: rm
303 N: rm@member@
304 O: int com_rm@member@(struct rc4_context *rc4c, int argc, char * const * const argv);
305 P: AFS_READ | AFS_WRITE
306 D: Remove blob(s) of type @member@ from the @member@ table.
307 U: rm@member@ pattern...
308 H: Remove all blobs from the corresponding table which match
309 H: any given pattern.
310 ---
311 T: mv
312 N: mv@member@
313 O: int com_mv@member@(struct rc4_context *rc4c, int argc, char * const * const argv);
314 P: AFS_READ | AFS_WRITE
315 D: Rename a blob of type @member@.
316 U: mv@member@ old_@member@_name new_@member@_name
317 H: Rename the blob identified by the first name as the second name.