The web interface now automaticallty figures out its own URL, so this

[disorder] / doc / disorder.1.in

diff --git a/doc/disorder.1.in b/doc/disorder.1.in
index 369f2ca48a91015d8e4b43a8f15f857f60a08790..d04cb3beab5d7a3c39cb9b056ccce545b58c77ed 100644 (file)
--- a/doc/disorder.1.in
+++ b/doc/disorder.1.in
@@ -1,5 +1,5 @@
 .\"
 .\"

-.\" Copyright (C) 2004, 2005, 2006 Richard Kettlewell
+.\" Copyright (C) 2004, 2005, 2006, 2007 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


@@ -24,14 +24,7 @@ disorder \- DisOrder jukebox client
 .RI [ OPTIONS ]
 .RB [ -- ]
 .RI [ COMMANDS ...]
 .RI [ OPTIONS ]
 .RB [ -- ]
 .RI [ COMMANDS ...]

-.br
-.B disorder
-.B --length
-.RI [ OPTIONS ]
-.RB [ -- ]
-.IR PATH ...

 .SH DESCRIPTION
 .SH DESCRIPTION

-Without the \fB--length\fR option,

 .B disorder
 is used to query the \fBdisorderd\fR(8) daemon from the command line.
 It may be used to request tracks, scratch tracks, query the current
 .B disorder
 is used to query the \fBdisorderd\fR(8) daemon from the command line.
 It may be used to request tracks, scratch tracks, query the current


@@ -54,10 +47,6 @@ Enable debugging.
 .B --help\fR, \fB-h
 Display a usage message.
 .TP
 .B --help\fR, \fB-h
 Display a usage message.
 .TP

-.B --length\fR, \fB-L
-Calculate the length in seconds of the files specified using the tracklength
-plugin.
-.TP

 .B --version\fR, \fB-V
 Display version number.
 .TP
 .B --version\fR, \fB-V
 Display version number.
 .TP


@@ -65,6 +54,21 @@ Display version number.
 List all known commands.
 .SH COMMANDS
 .TP
 List all known commands.
 .SH COMMANDS
 .TP

+.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
+An appropriate \fIconfig.USER\fR is created, owned by the user, so they should
+be able to log in immediately.
+.TP
+.B deluser \fIUSER\fR
+Delete a user.
+.TP

 .B dirs \fIDIRECTORY\fR [\fB~\fIREGEXP\fR]
 List all the directories in \fIDIRECTORY\fR.
 .IP
 .B dirs \fIDIRECTORY\fR [\fB~\fIREGEXP\fR]
 List all the directories in \fIDIRECTORY\fR.
 .IP


@@ -72,7 +76,10 @@ 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
 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.

 .TP
 .B enable
 (Re-)enable playing.
 .TP
 .B enable
 (Re-)enable playing.


@@ -90,13 +97,13 @@ Display the preference \fIKEY\fR for \fITRACK\fR.
 Get a global preference.
 .TP
 .B get-volume
 Get a global preference.
 .TP
 .B get-volume

-Displays the current volume settings.
+Display the current volume settings.

 .TP
 .B length \fITRACK\fR
 .TP
 .B length \fITRACK\fR

-Reports the length of \fITRACK\fR in seconds.
+Display the length of \fITRACK\fR in seconds.

 .TP
 .B log
 .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
 See \fBdisorder_protocol\fR (5) for details of the output syntax.
 .TP
 .B move \fITRACK\fR \fIDELTA\fR


@@ -143,15 +150,26 @@ Enable random play.
 List recently played tracks.  The first entry is the oldest track, the last
 entry is the most recently played one.
 .TP
 List recently played tracks.  The first entry is the oldest track, the last
 entry is the most recently played one.
 .TP

+.B reconfigure
+Make the daemon reload its configuration file.
+.TP

 .B remove \fITRACK\fR
 Remove a track from the queue.
 .TP
 .B remove \fITRACK\fR
 Remove a track from the queue.
 .TP

+.B rescan
+Rescan the filesystem for new tracks.  There is an automatic daily rescan but
+if you've just added some tracks and want them to show up immediately, use this
+command.
+.TP

 .B resolve \fITRACK\fR
 Resolve aliases for \fITRACK\fR and print out the real track name.
 .TP
 .B resume
 Resume the current track after a pause.
 .TP
 .B resolve \fITRACK\fR
 Resolve aliases for \fITRACK\fR and print out the real track name.
 .TP
 .B resume
 Resume the current track after a pause.
 .TP

