X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/c9467b7a34160c4e25580a2dc82087c5ae0bb2d0..0b5fb1052ef6a90e8d007e31dbf6f96d300d6fd6:/doc/disorder_protocol.5.in diff --git a/doc/disorder_protocol.5.in b/doc/disorder_protocol.5.in index a0baadb..58a7e8f 100644 --- a/doc/disorder_protocol.5.in +++ b/doc/disorder_protocol.5.in @@ -75,7 +75,8 @@ If \fIREGEXP\fR is present only matching files and directories are returned. .B confirm \fICONFIRMATION Confirm user registration. \fICONFIRMATION\fR is as returned from \fBregister\fR below. -This command can be used without logging in. +This command logs the user in. +The response contains the logged-in username. .TP .B cookie \fICOOKIE Log a user back in using a cookie created with \fBmake\-cookie\fR. @@ -122,7 +123,7 @@ List all the files in \fIDIRECTORY\fR in a response body. If \fIREGEXP\fR is present only matching files are returned. .TP .B get \fITRACK\fR \fIPREF\fR -Getsa preference value. +Gets a preference value. On success the second field of the response line will have the value. .IP If the track or preference do not exist then the response code is 555. @@ -171,7 +172,7 @@ depending on how the tracks came to be added to the queue. .TP .B new \fR[\fIMAX\fR] Send the most recently added \fIMAX\fR tracks in a response body. -If the argument is ommitted, the \fBnew_max\fR most recent tracks are +If the argument is omitted, the \fBnew_max\fR most recent tracks are listed (see \fBdisorder_config\fR(5)). .TP .B nop @@ -207,6 +208,16 @@ Add a track to the queue. The response contains the queue ID of the track. Requires the \fBplay\fR right. .TP +.B playafter \fITARGET\fR \fITRACK\fR ... +Add all the tracks in the \fITRACK\fR list to the queue after \fITARGET\fR +(which should be a track ID). +If \fITARGET\fR is the empty string then the listed tracks are put +at the head of the queue. +.IP +Currently the success result does \fInot\fR include the new track IDs. +.IP +Requires the \fBplay\fR right. +.TP .B playing Report what track is playing. .IP @@ -222,6 +233,7 @@ Requires permission to modify that playlist and the \fBplay\fR right. .B playlist-get \fIPLAYLIST\fR Get the contents of a playlist, in a response body. Requires permission to read that playlist and the \fBread\fR right. +If the playlist does not exist the response is 555. .TP .B playlist-get-share \fIPLAYLIST\fR Get the sharing status of a playlist. @@ -329,9 +341,9 @@ Resolve a track name, i.e. if this is an alias then return the real track name. Resume the current track after a \fBpause\fR command. Requires the \fBpause\fR right. .TP -.B revoke \fBcookie\fR -Revoke a cookie previously created with \fBmake\-cookie\fR. -It will not be possible to use this cookie in the future. +.B revoke +Revoke the current login's cookie. +It will not be possible to use the cookie in the future. .TP .B rtp\-address Report the RTP broadcast (or multicast) address, in the form \fIADDRESS @@ -425,6 +437,10 @@ Requires the \fBprefs\fR right. Set a global preference. Requires the \fBglobal prefs\fR right. .TP +.B shutdown +Requests server shutdown. +Requires the \fBadmin\fR right. +.TP .B stats Send server statistics in plain text in a response body. .TP @@ -465,7 +481,7 @@ With two parameters sets each side independently. Setting the volume requires the \fBvolume\fR right. .SH RESPONSES Responses are three-digit codes. -The first digit distinguishes errors from succesful responses: +The first digit distinguishes errors from successful responses: .TP .B 2 Operation succeeded. @@ -635,6 +651,9 @@ Completed playing \fITRACK\fR .B failed \fITRACK\fR \fIERROR\fR Completed playing \fITRACK\fR with an error status .TP +.B global_pref \fIPREF\fR [\fIVALUE\fR] +A global preference was set or unset. +.TP .B moved \fIUSERNAME\fR User \fIUSERNAME\fR moved some track(s). Further details aren't included any more.