Mention that FreeBSD requires gmake

[disorder] / doc / disorderd.8.in

diff --git a/doc/disorderd.8.in b/doc/disorderd.8.in
index 3b05f59f0e019297f2a904b59fdfbe7c1b5df9ab..7c708c2d68f140d3b970e5fda6244d3ad7b8a2e6 100644 (file)
--- a/doc/disorderd.8.in
+++ b/doc/disorderd.8.in
@@ -1,5 +1,5 @@
 .\"
-.\" Copyright (C) 2004, 2005 Richard Kettlewell
+.\" Copyright (C) 2004, 2005, 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
@@ -38,11 +38,14 @@ for further information.
 .B --pidfile \fIPATH\fR, \fB-P \fIPATH
 Write a pidfile.
 .TP
-.B --foreground, \fB-f
+.B --foreground\fR, \fB-f
 Run in the foreground.  (By default,
 .B disorderd
 detaches from its terminal and runs in the background.)
 .TP
+.B --syslog\fR, \fB-s
+Log to syslog.  This is the default if DisOrder runs in the background.
+.TP
 .B --debug\fR, \fB-d
 Enable debugging.
 .TP
@@ -52,6 +55,8 @@ Display a usage message.
 .B --version\fR, \fB-V
 Display version number.
 .SH NOTES
+For configuration file documentation, see
+.BR disorder_config (5).
 .SS "Startup"
 The first time a new install of DisOrder is started it will run
 .B disorder-rescan
@@ -60,19 +65,12 @@ this automatically; if you want a rescan at every restart you must
 arrange that manually.
 .PP
 There is however an automatic rescan once every 24 hours.
-.SS "How To Configure Authentication"
-The administrator should create \fIpkgconfdir/config.private\fR, make sure it
-is not world-readable, and populate it with \fBallow\fR commands
-listing usernames and passwords.  Use
-e.g. \fBpwgen\fR(1) to generate random passwords.  Passwords should
-then be distributed to users.
 .PP
-Each user should create the file \fI~/.disorder/passwd\fR
-and make sure it is not world-readable.  Having done so
-they should add a \fBpassword\fR command to it giving their password (and
-optionally a \fBusername\fR command if their DisOrder username is not the
-same as their login name).
-.SS Locales
+A \fBroot\fR login is automatically created on startup if it does not
+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.
+.SS "Locales"
 .B disorderd
 is locale-aware.  If you do not set the locale correctly then it may
 not handle non-ASCII data properly.
@@ -124,8 +122,14 @@ Do not edit while the daemon is running.
 .I pkgstatedir/prefs.db
 Preferences database.
 .TP
+.I pkgstatedir/global.db
+Global preferences database.
+.TP
 .I pkgstatedir/search.db
-Search database.
+Search lookup database.
+.TP
+.I pkgstatedir/tags.db
+Tag lookup database.
 .TP
 .I pkgstatedir/tracks.db
 Tracks database.
@@ -135,8 +139,8 @@ Berkeley DB configuration file.  This may be used to override database
 settings without recompiling DisOrder.  See the Berkeley DB
 documention for further details.
 .TP
-.I pkgstatedir/log.*
-Database log files.
+.I pkgstatedir/log.* \fRand \fIpkgstatedir/__db.*
+Database internal files.
 .TP
 .I pkgstatedir/socket
 Communication socket for \fBdisorder\fR(1).
@@ -144,12 +148,6 @@ Communication socket for \fBdisorder\fR(1).
 .I pkgstatedir/lock
 Lockfile.  This prevents multiple instances of DisOrder running
 simultaneously.
-.TP
-.I sbindir/disorder-deadlock
-Deadlock manager.
-.TP
-.I sbindir/disorder-rescan
-Rescanner.
 .SH ENVIRONMENT
 .TP
 .B LC_ALL\fR, \fBLANG\fR, etc