Logging to opened file descriptor

[nncp.git] / doc / admin.texi

diff --git a/doc/admin.texi b/doc/admin.texi
index 8c46a681cd47483b4774ab9ba1289a957d2a94d3..86caeb9264f0c76ff5293845f97c51639e7d5966 100644 (file)
--- a/doc/admin.texi
+++ b/doc/admin.texi
@@ -20,6 +20,10 @@ NNCP uses following files/directories you should be aware of:
     Partly transferred files are stored with @file{.part} suffix. And
     possibly they also require cleanup if they are completely lost.
 
+    It can contain @file{.nock} files: fully downloaded, but still not
+    checksummed. Can be checksummed (with @file{.nock} extension removing)
+    with @command{nncp-check -nock}.
+
     Also it can contain @file{.seen} files, that should be cleaned too
     from time to time.
 
@@ -60,32 +64,30 @@ $ echo 'umask: "007"' >> /usr/local/etc/nncp.hjson
 
 @item
     Possibly long running @ref{nncp-daemon}, @ref{nncp-caller},
-    @ref{nncp-toss} daemons. As all software, they can fail and you
-    should place them under some supervisor control.
+    @ref{nncp-toss}, @ref{nncp-check} daemons. As all software, they can
+    fail and you should place them under some supervisor control.
 
     For example you can use @url{http://cr.yp.to/daemontools.html,
     daemontools} for that task to run them under probably existing
     @verb{|uucp|} user:
 
 @example
-# mkdir -p /var/service/nncp-toss/log
-# chmod 755 /var/service/nncp-toss/log /var/service/nncp-toss
-# cd /var/service/nncp-toss
+# mkdir -p /var/service/.nncp-toss/log
+# cd /var/service/.nncp-toss
 
-# cat > run_ <<EOF
+# cat > run <<EOF
 #!/bin/sh -e
 exec 2>&1
 exec setuidgid uucp /usr/local/bin/nncp-toss -cycle 10
 EOF
-# chmod 755 run_
 
-# cat > log/run_ <<EOF
+# cat > log/run <<EOF
 #!/bin/sh -e
 exec setuidgid uucp multilog t ./main
 EOF
-# chmod 755 log/run_
 
-# mv log/run_ log/run ; mv run_ run
+# chmod -R 755 /var/service/.nncp-toss
+# mv /var/service/.nncp-toss /var/service/nncp-toss
 @end example
 
 @item
@@ -93,7 +95,31 @@ EOF
     @url{https://en.wikipedia.org/wiki/Inetd, inetd} service on UUCP's port:
 
 @example
-uucp   stream  tcp6    nowait  nncpuser        /usr/local/bin/nncp-daemon      nncp-daemon -quiet -inetd
+uucp   stream  tcp6    nowait  nncpuser        /usr/local/bin/nncp-daemon      nncp-daemon -quiet -ucspi
+@end example
+
+@item
+    Or it can be also run as a @command{daemontools} daemon under
+    @url{http://cr.yp.to/ucspi-tcp.html, UCSPI-TCP}. In the example
+    below it uses native daemontools's logging capability:
+
+@example
+# mkdir -p /var/service/.nncp-daemon/log
+# cd /var/service/.nncp-daemon
+
+# cat > run <<EOF
+#!/bin/sh -e
+NNCPLOG=FD:4 exec envuidgid nncpuser tcpserver -DHRU -l 0 ::0 uucp \
+       /usr/local/bin/nncp-daemon -quiet -ucspi 4>&1
+EOF
+
+# cat > log/run <<EOF
+#!/bin/sh -e
+exec setuidgid uucp multilog ./main
+EOF
+
+# chmod -R 755 /var/service/.nncp-daemon
+# mv /var/service/.nncp-daemon /var/service/nncp-daemon
 @end example
 
 @end itemize