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

[disorder] / doc / disorderd.8.in

diff --git a/doc/disorderd.8.in b/doc/disorderd.8.in
index 24cf033d36e84d00da6c8d8eec3eee607707ff60..71b9568a1d10b45fb3e8377ceacd222ad389ad32 100644 (file)
--- a/doc/disorderd.8.in
+++ b/doc/disorderd.8.in
@@ -38,11 +38,14 @@ for further information.
 .B --pidfile \fIPATH\fR, \fB-P \fIPATH
 Write a pidfile.
 .TP
 .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
 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
 .B --debug\fR, \fB-d
 Enable debugging.
 .TP


@@ -52,14 +55,16 @@ Display a usage message.
 .B --version\fR, \fB-V
 Display version number.
 .SH NOTES
 .B --version\fR, \fB-V
 Display version number.
 .SH NOTES

-.SS "Environmental Dependencies"
-It is important that
-.B disorder-deadlock
-and
+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
 .B disorder-rescan

-are available on the PATH.  The example "init" script attempts to
-ensure this by appending sbindir to the path, but if you have
-installed programs in unusual locations then this might not work.
+to pick up new tracks.  On subsequent server restarts it will NOT do
+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
 .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


@@ -78,10 +83,8 @@ is locale-aware.  If you do not set the locale correctly then it may
 not handle non-ASCII data properly.
 .PP
 Filenames and the configuration file are assumed to be encoded using the
 not handle non-ASCII data properly.
 .PP
 Filenames and the configuration file are assumed to be encoded using the

-current locale.  The
-communication with the client happens in UTF-8 (since the client and the server
-don't know what locale each other might be using - in the future they might not
-even be on the same host.)
+current locale.  Internally (within the server, in the database and in
+communication between client and server) the UTF-8 encoding is used.

 .SS Backups
 DisOrder uses Berkeley DB but currently discards log files that are no longer
 in use.  This means that DB's catastrophic recovery cannot be used (normal
 .SS Backups
 DisOrder uses Berkeley DB but currently discards log files that are no longer
 in use.  This means that DB's catastrophic recovery cannot be used (normal


@@ -126,8 +129,14 @@ Do not edit while the daemon is running.
 .I pkgstatedir/prefs.db
 Preferences database.
 .TP
 .I pkgstatedir/prefs.db
 Preferences database.
 .TP

+.I pkgstatedir/global.db
+Global preferences database.
+.TP

 .I pkgstatedir/search.db
 .I pkgstatedir/search.db

-Search database.
+Search lookup database.
+.TP
+.I pkgstatedir/tags.db
+Tag lookup database.

 .TP
 .I pkgstatedir/tracks.db
 Tracks database.
 .TP
 .I pkgstatedir/tracks.db
 Tracks database.


@@ -137,8 +146,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
 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).
 .TP
 .I pkgstatedir/socket
 Communication socket for \fBdisorder\fR(1).


@@ -146,12 +155,6 @@ Communication socket for \fBdisorder\fR(1).
 .I pkgstatedir/lock
 Lockfile.  This prevents multiple instances of DisOrder running
 simultaneously.
 .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
 .SH ENVIRONMENT
 .TP
 .B LC_ALL\fR, \fBLANG\fR, etc