chiark / gitweb /
note playlist-get error response
[disorder] / doc /
1 .\"
2 .\" Copyright (C) 2004-2008 Richard Kettlewell
3 .\"
4 .\" This program is free software: you can redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License as published by
6 .\" the Free Software Foundation, either version 3 of the License, or
7 .\" (at your option) any later version.
8 .\" 
9 .\" This program is distributed in the hope that it will be useful,
10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
12 .\" GNU General Public License for more details.
13 .\" 
14 .\" You should have received a copy of the GNU General Public License
15 .\" along with this program.  If not, see <>.
16 .\"
17 .TH disorder_protocol 5
19 disorder_protocol \- DisOrder communication protocol
21 The DisOrder client and server communicate via the protocol described
22 in this man page.
23 .PP
24 The protocol is liable to change without notice.
25 You are recommended to check the implementation before believing this document.
27 Everything is encoded using UTF-8.
28 See
30 below for more detail on character encoding issues.
31 .PP
32 Commands and responses consist of a line perhaps followed (depending on the
33 command or response) by a body.
34 .PP
35 The line syntax is the same as described in \fBdisorder_config\fR(5) except
36 that comments are prohibited.
37 .PP
38 Bodies borrow their syntax from RFC821; they consist of zero or more ordinary
39 lines, with any initial full stop doubled up, and are terminated by a line
40 consisting of a full stop and a line feed.
41 .PP
42 Commands only have a body if explicitly stated below.
43 If they do have a body then the body should always be sent immediately;
44 unlike (for instance) the SMTP "DATA" command there is no intermediate step
45 where the server asks for the body to be sent.
46 .PP
47 Replies also only have a body if stated below.
48 The presence of a reply body can always be inferred from the response code;
49 if the last digit is a 3 then a body is present, otherwise it is not.
51 Commands always have a command name as the first field of the line; responses
52 always have a 3-digit response code as the first field.
53 See below for more details about this field.
54 .PP
55 All commands require the connection to have been already authenticated unless
56 stated otherwise.
57 If not stated otherwise, the \fBread\fR right is sufficient to execute
58 the command.
59 .TP
61 Create a new user with the given username and password.
62 The new user's rights list can be specified; if it is not
63 then the \fBdefault_rights\fR setting applies instead.
64 Requires the \fBadmin\fR right, and only works on local
65 connections.
66 .TP
67 .B adopt \fIID\fR
68 Adopts a randomly picked track, leaving it in a similar state to if it was
69 picked by this user.  Requires the \fBplay\fR right.
70 .TP
71 .B allfiles \fIDIRECTORY\fR [\fIREGEXP\fR]
72 List all the files and directories in \fIDIRECTORY\fR in a response body.
73 If \fIREGEXP\fR is present only matching files and directories are returned.
74 .TP
75 .B confirm \fICONFIRMATION
76 Confirm user registration.
77 \fICONFIRMATION\fR is as returned from \fBregister\fR below.
78 This command can be used without logging in.
79 .TP
80 .B cookie \fICOOKIE
81 Log a user back in using a cookie created with \fBmake\-cookie\fR.
82 The response contains the username.
83 .TP
84 .B deluser \fIUSERNAME
85 Delete the named user.
86 Requires the \fBadmin\fR right, and only works on local connections.
87 .TP
88 .B dirs \fIDIRECTORY\fR [\fIREGEXP\fR]
89 List all the directories in \fIDIRECTORY\fR in a response body.
90 If \fIREGEXP\fR is present only matching directories are returned.
91 .TP
92 .B disable \fR[\fBnow\fR]
93 Disable further playing.
94 If the optional \fBnow\fR argument is present then the current track
95 is stopped.
96 Requires the \fBglobal prefs\fR right.
97 .TP
99 Set a user property.
100 With the \fBadmin\fR right any username and property may be specified.
101 Otherwise the \fBuserinfo\fR right is required and only the
102 \fBemail\fR and \fBpassword\fR properties may be set.
103 .IP
104 User properties are syntax-checked before setting.  For instance \fBemail\fR
105 must contain an "@" sign or you will get an error.  (Setting an empty value for
106 \fBemail\fR is allowed and removes the property.)
107 .TP
108 .B enable
109 Re-enable further playing, and is the opposite of \fBdisable\fR.
110 Requires the \fBglobal prefs\fR right.
111 .TP
112 .B enabled
113 Report whether playing is enabled.
114 The second field of the response line will be \fByes\fR or \fBno\fR.
115 .TP
116 .B exists \fITRACK\fR
117 Report whether the named track exists.
118 The second field of the response line will be \fByes\fR or \fBno\fR.
119 .TP
120 .B files \fIDIRECTORY\fR [\fIREGEXP\fR]
121 List all the files in \fIDIRECTORY\fR in a response body.
122 If \fIREGEXP\fR is present only matching files are returned.
123 .TP
124 .B get \fITRACK\fR \fIPREF\fR
125 Getsa preference value.
126 On success the second field of the response line will have the value.
127 .IP
128 If the track or preference do not exist then the response code is 555.
129 .TP
130 .B get\-global \fIKEY\fR
131 Get a global preference.
132 .IP
133 If the preference does not exist then the response code is 555.
134 .TP
135 .B length \fITRACK\fR
136 Get the length of the track in seconds.
137 On success the second field of the response line will have the value.
138 .TP
139 .B log
140 Send event log messages in a response body.
141 The command will never terminate.
142 Any further data sent to the server will be discarded (explicitly;
143 i.e. it will not accumulate in a buffer somewhere).
144 .IP
145 See \fBEVENT LOG\fR below for more details.
146 .TP
147 .B make\-cookie
148 Returns an opaque string that can be used by the \fBcookie\fR command to log
149 this user back in on another connection (until the cookie expires).
150 .TP
151 .B move \fITRACK\fR \fIDELTA\fR
152 Move a track in the queue.
153 The track may be identified by ID (preferred) or name (which might cause
154 confusion if it's there twice).
155 \fIDELTA\fR should be an negative or positive integer and indicates how
156 many steps towards the head of the queue the track should be moved.
157 .IP
158 Requires one of the \fBmove mine\fR, \fBmove random\fR or \fBmove any\fR rights
159 depending on how the track came to be added to the queue.
160 .TP
161 .B moveafter \fITARGET\fR \fIID\fR ...
162 Move all the tracks in the \fIID\fR list after ID \fITARGET\fR.
163 If \fITARGET\fR is the empty string then the listed tracks are put
164 at the head of the queue.
165 If \fITARGET\fR is listed in the ID list then the tracks are moved
166 to just after the first non-listed track before it, or to the head if there is
167 no such track.
168 .IP
169 Requires one of the \fBmove mine\fR, \fBmove random\fR or \fBmove any\fR rights
170 depending on how the tracks came to be added to the queue.
171 .TP
172 .B new \fR[\fIMAX\fR]
173 Send the most recently added \fIMAX\fR tracks in a response body.
174 If the argument is ommitted, the \fBnew_max\fR most recent tracks are
175 listed (see \fBdisorder_config\fR(5)).
176 .TP
177 .B nop
178 Do nothing.
179 Used by
180 .BR disobedience (1)
181 as a keepalive measure.
182 This command does not require authentication.
183 .TP
184 .B part \fITRACK\fR \fICONTEXT\fI \fIPART\fR
185 Get a track name part.
186 Returns an empty string if a name part cannot be constructed.
187 .IP
189 is one of
190 .B sort
191 or
192 .B display
193 and
194 .I PART
195 is usually one of
196 .BR artist ,
197 .B album
198 or
199 .BR title .
200 .TP
201 .B pause
202 Pause the current track.
203 Requires the \fBpause\fR right.
204 .TP
205 .B play \fITRACK\fR
206 Add a track to the queue.
207 The response contains the queue ID of the track.
208 Requires the \fBplay\fR right.
209 .TP
210 .B playafter \fITARGET\fR \fITRACK\fR ...
211 Add all the tracks in the \fITRACK\fR list to the queue after \fITARGET\fR
212 (which should be a track ID).
213 If \fITARGET\fR is the empty string then the listed tracks are put
214 at the head of the queue.
215 .IP
216 Currently the success result does \fInot\fR include the new track IDs.
217 .IP
218 Requires the \fBplay\fR right.
219 .TP
220 .B playing
221 Report what track is playing.
222 .IP
223 If the response is \fB252\fR then the rest of the response line consists of
224 track information (see below).
225 .IP
226 If the response is \fB259\fR then nothing is playing.
227 .TP
228 .B playlist-delete \fIPLAYLIST\fR
229 Delete a playlist.
230 Requires permission to modify that playlist and the \fBplay\fR right.
231 .TP
232 .B playlist-get \fIPLAYLIST\fR
233 Get the contents of a playlist, in a response body.
234 Requires permission to read that playlist and the \fBread\fR right.
235 If the playlist does not exist the response is 555.
236 .TP
237 .B playlist-get-share \fIPLAYLIST\fR
238 Get the sharing status of a playlist.
239 The result will be \fBpublic\fR, \fBprivate\fR or \fBshared\fR.
240 Requires permission to read that playlist and the \fBread\fR right.
241 .TP
242 .B playlist-lock \fIPLAYLIST\fR
243 Lock a playlist.
244 Requires permission to modify that playlist and the \fBplay\fR right.
245 Only one playlist may be locked at a time on a given connection and the lock
246 automatically expires when the connection is closed.
247 .TP
248 .B playlist-set \fIPLAYLIST\fR
249 Set the contents of a playlist.
250 The new contents should be supplied in a command body.
251 Requires permission to modify that playlist and the \fBplay\fR right.
252 The playlist must be locked.
253 .TP
254 .B playlist-set-share \fIPLAYLIST\fR \fISHARE\fR
255 Set the sharing status of a playlist to
256 \fBpublic\fR, \fBprivate\fR or \fBshared\fR.
257 Requires permission to modify that playlist and the \fBplay\fR right.
258 .TP
259 .B playlist-unlock\fR
260 Unlock the locked playlist.
261 .TP
262 .B playlists
263 List all playlists that this connection has permission to read.
264 Requires the \fBread\fR right.
265 .TP
266 .B prefs \fBTRACK\fR
267 Send back the preferences for \fITRACK\fR in a response body.
268 Each line of the response has the usual line syntax, the first field being the
269 name of the pref and the second the value.
270 .TP
271 .B queue
272 Send back the current queue in a response body, one track to a line, the track
273 at the head of the queue (i.e. next to be be played) first.
274 See below for the track information syntax.
275 .TP
276 .B random\-disable
277 Disable random play (but don't stop the current track).
278 Requires the \fBglobal prefs\fR right.
279 .TP
280 .B random\-enable
281 Enable random play.
282 Requires the \fBglobal prefs\fR right.
283 .TP
284 .B random\-enabled
285 Report whether random play is enabled.
286 The second field of the response line will be \fByes\fR or \fBno\fR.
287 .TP
288 .B recent
289 Send back the current recently-played list in a response body, one track to a
290 line, the track most recently played last.
291 See below for the track information syntax.
292 .TP
293 .B reconfigure
294 Request that DisOrder reconfigure itself.
295 Requires the \fBadmin\fR right.
296 .IP
297 Not all configuration options can be modified during the lifetime of the
298 server; of those that can't, some will just be ignored if they change while
299 others will cause the new configuration to be rejected.
300 See \fBdisorder_config\fR(5) for details.
301 .TP
303 Register a new user.
304 Requires the \fBregister\fR right.
305 The result contains a confirmation string; the user will be be able
306 to log in until this has been presented back to the server via the
307 \fBconfirm\fR command.
308 .TP
309 .B reminder \fIUSERNAME\fR
310 Send a password reminder to user \fIUSERNAME\fR.
311 If the user has no valid email address, or no password, or a
312 reminder has been sent too recently, then no reminder will be sent.
313 .TP
314 .B remove \fIID\fR
315 Remove the track identified by \fIID\fR.
316 Requires one of the \fBremove mine\fR, \fBremove random\fR or
317 \fBremove any\fR rights depending on how the
318 track came to be added to the queue.
319 .TP
320 .B rescan \fR[\fBwait\fR] \fR[\fBfresh\fR]
321 Rescan all roots for new or obsolete tracks.
322 Requires the \fBrescan\fR right.
323 .IP
324 If the \fBwait\fR flag is present then the response is delayed until the rescan
325 completes.
326 Otherwise the response arrives immediately.
327 This is primarily intended for testing.
328 .IP
329 If the \fBfresh\fR flag is present a rescan is already underway then a second
330 rescan will be started when it completes.
331 The default behavior is to piggyback on the existing rescan.
332 .IP
333 NB that \fBfresh\fR is currently disabled in the server source, so using this
334 flag will just provoke an error.
335 .TP
336 .B resolve \fITRACK\fR
337 Resolve a track name, i.e. if this is an alias then return the real track name.
338 .TP
339 .B resume
340 Resume the current track after a \fBpause\fR command.
341 Requires the \fBpause\fR right.
342 .TP
343 .B revoke \fBcookie\fR
344 Revoke a cookie previously created with \fBmake\-cookie\fR.
345 It will not be possible to use this cookie in the future.
346 .TP
347 .B rtp\-address
348 Report the RTP broadcast (or multicast) address, in the form \fIADDRESS
349 PORT\fR.
350 This command does not require authentication.
351 .TP
352 .B scratch \fR[\fIID\fR]
353 Remove the track identified by \fIID\fR, or the currently playing track if no
354 \fIID\fR is specified.
355 Requires one of the \fBscratch mine\fR, \fBscratch random\fR or
356 \fBscratch any\fR rights depending on how the track came to be
357 added to the queue.
358 .TP
359 .B schedule-add \fIWHEN\fR \fIPRIORITY\fR \fIACTION\fR ...
360 Schedule an event for the future.
361 .IP
362 .I WHEN
363 is the time when it should happen, as \fBtime_t\fR value.
364 It must refer to a time in the future.
365 .IP
367 is the event priority.
368 This can be \fBnormal\fR, in which case the event will be run at startup if its
369 time has past, or \fBjunk\fR in which case it will be discarded if it is found
370 to be in the past at startup.
371 The meaning of other values is not defined.
372 .IP
374 is the action to perform.
375 The choice of action determines the meaning of the remaining arguments.
376 Possible actions are:
377 .RS
378 .TP
379 .B play
380 Play a track.
381 The next argument is the track name.
382 Requires the \fBplay\fR right.
383 .TP
384 .B set-global
385 Set a global preference.
386 The next argument is the preference name and the final argument is the value to
387 set it to (omit it to unset it).
388 Requires the \fBglobal prefs\fR right.
389 .RE
390 .IP
391 You need the right at the point you create the event.
392 It is not possible to create scheduled events in expectation of a future change
393 in rights.
394 .TP
395 .B schedule-del \fIEVENT\fR
396 Deletes a scheduled event.
397 Users can always delete their own scheduled events; with the \fBadmin\fR
398 right you can delete any event.
399 .TP
400 .B schedule-get \fIEVENT\fR
401 Sends the details of scheduled event \fIEVENT\fR in a response body.
402 Each line is a pair of strings quoted in the usual way, the first being the key
403 ane the second the value.
404 No particular order is used.
405 .IP
406 Scheduled events are considered public information.
407 Right \fBread\fR is sufficient to see details of all events.
408 .TP
409 .B schedule-list
410 Sends the event IDs of all scheduled events in a response body, in no
411 particular order.
412 Use \fBschedule-get\fR to get the details of each event.
413 .TP
414 .B search \fITERMS\fR
415 Search for tracks matching the search terms.
416 The results are put in a response body, one to a line.
417 .IP
418 The search string is split in the usual way, with quoting supported, into a
419 list of terms.
420 Only tracks matching all terms are included in the results.
421 .IP
422 Any terms of the form \fBtag:\fITAG\fR limits the search to tracks with that
423 tag.
424 .IP
425 All other terms are interpreted as individual words which must be present in
426 the track name.
427 .IP
428 Spaces in terms don't currently make sense, but may one day be interpreted to
429 allow searching for phrases.
430 .TP
431 .B \fBset\fR \fITRACK\fR \fIPREF\fR \fIVALUE\fR
432 Set a preference.
433 Requires the \fBprefs\fR right.
434 .TP
435 .B set\-global \fIKEY\fR \fIVALUE\fR
436 Set a global preference.
437 Requires the \fBglobal prefs\fR right.
438 .TP
439 .B stats
440 Send server statistics in plain text in a response body.
441 .TP
442 .B \fBtags\fR
443 Send the list of currently known tags in a response body.
444 .TP
445 .B \fBunset\fR \fITRACK\fR \fIPREF\fR
446 Unset a preference.
447 Requires the \fBprefs\fR right.
448 .TP
449 .B \fBunset\-global\fR \fIKEY\fR
450 Unset a global preference.
451 Requires the \fBglobal prefs\fR right.
452 .TP
454 Authenticate as user \fIUSERNAME\fR.
455 See
457 below.
458 .TP
459 .B userinfo \fIUSERNAME PROPERTY
460 Get a user property.
461 .TP
462 .B users
463 Send the list of currently known users in a response body.
464 .TP
465 .B version
466 Send back a response with the server version as the second field.
467 .TP
468 .B volume \fR[\fILEFT\fR [\fIRIGHT\fR]]
469 Get or set the volume.
470 .IP
471 With zero parameters just gets the volume and reports the left and right sides
472 as the 2nd and 3rd fields of the response.
473 .IP
474 With one parameter sets both sides to the same value.
475 With two parameters sets each side independently.
476 Setting the volume requires the \fBvolume\fR right.
478 Responses are three-digit codes.
479 The first digit distinguishes errors from succesful responses:
480 .TP
481 .B 2
482 Operation succeeded.
483 .TP
484 .B 5
485 Operation failed.
486 .PP
487 The second digit breaks down the origin of the response:
488 .TP
489 .B 0
490 Generic responses not specific to the handling of the command.
491 Mostly this is parse errors.
492 .TP
493 .B 1
494 51x errors indicate that the user had insufficient rights for the command.
495 .TP
496 .B 3
497 Authentication responses.
498 .TP
499 .B 5
500 Responses specific to the handling of the command.
501 .PP
502 The third digit provides extra information about the response:
503 .TP
504 .B 0
505 Text part is just commentary.
506 .TP
507 .B 1
508 Text part is a constant result e.g. \fBversion\fR.
509 .TP
510 .B 2
511 Text part is a potentially variable result.
512 .TP
513 .B 3
514 Text part is just commentary; a dot-stuffed body follows.
515 .TP
516 .B 4
517 Text part is just commentary; an indefinite dot-stuffed body follows.
518 (Used for \fBlog\fR.)
519 .TP
520 .B 5
521 Used with "normal" errors, for instance a preference not being found.
522 The text part is commentary.
523 .TP
524 .B 9
525 The text part is just commentary (but would normally be a response for this
526 command) e.g. \fBplaying\fR.
527 .PP
528 Result strings (not bodies) intended for machine parsing (i.e. xx1 and xx2
529 responses) are quoted.
531 When a connection is made the server sends a \fB231\fR response before any
532 command is received.
533 This contains a protocol generation, an algorithm name and a
534 challenge encoded in hex, all separated by whitespace.
535 .PP
536 The current protocol generation is \fB2\fR.
537 .PP
538 The possible algorithms are (currently) \fBsha1\fR, \fBsha256\fR, \fBsha384\fR
539 and \fBsha512\fR.
540 \fBSHA1\fR etc work as synonyms.
541 .PP
542 The \fBuser\fR response consists of the selected hash of the user's password
543 concatenated with the challenge, encoded in hex.
545 Track information is encoded in a line (i.e. using the usual line syntax) as
546 pairs of fields.
547 The first is a name, the second a value.
548 The names have the following meanings:
549 .TP 12
550 .B expected
551 The time the track is expected to be played at.
552 .TP
553 .B id
554 A string uniquely identifying this queue entry.
555 .TP
556 .B played
557 The time the track was played at.
558 .TP
559 .B scratched
560 The user that scratched the track.
561 .TP
562 .B origin
563 The origin of the track.  Valid origins are:
564 .RS
565 .TP 12
566 .B adopted
567 The track was originally randomly picked but has been adopted by a user.
568 .TP
569 .B picked
570 The track was picked by a user.
571 .TP
572 .B random
573 The track was randomly picked.
574 .TP
575 .B scheduled
576 The track was played from a scheduled action.
577 .TP
578 .B scratch
579 The track is a scratch sound.
580 .RE
581 .TP
582 .B state
583 The current track state.
584 Valid states are:
585 .RS
586 .TP 12
587 .B failed
588 The player failed (exited with nonzero status but wasn't scratched).
589 .TP
590 .B ok
591 The track was played without any problems.
592 .TP
593 .B scratched
594 The track was scratched.
595 .TP
596 .B started
597 The track is currently playing.
598 .TP
599 .B paused
600 Track is playing but paused.
601 .TP
602 .B unplayed
603 In the queue, hasn't been played yet.
604 .TP
605 .B quitting
606 The track was terminated because the server is shutting down.
607 .RE
608 .TP
609 .B submitter
610 The user that submitted the track.
611 .TP
612 .B track
613 The filename of the track.
614 .TP
615 .B when
616 The time the track was added to the queue.
617 .TP
618 .B wstat
619 The wait status of the player in decimal.
620 .PP
621 Note that \fBorigin\fR is new with DisOrder 4.3, and obsoletes some old
622 \fBstate\fR values.
624 Times are decimal integers using the server's \fBtime_t\fR.
625 .PP
626 For file listings, the regexp applies to the basename of the returned file, not
627 the whole filename, and letter case is ignored.
628 \fBpcrepattern\fR(3) describes the regexp syntax.
629 .PP
630 Filenames are in UTF-8 even if the collection they come from uses some other
631 encoding - if you want to access the real file (in such cases as the filenames
632 actually correspond to a real file) you'll have to convert to whatever the
633 right encoding is.
635 The event log consists of lines starting with a hexadecimal timestamp and a
636 keyword followed by (optionally) parameters.
637 The parameters are quoted in the usual DisOrder way.
638 Currently the following keywords are used:
639 .TP
640 .B adopted \fIID\fR \fIUSERNAME\fR
641 \fIUSERNAME\fR adopted track \fIID\fR.
642 .TP
643 .B completed \fITRACK\fR
644 Completed playing \fITRACK\fR
645 .TP
646 .B failed \fITRACK\fR \fIERROR\fR
647 Completed playing \fITRACK\fR with an error status
648 .TP
649 .B moved \fIUSERNAME\fR
650 User \fIUSERNAME\fR moved some track(s).
651 Further details aren't included any more.
652 .TP
653 .B playing \fITRACK\fR [\fIUSERNAME\fR]
654 Started playing \fITRACK\fR.
655 .TP
656 .B playlist_created \fIPLAYLIST\fR \fISHARING\fR
657 Sent when a playlist is created.
658 For private playlists this is intended to be sent only to the owner (but
659 this is not currently implemented).
660 .TP
661 .B playlist_deleted \fIPLAYLIST\fR
662 Sent when a playlist is deleted.
663 For private playlists this is intended to be sent only to the owner (but
664 this is not currently implemented).
665 .TP
666 .B playlist_modified \fIPLAYLIST\fR \fISHARING\fR
667 Sent when a playlist is modified (either its contents or its sharing status).
668 For private playlists this is intended to be sent only to the owner (but
669 this is not currently implemented).
670 .TP
671 .B queue \fIQUEUE-ENTRY\fR...
672 Added \fITRACK\fR to the queue.
673 .TP
674 .B recent_added \fIQUEUE-ENTRY\fR...
675 Added \fIID\fR to the recently played list.
676 .TP
677 .B recent_removed \fIID\fR
678 Removed \fIID\fR from the recently played list.
679 .TP
680 .B removed \fIID\fR [\fIUSERNAME\fR]
681 Queue entry \fIID\fR was removed.
682 This is used both for explicit removal (when \fIUSERNAME\fR is present)
683 and when playing a track (when it is absent).
684 .TP
685 .B rescanned
686 A rescan completed.
687 .TP
688 .B scratched \fITRACK\fR \fIUSERNAME\fR
689 \fITRACK\fR was scratched by \fIUSERNAME\fR.
690 .TP
691 .B state \fIKEYWORD\fR
692 Some state change occurred.
693 The current set of keywords is:
694 .RS
695 .TP
696 .B completed
697 The current track completed successfully.
698 .TP
699 .B disable_play
700 Playing was disabled.
701 .TP
702 .B disable_random
703 Random play was disabled.
704 .TP
705 .B enable_play
706 Playing was enabled.
707 .TP
708 .B enable_random
709 Random play was enabled.
710 .TP
711 .B failed
712 The current track failed.
713 .TP
714 .B pause
715 The current track was paused.
716 .TP
717 .B playing
718 A track started playing.
719 .TP
720 .B resume
721 The current track was resumed.
722 .TP
723 .B rights_changed \fIRIGHTS\fR
724 User's rights were changed.
725 .TP
726 .B scratched
727 The current track was scratched.
728 .PP
729 To simplify client implementation, \fBstate\fR commands reflecting the current
730 state are sent at the start of the log.
731 .RE
732 .TP
733 .B user_add \fIUSERNAME\fR
734 A user was created.
735 .TP
736 .B user_delete \fIUSERNAME\fR
737 A user was deleted.
738 .TP
739 .B user_edit \fIUSERNAME\fR \fIPROPERTY\fR
740 Some property of a user was edited.
741 .TP
742 .B user_confirm \fIUSERNAME\fR
743 A user's login was confirmed (via the web interface).
744 .TP
745 .B volume \fILEFT\fR \fIRIGHT\fR
746 The volume changed.
747 .PP
749 is as defined in
751 above.
752 .PP
753 The \fBuser-*\fR messages are only sent to admin users, and are not sent over
754 non-local connections unless \fBremote_userman\fR is enabled.
756 All data sent by both server and client is encoded using UTF-8.
757 Moreover it must be valid UTF-8, i.e. non-minimal sequences are not
758 permitted, nor are surrogates, nor are code points outside the
759 Unicode code space.
760 .PP
761 There are no particular normalization requirements on either side of the
762 protocol.
763 The server currently converts internally to NFC, the client must
764 normalize the responses returned if it needs some normalized form for further
765 processing.
766 .PP
767 The various characters which divide up lines may not be followed by combining
768 characters.
769 For instance all of the following are prohibited:
770 .TP
771 .B o
772 LINE FEED followed by a combining character.
773 For example the sequence LINE FEED, COMBINING GRAVE ACCENT is never permitted.
774 .TP
775 .B o
776 APOSTROPHE or QUOTATION MARK followed by a combining character when used to
777 delimit fields.
778 For instance a line starting APOSTROPHE, COMBINING CEDILLA is prohibited.
779 .IP
780 Note that such sequences are not prohibited when the quote character cannot be
781 interpreted as a field delimiter.
783 APOSTROPHE would be permitted.
784 .TP
785 .B o
786 REVERSE SOLIDUS (BACKSLASH) followed by a combining character in a quoted
787 string when it is the first character of an escape sequence.
789 is prohibited.
790 .IP
791 As above such sequences are not prohibited when the character is not being used
792 to start an escape sequence.
794 APOSTROPHE is permitted.
795 .TP
796 .B o
797 Any of the field-splitting whitespace characters followed by a combining
798 character when not part of a quoted field.
799 For instance a line starting COLON, SPACE, COMBINING CANDRABINDU is prohibited.
800 .IP
801 As above non-delimiter uses are fine.
802 .TP
803 .B o
804 The FULL STOP characters used to quote or delimit a body.
805 .PP
806 Furthermore none of these characters are permitted to appear in the context of
807 a canonical decomposition (i.e. they must still be present when converted to
808 NFC).
809 In practice however this is not an issue in Unicode 5.0.
810 .PP
811 These rules are consistent with the observation that the split() function is
812 essentially a naive ASCII parser.
813 The implication is not that these sequences never actually appear in
814 the protocol, merely that the server is not required to honor them in
815 any useful way nor be consistent between versions: in current
816 versions the result will be lines and fields that start with combining
817 characters and are not necessarily split where you expect, but future versions
818 may remove them, reject them or ignore some or all of the delimiters that have
819 following combining characters, and no notice will be given of any change.
820 .SH "SEE ALSO"
821 \fBdisorder\fR(1),
822 \fBtime\fR(2),
823 \fBdisorder\fR(3),
824 \fBpcrepattern\fR(3)
825 \fBdisorder_config\fR(5),
826 \fBdisorderd\fR(8),
827 \fButf8\fR(7)
828 .\" Local Variables:
829 .\" mode:nroff
830 .\" fill-column:79
831 .\" End: