Add documentation and copyrights

1 files changed, 86 insertions, 0 deletions

diff --git a/doc/notify-dns-slaves.1 b/doc/notify-dns-slaves.1
new file mode 100644
index 0000000..4ee4d55
--- /dev/null
+++ b/doc/notify-dns-slaves.1
@@ -0,0 +1,86 @@
+.\" 
+.\" Copyright (c) 2008, Stef Walter
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without 
+.\" modification, are permitted provided that the following conditions 
+.\" are met:
+.\" 
+.\"     * Redistributions of source code must retain the above 
+.\"       copyright notice, this list of conditions and the 
+.\"       following disclaimer.
+.\"     * Redistributions in binary form must reproduce the 
+.\"       above copyright notice, this list of conditions and 
+.\"       the following disclaimer in the documentation and/or 
+.\"       other materials provided with the distribution.
+.\"     * The names of contributors to this software may not be 
+.\"       used to endorse or promote products derived from this 
+.\"       software without specific prior written permission.
+.\" 
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
+.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
+.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
+.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
+.\" COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
+.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
+.\" OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 
+.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
+.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
+.\" THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 
+.\" DAMAGE.
+.\" 
+.\"
+.\" CONTRIBUTORS
+.\"  Stef Walter <stef@memberwebs.com>
+.\"
+.Dd June, 2008
+.Dt notify-dns-slaves
+.Os slapi-dnsnotify 
+.Sh NAME
+.Nm notify-dns-slaves
+.Nd is a tool which can notify DNS slaves to update their copy of 
+a DNS zone. 
+.Sh SYNOPSIS
+.Nm
+.Fl s 
+.Op Fl w Ar wait
+.Op Fl d Ar level
+.Nm
+.Op Fl d Ar level
+zone server ...
+.Sh DESCRIPTION
+.Nm 
+is used by the  
+.Xr slapi-dnsnotify 8
+LDAP plugin to send out notifications that DNS zones have been updated.
+.Pp
+It can also be used directly as a tool. The zone to send notifications about, 
+and servers to notify are specified on the command line. 
+.Pp
+When used with the 
+.Fl s
+option the tool goes into 'slave' mode. It remains running it expects specially 
+formatted requests on stdin. When in 'slave' mode, logging goes to syslog under
+the 
+.Em daemon 
+facility.  
+.Sh OPTIONS
+.Bl -tag -width Fl
+.It Fl d Ar level 
+Specifies what level of messages to display. 0 has only errors
+and warnings, with 4 being the most verbose.
+.It Fl s
+Work in 'slave' mode. Requests are expected on stdin. Used by the 
+.Xr slapi-dnsnotify 8
+plugin to send out notifications. 
+.It Fl w Ar wait
+When in 'slave' mode, the number of seconds to wait before sending
+out DNS notifications. This is usually controlled with the 
+.Em notify-delay
+option to 
+.Xr slapi-dnsnotify 8
+.Sh SEE ALSO
+.Xr slapi-dnsnotify 8
+.Sh AUTHOR
+.An Stef Walter Aq stef@memberwebs.com