79cb84ee6554fb280ae21d19b7b548f79bfa87a3
[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 IN: para afh server list user_list
7 SN: list of afs commands
8 TM: mood lyr img pl
9 ---
10 N: add
11 P: AFS_READ | AFS_WRITE
12 D: Add new audio files to the database.
13 U: add [-l] [-f] [-v] path1 ...
14 H: Each given path may be either the full path to an audio file, or the full path
15 H: of a directory. In case of a directory, all audio files in that directory
16 H: are added recursivly.
17 H:
18 H: Options:
19 H:
20 H: -l Add files lazily. If a file already exists in the database, skip this file.
21 H: This operation is really cheap. Use it when adding large directories if only a
22 H: few files where added.
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
30 P: AFS_READ | AFS_WRITE
31 D: FIXME
32 U: FIXME
33 H: FIXME
34 ---
35 N: afs_ls
36 P: AFS_READ
37 D: List audio files.
38 U: ls [-l[s|l|v|m]] -p -a -r -s{p|s|l|n|f|c|i|y|b|d|a} [pattern ...]
39 H: Print a list of all audio files matching pattern.
40 H:
41 H: Options:
42 H: -l Change listing mode. Defaults to short listing if not given.
43 H: -ls: short listing mode
44 H: -ll: long listing mode (equivalent to -l)
45 H: -lv: verbose listing mode
46 H: -lm: mbox listing mode
47 H:
48 H: -p List full path of audio file. If not specified, only the basename
49 H: of each file is printed.
50 H:
51 H: -a List only file that are admissible with respect to the current mood or
52 H: playlist.
53 H:
54 H: -r Reverse sort order.
55 H:
56 H: -s Change sort order. Defaults to alphabetical path sort if not given.
57 H: -sp: sort by path.
58 H: -sl: sort by last played time.
59 H: -ss: sort by score (implies -a).
60 H: -sn: sort by number of times the file was played.
61 H: -sf: sort by frequency.
62 H: -sc: sort by number of channels.
63 H: -si: sort by image id.
64 H: -sy: sort by lyrics id.
65 H: -sb: sort by bitrate.
66 H: -sd: sort by duration.
67 H: -sa: sort by audio format.
68 ---
69 N: lsatt
70 P: AFS_READ
71 D: List attributes
72 U: lsatt [-a] [-l]
73 H:
74 H: Print the list of all defined attributes.
75 H:
76 H: Options:
77 H: -a Sort attributes alphabetically by name. The default is to sort by attribute
78 H: identifier.
79 H:
80 H: -l Print a long listing containing both identifier and attribute name. The
81 H: default is to print only the name.
82 ---
83 N: setatt
84 P: AFS_READ | AFS_WRITE
85 D: FIXME
86 U: FIXME
87 H: FIXME
88 ---
89 N: addatt
90 P: AFS_READ | AFS_WRITE
91 D: FIXME
92 U: FIXME
93 H: FIXME
94 ---
95 N: rmatt
96 P: AFS_READ | AFS_WRITE
97 D: FIXME
98 U: FIXME
99 H: FIXME
100 ---
101 N: afs_rm
102 P: AFS_READ | AFS_WRITE
103 D: FIXME
104 U: FIXME
105 H: FIXME
106 ---
107 N: touch
108 P: AFS_READ | AFS_WRITE
109 D: FIXME
110 U: FIXME
111 H: FIXME
112 ---
113 T: cat
114 N: cat@member@
115 O: int com_cat@member@(int fd, int argc, char * const * const argv);
116 P: AFS_READ
117 D: FIXME
118 U: cat@member@ @member@_name
119 H: FIXME
120 ---
121 T: ls
122 N: ls@member@
123 O: int com_ls@member@(int fd, int argc, char * const * const argv);
124 P: AFS_READ
125 D: FIXME
126 U: cat@member@ <pattern>
127 H: FIXME
128 ---
129 T: rm
130 N: rm@member@
131 O: int com_rm@member@(int fd, int argc, char * const * const argv);
132 P: AFS_READ | AFS_WRITE
133 D: FIXME
134 U: rm@member@ @member@_name
135 H: FIXME
136 ---
137 T: mv
138 N: mv@member@
139 O: int com_mv@member@(int fd, int argc, char * const * const argv);
140 P: AFS_READ | AFS_WRITE
141 D: FIXME
142 U: mv@member@ old_@member@_name new_@member@_name
143 H: FIXME