+.B rtp-address
+Report the RTP brodcast address used by the server (if any).
+.TP

 .B scratch
 Scratch the currently playing track.
 .TP
 .B scratch
 Scratch the currently playing track.
 .TP


@@ -168,7 +186,7 @@ for example:
 You can limit the search to tracks with a particular tag, too, using the
 \fBtag:\fR modifier.  For example:
 .IP
 You can limit the search to tracks with a particular tag, too, using the
 \fBtag:\fR modifier.  For example:
 .IP

-.B "disorder search 'love tag:depressing'
+.B "disorder search 'love tag:depressing'"

 .TP
 .B set \fITRACK\fR \fIKEY\fR \fIVALUE\fR
 Set the preference \fIKEY\fR for \fITRACK\fR to \fIVALUE\fR.
 .TP
 .B set \fITRACK\fR \fIKEY\fR \fIVALUE\fR
 Set the preference \fIKEY\fR for \fITRACK\fR to \fIVALUE\fR.


@@ -177,7 +195,18 @@ Set the preference \fIKEY\fR for \fITRACK\fR to \fIVALUE\fR.
 Set a global preference.
 .TP
 .B set-volume \fBLEFT\fR \fBRIGHT\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.
+.TP
+.B shutdown
+Shut down the daemon.

 .TP
 .B stats
 List server statistics.
 .TP
 .B stats
 List server statistics.


@@ -191,6 +220,12 @@ Unset the preference \fIKEY\fR for \fITRACK\fR.
 .B unset-global \fIKEY\fR
 Unset the global preference \fIKEY\fR.
 .TP
 .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

 .B version
 Report the daemon's version number.
 .PP
 .B version
 Report the daemon's version number.
 .PP


@@ -200,22 +235,6 @@ and
 .BR remove ,
 tracks may be specified by name or by ID.  If you use the name and a track
 appears twice in the queue it is undefined which is affected.
 .BR remove ,
 tracks may be specified by name or by ID.  If you use the name and a track
 appears twice in the queue it is undefined which is affected.

-.SS "Privileged Commands"
-These commands are only available to privileged users.
-.TP
-.B become \fIUSER\fR
-Become another user.
-.TP
-.B reconfigure
-Make the daemon reload its configuration file.
-.TP
-.B rescan
-Rescan the filesystem for new tracks.  There is an automatic daily rescan but
-if you've just added some tracks and want them to show up immediately, use this
-command.
-.TP
-.B shutdown
-Shut down the daemon.

 .SH PREFERENCES
 Currently the following preferences are supported.  Some are expected
 to be set by users, others updated automatically by plugins.
 .SH PREFERENCES
 Currently the following preferences are supported.  Some are expected
 to be set by users, others updated automatically by plugins.


@@ -260,23 +279,18 @@ is not present.
 .B unscratched
 The number of times the track has been played to completion without
 being scratched.
 .B unscratched
 The number of times the track has been played to completion without
 being scratched.

-.SH "Superuser Commands"
-These commands will (generally) only work for root, who must be a privileged
-user.
-.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.
-.IP
-If at least one \fBauthorize\fR command succeeds then the server is
-automatically told to re-read its configuration.

 .SH NOTES
 .B disorder
 is locale-aware.  If you do not set the locale correctly then it may
 not handle non-ASCII data properly.
 .PP
 .SH NOTES
 .B disorder
 is locale-aware.  If you do not set the locale correctly then it may
 not handle non-ASCII data properly.
 .PP

-The client determines which user to attempt to authenticate as by
-examining the current UID.
+The client determines which user to attempt to authenticate as by examining the
+current UID.  This can be overridden in a per-user configuration file, see
+\fBdisorder_config\fR(5).
+.PP
+See \fBdisorder_protocol\fR(5) for the rights required to run each command.
+(For instance, \fBshutdown\fR requires the \fBadmin\fR right, which most users
+would not normally have.)

 .PP
 This program is not intended to run in a setuid environment.
 .PP
 .PP
 This program is not intended to run in a setuid environment.
 .PP


@@ -343,4 +357,3 @@ Communication socket for \fBdisorder\fR(1).
 .\" mode:nroff
 .\" fill-column:79
 .\" End:
 .\" mode:nroff
 .\" fill-column:79
 .\" End:

-.\" arch-tag:f4ecee92157cdac8ee0f71c3fc14044d