server: Convert com_select() to lopsub.
[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: ls
7 P: AFS_READ
8 D: List audio files.
9 U: ls [-l=mode] [-p] [-a] [-r] [-d] [-s=order] [pattern...]
10 H: Print a list of all audio files matching pattern.
11 H:
12 H: Options:
13 H:
14 H: -l=mode Change listing mode. Defaults to short listing if not given.
15 H:
16 H: Available modes:
17 H: s: short listing mode
18 H: l: long listing mode (equivalent to -l)
19 H: v: verbose listing mode
20 H: p: parser-friendly mode
21 H: m: mbox listing mode
22 H: c: chunk-table listing mode
23 H:
24 H: -F List full paths. If this option is not specified, only the basename
25 H: of each file is printed.
26 H: -p Synonym for -F. Deprecated.
27 H:
28 H: -b Print only the basename of each matching file. This is the default, so
29 H: the option is currently a no-op. It is recommended to specify this option,
30 H: though, as the default might change in a future release.
31 H:
32 H: -a List only files that are admissible with respect to the current mood or
33 H: playlist.
34 H:
35 H: -r Reverse sort order.
36 H:
37 H: -d Print dates as seconds after the epoch.
38 H:
39 H: -s=order
40 H: Change sort order. Defaults to alphabetical path sort if not given.
41 H:
42 H: Possible values for order:
43 H: p: by path
44 H: l: by last played time
45 H: s: by score (implies -a)
46 H: n: by num played count
47 H: f: by frequency
48 H: c: by number of channels
49 H: i: by image id
50 H: y: by lyrics id
51 H: b: by bit rate
52 H: d: by duration
53 H: a: by audio format
54 ---
55 N: addatt
56 P: AFS_READ | AFS_WRITE
57 D: Add new attribute(s).
58 U: addatt attribute1...
59 H: This adds new attributes to the attribute table. At most 64
60 H: attributes may be defined.
61 ---
62 N: touch
63 P: AFS_READ | AFS_WRITE
64 D: Manipulate the afs entry of audio files.
65 U: touch [-n=numplayed] [-l=lastplayed] [-y=lyrics_id] [-i=image_id] [-a=amp] [-v] [-p] pattern
66 H: If no option is given, the lastplayed field is set to the current time
67 H: and the value of the numplayed field is increased by one. Otherwise,
68 H: only the given options are taken into account.
69 H:
70 H: Options:
71 H:
72 H: -n Set the numplayed count, i.e. the number of times this audio
73 H: file was selected for streaming so far.
74 H:
75 H: -l Set the lastplayed time, i.e. the last time this audio file was
76 H: selected for streaming. The argument must be a number of seconds
77 H: since the epoch. Example:
78 H:
79 H: touch -l=$(date +%s) file
80 H:
81 H: sets the lastplayed time of 'file' to the current time.
82 H:
83 H: -y Set the lyrics ID which specifies the lyrics data file associated
84 H: with the audio file.
85 H:
86 H: -i Like -y, but sets the image ID.
87 H:
88 H: -a Set the amplification value (0-255). This determines a scaling
89 H: factor by which the amplitude should be multiplied in order to
90 H: normalize the volume of the audio file. A value of zero means
91 H: no amplification, 64 means the amplitude should be multiplied
92 H: by a factor of two, 128 by three and so on.
93 H:
94 H: This value is used by the amp filter.
95 H:
96 H: -v Verbose mode. Explain what is being done.
97 H:
98 H: -p Pathname match. Match a slash in the path only with a slash
99 H: in pattern and not by an asterisk (*) or a question mark
100 H: (?) metacharacter, nor by a bracket expression ([]) containing
101 H: a slash (see fnmatch(3)).
102 ---
103 T: add
104 N: add@member@
105 O: int com_add@member@(struct command_context *cc);
106 P: AFS_READ | AFS_WRITE
107 D: Add stdin as a blob to the @member@ table.
108 U: add@member@ @member@_name
109 H: Read from stdin and ask the audio file selector to create a blob in the
110 H: corresponding osl table. If the named blob already exists, it gets replaced
111 H: with the new data.
112 ---
113 T: cat
114 N: cat@member@
115 O: int com_cat@member@(struct command_context *cc);
116 P: AFS_READ
117 D: Dump the contents of a blob of type @member@ to stdout.
118 U: cat@member@ @member@_name
119 H: Retrieve the named blob and write it to stdout.
120 ---
121 T: ls
122 N: ls@member@
123 O: int com_ls@member@(struct command_context *cc);
124 P: AFS_READ
125 D: List blobs of type @member@ which match a pattern.
126 U: ls@member@ [-i] [-l] [-r] [pattern]
127 H: Print the list of all blobs which match the given pattern. If no
128 H: pattern is given, the full list is printed.
129 H:
130 H: Options:
131 H:
132 H: -i Sort by identifier. The default is to sort alphabetically by name.
133 H:
134 H: -l Print identifier and name. The default is to print only the name.
135 H:
136 H: -r Reverse sort order.
137 ---
138 T: rm
139 N: rm@member@
140 O: int com_rm@member@(struct command_context *cc);
141 P: AFS_READ | AFS_WRITE
142 D: Remove blob(s) of type @member@ from the @member@ table.
143 U: rm@member@ pattern...
144 H: Remove all blobs whose name matches any of the given patterns.
145 ---
146 T: mv
147 N: mv@member@
148 O: int com_mv@member@(struct command_context *cc);
149 P: AFS_READ | AFS_WRITE
150 D: Rename a blob of type @member@.
151 U: mv@member@ source_@member@_name dest_@member@_name
152 H: Rename the blob identified by the source blob name to the destination blob
153 H: name. The command fails if the source does not exist, or if the destination
154 H: already exists.