disorder.py docs improved a little

[disorder] / doc / disorder_protocol.5.in

diff --git a/doc/disorder_protocol.5.in b/doc/disorder_protocol.5.in
index bf293e91b09461ada7c16297acd2fcdbbd78c510..a9d973d1693639facb3f1af023524c0c25204a53 100644 (file)
--- a/doc/disorder_protocol.5.in
+++ b/doc/disorder_protocol.5.in
@@ -83,9 +83,13 @@ If \fIREGEXP\fR is present only matching files are returned.
 .B get \fITRACK\fR \fIPREF\fR
 Gets a preference value.  On success the second field of the response line will
 have the value.
 .B get \fITRACK\fR \fIPREF\fR
 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.

 .TP
 .B get-global \fIKEY\fR
 Get a global preference.
 .TP
 .B get-global \fIKEY\fR
 Get a global preference.

+.IP
+If the preference does not exist then the response code is 555.

 .TP
 .B length \fITRACK\fR
 Gets the length of the track in seconds.  On success the second field of the
 .TP
 .B length \fITRACK\fR
 Gets the length of the track in seconds.  On success the second field of the


@@ -141,7 +145,7 @@ or
 Pause the current track.
 .TP
 .B play \fITRACK\fR
 Pause the current track.
 .TP
 .B play \fITRACK\fR

-Add a track to the queue.
+Add a track to the queue.  The response contains the queue ID of the track.

 .TP
 .B playing
 Reports what track is playing.
 .TP
 .B playing
 Reports what track is playing.


@@ -293,6 +297,10 @@ Text part is just commentary; a dot-stuffed body follows.
 Text part is just commentary; an indefinite dot-stuffed body follows.  (Used
 for \fBlog\fR.)
 .TP
 Text part is just commentary; an indefinite dot-stuffed body follows.  (Used
 for \fBlog\fR.)
 .TP

+.B 5
+Used with "normal" errors, for instance a preference not being found.  The text
+part is commentary.
+.TP

 .B 9
 The text part is just commentary (but would normally be a response for this
 command) e.g. \fBplaying\fR.
 .B 9
 The text part is just commentary (but would normally be a response for this
 command) e.g. \fBplaying\fR.