Imported Debian patch 1:1.05-8

[hcoop/zz_old/debian/djbdns.git] / debian / djbdns-man / dnscache-conf.8

diff --git a/debian/djbdns-man/dnscache-conf.8 b/debian/djbdns-man/dnscache-conf.8
new file mode 100644 (file)
index 0000000..ac87da9
--- /dev/null
+++ b/debian/djbdns-man/dnscache-conf.8
@@ -0,0 +1,140 @@
+.TH dnscache-conf 8
+
+.SH NAME
+dnscache-conf \- sets up a DNS cache service.
+
+.SH SYNOPSIS
+.B dnscache-conf 
+.I acct
+.I logacct
+.I D
+[
+.I ip
+]
+
+.SH DESCRIPTION
+This is a reference page.
+For tutorial information, see the instructions for
+.br
+.B workstations
+(http://cr.yp.to/djbdns/run-cache.html),
+.br
+.B home computers
+(http://cr.yp.to/djbdns/run-cache-home.html),
+.br
+.B external caches
+(http://cr.yp.to/djbdns/run-cache-x.html),
+or
+.br
+.B upgrading from BIND
+(http://cr.yp.to/djbdns/run-cache-bind-1.html).
+
+.B dnscache-conf
+creates a service directory 
+.I D
+that runs
+.BR dnscache (8).
+The name 
+.I D
+must start with a slash
+and must not contain any special characters.
+Normally 
+.I D
+is 
+.IR /etc/dnscache .
+
+You can run the service under
+.BR svscan (8)
+by using the
+.BR update-service (8)
+program on Debian GNU/Linux
+
+update-service --add
+.I D
+
+or by creating a symbolic link in the
+.BR svscan (8)
+directory (normally /service or /etc/service), e.g.:
+
+ln -s 
+.I D
+/service
+
+The service will start within five seconds,
+and will be restarted upon reboot.
+You can use
+.BR svc (8)
+to control the service.
+
+.B dnscache-conf
+arranges for 
+.BR dnscache (8)
+to chroot to 
+.IR D /root
+and to run under the uid and gid of 
+.IR acct .
+The name
+.I acct
+must not contain any special characters.
+
+.B dnscache-conf
+arranges for 
+.BR dnscache (8)
+to listen for UDP packets and TCP connections on port 53 of 
+.IR ip .
+
+.I ip
+is optional;
+if it is not supplied,
+.B dnscache-conf
+arranges for 
+.BR dnscache (8)
+to listen on 127.0.0.1.
+
+.B dnscache-conf
+creates 
+.IR D /root/ip/127.0.0.1
+so that 
+.BR dnscache (8)
+will accept queries from 127.0.0.1.
+
+.B dnscache-conf
+puts 128 bytes of not-particularly-secret data
+into 
+.IR D /seed
+and arranges for 
+.BR dnscache (8)
+to pass 
+.IR D /seed
+to 
+.BR dns_random_init (3).
+If your system has a good source of random data,
+you can replace 
+.IR D /seed
+with 128 bytes of data from that source.
+
+.B dnscache-conf
+creates an automatically rotated log directory in
+.IR D /log/main.
+The logs are owned by 
+.IR logacct .
+The corresponding 
+.BR multilog (8)
+processes run under the uid and gid of 
+.IR logacct .
+The name 
+.I logacct
+must not contain any special characters.
+
+.SH SEE ALSO
+dnscache(8),
+svscan(8),
+svc(8),
+multilog(8),
+axfrdns-conf(8),
+rbldns-conf(8),
+tinydns-conf(8),
+walldns-conf(8),
+update-service(8)
+
+http://cr.yp.to/djbdns.html