X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/5aff007d8fcfb4c6cc3c3627ae15f45562db7a0d..1f2a5e52d2a40d7a80a18afc93f9da173e7a2196:/doc/disorderd.8.in diff --git a/doc/disorderd.8.in b/doc/disorderd.8.in index ed488e9..f194a0e 100644 --- a/doc/disorderd.8.in +++ b/doc/disorderd.8.in @@ -1,20 +1,18 @@ .\" .\" 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 -.\" 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. -.\" -.\" 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 -.\" 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 . .\" .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. +.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. @@ -100,6 +112,11 @@ automatically, and thus has relatively modest storage requirements. .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. @@ -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 +.SS "Configuration Files" .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. +.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. -Do not edit while the daemon is running. .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 -.I pkgstatedir/global.db -Global preferences database. +.I pkgstatedir/schedule.db +Database of scheduled tasks. .TP .I pkgstatedir/search.db Search lookup database. @@ -144,6 +173,9 @@ Tag lookup database. .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 @@ -153,8 +185,8 @@ See the Berkeley DB documention for further details. .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. @@ -165,7 +197,8 @@ This prevents multiple instances of DisOrder running simultaneously. Current locale. See \fBlocale\fR(7). .SH "SEE ALSO" -\fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder\-dump\fR(8) +\fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder\-dump\fR(8), +\fBdisorder.cgi\fR(8) .\" Local Variables: .\" mode:nroff .\" End: