Update CHANGES for scratch improvements

[disorder] / doc / disorderd.8.in

diff --git a/doc/disorderd.8.in b/doc/disorderd.8.in
index b304e5af236b3303d712fe5be3f83cf6870e4f44..f194a0eee3854ee455023bbb6f40b364e419bf66 100644 (file)
--- a/doc/disorderd.8.in
+++ b/doc/disorderd.8.in
@@ -1,20 +1,18 @@
 .\"
 .\" Copyright (C) 2004, 2005, 2007, 2008 Richard Kettlewell
 .\"
 .\"
 .\" Copyright (C) 2004, 2005, 2007, 2008 Richard Kettlewell
 .\"

-.\" This program is free software; you can redistribute it and/or modify
+.\" 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
 .\" it under the terms of the GNU General Public License as published by

-.\" the Free Software Foundation; either version 2 of the License, or
+.\" the Free Software Foundation, either version 3 of the License, or

 .\" (at your option) any later version.
 .\" (at your option) any later version.

-.\"
-.\" This program is distributed in the hope that it will be useful, but
-.\" WITHOUT ANY WARRANTY; without even the implied warranty of
-.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-.\" General Public License for more details.
-.\"
+.\" 
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\" 

 .\" You should have received a copy of the GNU General Public License
 .\" You should have received a copy of the GNU General Public License

-.\" along with this program; if not, write to the Free Software
-.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-.\" USA
+.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.

 .\"
 .TH disorderd 8
 .SH NAME
 .\"
 .TH disorderd 8
 .SH NAME


@@ -75,6 +73,20 @@ exist.
 If \fBdisorder\fR(1) is run as root on the same machine as the
 server it is capable of extracting the password from the database
 directly.
 If \fBdisorder\fR(1) is run as root on the same machine as the
 server it is capable of extracting the password from the database
 directly.

+.PP
+Therefore it is immediately possible to create other users with
+.B "disorder adduser"
+as root on the server machine.
+However it is likely to be preferable to get users to register
+themselves via the web interface; see
+.B setup-guest
+in
+.BR disorder (1)
+for more details on this.
+.SS "Logging"
+In its usual configuration, DisOrder logs to daemon.* via \fBsyslog\fR(3).
+Exactly where this ends up depends on the contents of
+.IR /etc/syslog.conf .

 .SS "Locales"
 .B disorderd
 is locale-aware.
 .SS "Locales"
 .B disorderd
 is locale-aware.


@@ -100,6 +112,11 @@ automatically, and thus has relatively modest storage requirements.
 .TP 8
 .B SIGHUP
 Re-read the configuration file.
 .TP 8
 .B SIGHUP
 Re-read the configuration file.

+.IP
+Not all configuration options can be modified during the lifetime of the
+server; of those that can't, some will just be ignored if they change while
+others will cause the new configuration to be rejected.
+See \fBdisorder_config\fR(5) for details.

 .TP
 .B SIGTERM
 Terminate the daemon gracefully.
 .TP
 .B SIGTERM
 Terminate the daemon gracefully.


@@ -110,30 +127,42 @@ Terminate the daemon gracefully.
 It may be more convenient to perform these operations from the client
 \fBdisorder\fR(1).
 .SH FILES
 It may be more convenient to perform these operations from the client
 \fBdisorder\fR(1).
 .SH FILES

+.SS "Configuration Files"

 .TP
 .I pkgconfdir/config
 Global configuration file.
 See \fBdisorder_config\fR(5).
 .TP
 .I pkgconfdir/config.private
 .TP
 .I pkgconfdir/config
 Global configuration file.
 See \fBdisorder_config\fR(5).
 .TP
 .I pkgconfdir/config.private

-Private configuration (usernames and passwords).
+Private configuration (now largely obsolete).

 .TP
 .I ~/.disorder/passwd
 Per-user password file.
 .TP
 .I ~/.disorder/passwd
 Per-user password file.

+.SS "Communication"
+.TP
+.I pkgstatedir/socket
+Communication socket for \fBdisorder\fR(1).
+See \fBdisorder_protocol\fR(5) for protocol documentation.
+.SS "Internal State"
+Don't modify these files, especially not while the server is running.

 .TP
 .I pkgstatedir/queue
 Saved copy of queue.
 .TP
 .I pkgstatedir/queue
 Saved copy of queue.

-Do not edit while the daemon is running.

 .TP
 .I pkgstatedir/recent
 Saved copy of recently played track list.
 .TP
 .I pkgstatedir/recent
 Saved copy of recently played track list.

-Do not edit while the daemon is running.
+.TP
+.I pkgstatedir/global.db
+Global preferences database.
+.TP
+.I pkgstatedir/noticed.db
+Records recently added tracks.

 .TP
 .I pkgstatedir/prefs.db
 Preferences database.
 .TP
 .TP
 .I pkgstatedir/prefs.db
 Preferences database.
 .TP

-.I pkgstatedir/global.db
-Global preferences database.
+.I pkgstatedir/schedule.db
+Database of scheduled tasks.

 .TP
 .I pkgstatedir/search.db
 Search lookup database.
 .TP
 .I pkgstatedir/search.db
 Search lookup database.


@@ -144,6 +173,9 @@ Tag lookup database.
 .I pkgstatedir/tracks.db
 Tracks database.
 .TP
 .I pkgstatedir/tracks.db
 Tracks database.
 .TP

+.I pkgstatedir/users.db
+User database.
+.TP

 .I pkgstatedir/DB_CONFIG
 Berkeley DB configuration file.
 This may be used to override database settings without recompiling
 .I pkgstatedir/DB_CONFIG
 Berkeley DB configuration file.
 This may be used to override database settings without recompiling


@@ -153,8 +185,8 @@ See the Berkeley DB documention for further details.
 .I pkgstatedir/log.* \fRand \fIpkgstatedir/__db.*
 Database internal files.
 .TP
 .I pkgstatedir/log.* \fRand \fIpkgstatedir/__db.*
 Database internal files.
 .TP

-.I pkgstatedir/socket
-Communication socket for \fBdisorder\fR(1).
+.I pkgstatedir/speaker/socket
+Socket for communication with \fBdisorder-speaker\fR(8).

 .TP
 .I pkgstatedir/lock
 Lockfile.
 .TP
 .I pkgstatedir/lock
 Lockfile.