Stub + document shutdown command

[disorder] / doc / disorder_protocol.5.in

diff --git a/doc/disorder_protocol.5.in b/doc/disorder_protocol.5.in
index 6bc9c47..0f8f909 100644 (file)
--- 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.
 .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.
 .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
 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.
 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.
 .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
 listed (see \fBdisorder_config\fR(5)).
 .TP
 .B nop


@@ -232,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.
 .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.
 .TP
 .B playlist-get-share \fIPLAYLIST\fR
 Get the sharing status of a playlist.


@@ -435,6 +437,10 @@ Requires the \fBprefs\fR right.
 Set a global preference.
 Requires the \fBglobal prefs\fR right.
 .TP
 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
 .B stats
 Send server statistics in plain text in a response body.
 .TP


@@ -475,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.
 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.
 .TP
 .B 2
 Operation succeeded.


@@ -645,6 +651,9 @@ Completed playing \fITRACK\fR
 .B failed \fITRACK\fR \fIERROR\fR
 Completed playing \fITRACK\fR with an error status
 .TP
 .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.
 .B moved \fIUSERNAME\fR
 User \fIUSERNAME\fR moved some track(s).
 Further details aren't included any more.