Mention that FreeBSD requires gmake

[disorder] / doc / disorder_protocol.5.in

diff --git a/doc/disorder_protocol.5.in b/doc/disorder_protocol.5.in
index cd3a20a6f8732592639287214ef15ac50cf20c7f..56fd0947a383a3099ea27af7559c52e6bbd00e49 100644 (file)
--- a/doc/disorder_protocol.5.in
+++ b/doc/disorder_protocol.5.in
@@ -1,5 +1,5 @@
 .\"
 .\"

-.\" Copyright (C) 2004, 2005, 2006 Richard Kettlewell
+.\" Copyright (C) 2004-2008 Richard Kettlewell

 .\"
 .\" This program is free software; you can redistribute it and/or modify
 .\" it under the terms of the GNU General Public License as published by
 .\"
 .\" This program is free software; you can redistribute it and/or modify
 .\" it under the terms of the GNU General Public License as published by


@@ -65,7 +65,8 @@ Confirm user registration.  \fICONFIRMATION\fR is as returned from
 \fBregister\fR below.  This command can be used without logging in.
 .TP
 .B cookie \fICOOKIE
 \fBregister\fR below.  This command can be used without logging in.
 .TP
 .B cookie \fICOOKIE

-Log a user back in using a cookie created with \fBmake-cookie\fR.
+Log a user back in using a cookie created with \fBmake-cookie\fR.  The response
+contains the username.

 .TP
 .B deluser \fIUSERNAME
 Delete the named user.  Requires the \fBadmin\fR right, and only works on
 .TP
 .B deluser \fIUSERNAME
 Delete the named user.  Requires the \fBadmin\fR right, and only works on


@@ -147,7 +148,8 @@ 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
 .TP
 .B new \fR[\fIMAX\fR]
 Send the most recently added \fIMAX\fR tracks in a response body.  If the

-argument is ommitted, all recently added tracks are listed.
+argument is ommitted, the \fBnew_max\fR most recent tracks are listed (see
+\fBdisorder_config\fR(5)).

 .TP
 .B nop
 Do nothing.  Used by
 .TP
 .B nop
 Do nothing.  Used by


@@ -172,7 +174,7 @@ or
 .BR title .
 .TP
 .B pause
 .BR title .
 .TP
 .B pause

-Pause the current track.  Requires the \fBpause\R right.
+Pause the current track.  Requires the \fBpause\fR right.

 .TP
 .B play \fITRACK\fR
 Add a track to the queue.  The response contains the queue ID of the track.
 .TP
 .B play \fITRACK\fR
 Add a track to the queue.  The response contains the queue ID of the track.


@@ -221,6 +223,11 @@ Register a new user.  Requires the \fBregister\fR right.  The result contains a
 confirmation string; the user will be be able to log in until this has been
 presented back to the server via the \fBconfirm\fR command.
 .TP
 confirmation string; the user will be be able to log in until this has been
 presented back to the server via the \fBconfirm\fR command.
 .TP

+.B reminder \fIUSER\fR
+Send a password reminder to \fIUSER\fR.  If the user has no valid email
+address, or no password, or a reminder has been sent too recently, then no
+reminder will be sent.
+.TP

 .B remove \fIID\fR
 Remove the track identified by \fIID\fR.  Requires one of the \fBremove
 mine\fR, \fBremove random\fR or \fBremove any\fR rights depending on how the
 .B remove \fIID\fR
 Remove the track identified by \fIID\fR.  Requires one of the \fBremove
 mine\fR, \fBremove random\fR or \fBremove any\fR rights depending on how the


@@ -319,6 +326,9 @@ The second digit breaks down the origin of the response:
 Generic responses not specific to the handling of the command.  Mostly this is
 parse errors.
 .TP
 Generic responses not specific to the handling of the command.  Mostly this is
 parse errors.
 .TP

+.B 1
+51x errors indicate that the user had insufficient rights for the command.
+.TP

 .B 3
 Authentication responses.
 .TP
 .B 3
 Authentication responses.
 .TP