Mention that FreeBSD requires gmake

[disorder] / doc / disorder.1.in

diff --git a/doc/disorder.1.in b/doc/disorder.1.in
index fa81dbaf0f754700baf1d62a16210fef3955b2e7..7a443b76408f2a880834130ab4ad228e37147999 100644 (file)
--- a/doc/disorder.1.in
+++ b/doc/disorder.1.in
@@ -54,15 +54,21 @@ Display version number.
 List all known commands.
 .SH COMMANDS
 .TP
-.B adduser \fIUSER PASSWORD\fR
-Create a new user with default rights.
-.TP
-.B authorize \fIUSER\fR
-Chooses a password for \fIUSER\fR and adds it to \fIconfig.private\fR.  Also
-creates an appropriate \fIconfig.USER\fR, be owned by the user.
+.B adduser \fIUSER PASSWORD\fR [\fIRIGHTS\fR]
+Create a new user.  If \fIRIGHTS\fR is not specified then the
+\fBdefault_rights\fR setting from the server's configuration file applies.
+.TP
+.B authorize \fIUSER\fR [\fIRIGHTS\fR]
+Create \fIUSER\fR with a random password.  \fIUSER\fR must be a UNIX login
+user (not just any old string).  If \fIRIGHTS\fR is not specified then the
+\fBdefault_rights\fR setting from the server's configuration file applies.
+.IP
+\fI~USER/.disorder/passwd\fR is created with the password in it, so the new
+user should be able to log in immediately.
 .IP
-If at least one \fBauthorize\fR command succeeds then the server is
-automatically told to re-read its configuration.
+If writing the \fIpasswd\fR file fails then the user will already have been
+created in DisOrder's user database.  Use \fBdisorder deluser\fR to remove them
+before trying again.
 .TP
 .B deluser \fIUSER\fR
 Delete a user.
@@ -74,7 +80,7 @@ An optional regexp may be specified, marked with an initial \fB~\fR.  Only
 directories with a basename matching the regexp will be returned.
 .TP
 .B disable
-Disables playing after the current track finishes.
+Disable playing after the current track finishes.
 .TP
 .B edituser \fIUSER PROPERTY VALUE
 Set some property of a user.
@@ -95,13 +101,13 @@ Display the preference \fIKEY\fR for \fITRACK\fR.
 Get a global preference.
 .TP
 .B get-volume
-Displays the current volume settings.
+Display the current volume settings.
 .TP
 .B length \fITRACK\fR
-Reports the length of \fITRACK\fR in seconds.
+Display the length of \fITRACK\fR in seconds.
 .TP
 .B log
-Writes event log messages to standard output, until the server is terminated.
+Write event log messages to standard output, until the server is terminated.
 See \fBdisorder_protocol\fR (5) for details of the output syntax.
 .TP
 .B move \fITRACK\fR \fIDELTA\fR
@@ -193,7 +199,18 @@ Set the preference \fIKEY\fR for \fITRACK\fR to \fIVALUE\fR.
 Set a global preference.
 .TP
 .B set-volume \fBLEFT\fR \fBRIGHT\fR
-Sets the volume.
+Set the volume.
+.TP
+.B setup-guest \fR[\fB--no-online-registration\fR]
+Create the "guest" user for use by the web interface.  This user will have no
+password and will only have the "read" and "register" rights, the latter
+allowing new users to automatically register themselves via the web interface.
+.IP
+With the option \fB--no-online-registration\fR, the "register" right is
+suppressed and users must be manually created by an administrator.
+.IP
+If online registration is desired then \fBmail_sender\fR must be set in the
+configuration file.  See \fBdisorder_config\fR(5).
 .TP
 .B shutdown
 Shut down the daemon.
@@ -210,6 +227,9 @@ Unset the preference \fIKEY\fR for \fITRACK\fR.
 .B unset-global \fIKEY\fR
 Unset the global preference \fIKEY\fR.
 .TP
+.B userinfo \fIUSER PROPERTY
+Get some property of a user.
+.TP
 .B users
 List known users.
 .TP