Introduce new syntax for com_ls().
[paraslash.git] / afs.cmd
1 BN: afs
2 SF: afs.c aft.c attribute.c
3 SN: list of afs commands
4 TM: mood lyr img pl
5 ---
6 N: add
8 D: Add or update audio files.
9 U: add [-a] [-l] [-f] [-v] path...
10 H: Each path must be absolute and refer to either an audio file, or a
11 H: directory. In case of a directory, all audio files in that directory
12 H: are added recursively. Only absolute paths are accepted.
13 H:
14 H: Options:
15 H:
16 H: -a Add all files. The default is to add only files ending in a
17 H: known suffix for a supported audio format.
18 H:
19 H: -l Add files lazily. If the path already exists in the
20 H: database, skip this file. This operation is really cheap. Useful
21 H: to update large directories after some files have been added or
22 H: deleted.
23 H:
24 H: -f Force adding/updating. Recompute the audio format handler data
25 H: even if a file with the same path and the same hash value exists.
26 H:
27 H: -v Verbose mode. Print what is being done.
28 ---
29 N: init
31 D: Initialize the osl tables for the audio file selector.
32 U: init [table_name ...]
33 H: When invoked without arguments, this command creates all tables. Otherwise
34 H: only the tables given by table_name... are created.
35 ---
36 N: ls
38 D: List audio files.
39 U: ls [-l=mode] [-p] [-a] [-r] [-d] [-s=order] [pattern...]
40 H: Print a list of all audio files matching pattern.
41 H:
42 H: Options:
43 H:
44 H: -l=mode Change listing mode. Defaults to short listing if not given.
45 H:
46 H: Available modes:
47 H: s: short listing mode
48 H: l: long listing mode (equivalent to -l)
49 H: v: verbose listing mode
50 H: p: parser-friendly mode
51 H: m: mbox listing mode
52 H: c: chunk-table listing mode
53 H:
54 H: -p List full paths. If this option is not specified, only the basename
55 H: of each file is printed.
56 H:
57 H: -a List only files that are admissible with respect to the current mood or
58 H: playlist.
59 H:
60 H: -r Reverse sort order.
61 H:
62 H: -d Print dates as seconds after the epoch.
63 H:
64 H: -s=order Change sort order. Defaults to alphabetical path sort if not given.
65 H:
66 H: Possible values for order:
67 H: p: by path
68 H: l: by last played time
69 H: s: by score (implies -a)
70 H: n: by num played count
71 H: f: by frequency
72 H: c: by number of channels
73 H: i: by image id
74 H: y: by lyrics id
75 H: b: by bit rate
76 H: d: by duration
77 H: a: by audio format
78 ---
79 N: lsatt
81 D: List attributes.
82 U: lsatt [-i] [-l] [-r] [pattern]
83 H: Print the list of all defined attributes which match the given
84 H: pattern. If no pattern is given, the full list is printed.
85 H:
86 H: Options:
87 H:
88 H: -i Sort attributes by id. The default is to sort alphabetically by name.
89 H:
90 H: -l Print a long listing containing both identifier and attribute name. The
91 H: default is to print only the name.
92 H:
93 H: -r Reverse sort order.
94 ---
95 N: setatt
97 D: Set attribute(s) for all files matching a pattern.
98 U: setatt attribute{+|-}... pattern
99 H: Set ('+') or unset ('-') the given attributes for all audio files matching
100 H: pattern. Example:
101 H:
102 H: setatt rock+ punk+ pop- '*foo.mp3'
103 H:
104 H: sets the 'rock' and the 'punk' attribute and unsets the 'pop'
105 H: attribute of all files ending with 'foo.mp3'.
106 ---
107 N: addatt
109 D: Add new attribute(s).
110 U: addatt attribute1...
111 H: This adds new attributes to the attribute table. At most 64
112 H: attributes may be defined.
113 ---
114 N: mvatt
116 D: Rename an attribute.
117 U: mvatt old new
118 H: Rename attribute old to new.
119 ---
120 N: check
122 D: Run integrity checks against osl tables.
123 U: check [-a] [-m] [-p]
124 H: Check the audio file table, the mood definitions and all
125 H: defined playlists and report any inconsistencies found.
126 H:
127 H: Options:
128 H:
129 H: -a Run audio file table checks. Checks for entries in the audio file
130 H: table which are not present in the file system. Moreover, it checks
131 H: whether the lyrics id and all entries in the audio file table are
132 H: valid.
133 H:
134 H: -m Run syntax checks on all defined moods in the mood table.
135 H:
136 H: -p Check all playlists for lines that correspond to files not contained
137 H: in the audio file table.
138 H:
139 H: If called without arguments, all three checks are run.
140 ---
141 N: rmatt
143 D: Remove attribute(s).
144 U: rmatt pattern...
145 H: Remove all attributes matching any given pattern. All information
146 H: about this attribute in the audio file table is lost.
147 ---
148 N: rm
150 D: Remove entries from the audio file table.
151 U: rm [-v] [-f] [-p] pattern...
152 H: Delete all entries in the audio file table that match any given pattern. Note
153 H: that this affects the table entries only; the command won't touch your audio
154 H: files on disk.
155 H:
156 H: Options:
157 H:
158 H: -v Verbose mode. Explain what is being done.
159 H:
160 H: -f Force mode. Ignore nonexistent files. Don't complain if nothing
161 H: was removed.
162 H:
163 H: -p Pathname match. Match a slash in the path only with a slash
164 H: in pattern and not by an asterisk (*) or a question mark
165 H: (?) metacharacter, nor by a bracket expression ([]) containing
166 H: a slash (see fnmatch(3)).
167 ---
168 N: touch
170 D: Manipulate the afs entry of audio files.
171 U: touch [-n=numplayed] [-l=lastplayed] [-y=lyrics_id] [-i=image_id] [-a=amp] [-v] [-p] pattern
172 H: If no option is given, the lastplayed field is set to the current time
173 H: and the value of the numplayed field is increased by one. Otherwise,
174 H: only the given options are taken into account.
175 H:
176 H: Options:
177 H:
178 H: -n Set the numplayed count, i.e. the number of times this audio
179 H: file was selected for streaming so far.
180 H:
181 H: -l Set the lastplayed time, i.e. the last time this audio file was
182 H: selected for streaming. The argument must be a number of seconds
183 H: since the epoch. Example:
184 H:
185 H: touch -l=$(date +%s) file
186 H:
187 H: sets the lastplayed time of 'file' to the current time.
188 H:
189 H: -y Set the lyrics ID which specifies the lyrics data file associated
190 H: with the audio file.
191 H:
192 H: -i Like -y, but sets the image ID.
193 H:
194 H: -a Set the amplification value (0-255). This determines a scaling
195 H: factor by which the amplitude should be multiplied in order to
196 H: normalize the volume of the audio file. A value of zero means
197 H: no amplification, 64 means the amplitude should be multiplied
198 H: by a factor of two, 128 by three and so on.
199 H:
200 H: This value is used by the amp filter.
201 H:
202 H: -v Verbose mode. Explain what is being done.
203 H:
204 H: -p Pathname match. Match a slash in the path only with a slash
205 H: in pattern and not by an asterisk (*) or a question mark
206 H: (?) metacharacter, nor by a bracket expression ([]) containing
207 H: a slash (see fnmatch(3)).
208 ---
209 N: cpsi
211 D: Copy audio file selector info.
212 U: cpsi [-a] [-y] [-i] [-l] [-n] [-v] source pattern...
213 H: If no option, or only the -v option is given, all fields of the
214 H: audio file selector info are copied to all files matching pattern.
215 H: Otherwise, only the given options are taken into account.
216 H:
217 H: Options:
218 H:
219 H: -a Copy attributes.
220 H:
221 H: -y Copy the lyrics id.
222 H:
223 H: -i Copy the image id.
224 H:
225 H: -l Copy the lastplayed time.
226 H:
227 H: -n Copy the numplayed count.
228 H:
229 H: -v Verbose mode.
230 ---
231 N: select
233 D: Activate a mood or a playlist.
234 U: select specifier/name
235 H: The specifier is either 'm' or 'p' to indicate whether a playlist or
236 H: a mood should be activated. Example:
237 H:
238 H: select m/foo
239 H:
240 H: loads the mood named 'foo'.
241 ---
242 T: add
243 N: add@member@
244 O: int com_add@member@(struct command_context *cc);
246 D: Add stdin as a blob to the @member@ table.
247 U: add@member@ @member@_name
248 H: Read from stdin and ask the audio file selector to create a blob in the
249 H: corresponding osl table. If the named blob already exists, it gets replaced
250 H: with the new data.
251 ---
252 T: cat
253 N: cat@member@
254 O: int com_cat@member@(struct command_context *cc);
256 D: Dump the contents of a blob of type @member@ to stdout.
257 U: cat@member@ @member@_name
258 H: Retrieve the named blob and write it to stdout.
259 ---
260 T: ls
261 N: ls@member@
262 O: int com_ls@member@(struct command_context *cc);
264 D: List blobs of type @member@ which match a pattern.
265 U: ls@member@ [-i] [-l] [-r] [pattern]
266 H: Print the list of all blobs which match the given pattern. If no
267 H: pattern is given, the full list is printed.
268 H:
269 H: Options:
270 H:
271 H: -i Sort by identifier. The default is to sort alphabetically by name.
272 H:
273 H: -l Print identifier and name. The default is to print only the name.
274 H:
275 H: -r Reverse sort order.
276 ---
277 T: rm
278 N: rm@member@
279 O: int com_rm@member@(struct command_context *cc);
281 D: Remove blob(s) of type @member@ from the @member@ table.
282 U: rm@member@ pattern...
283 H: Remove all blobs whose name matches any of the given patterns.
284 ---
285 T: mv
286 N: mv@member@
287 O: int com_mv@member@(struct command_context *cc);
289 D: Rename a blob of type @member@.
290 U: mv@member@ old_@member@_name new_@member@_name
291 H: Rename the blob identified by old_@member@_name to new_@member@_name.
292 H: This command fails if new_@member@_name already exists.