From: Miek Gieben <miekg@NLnetLabs.nl>
Date: Wed, 27 Apr 2005 11:45:13 +0000 (+0000)
Subject: documentation, license and other stuff
X-Git-Tag: release-0.50~64
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=35fbedcb1ee940171079a815c2bd1b0cf059a22b;p=thirdparty%2Fldns.git

documentation, license and other stuff
---

diff --git a/COMPILE b/COMPILE
new file mode 100644
index 00000000..61567841
--- /dev/null
+++ b/COMPILE
@@ -0,0 +1,16 @@
+* Development
+
+ldns development is ongoing. Most of the functionality is there, but some
+DNSSEC pieces are missing.
+
+Feedback is appriciated.
+
+* Compilation
+
+When getting this source as snapshot you need to compile it first.
+For compilation you need gmake.
+
+Extract the source and in the source directory:
+libtoolize && autoreconf && ./configure && gmake
+
+(or just make on Linux)
diff --git a/Makefile.in b/Makefile.in
index a38cfbee..807986bf 100644
--- a/Makefile.in
+++ b/Makefile.in
@@ -79,7 +79,7 @@ lib:		$(LIBDNS_OBJECTS) b64_pton$U.o b64_ntop$U.o
 # this breaks: configure --disable-shared
 		mv -f .libs/libldns.so* ./
 	
-snapshot:	clean testclean
+snapshot:	realclean testclean
 		(rm -rf ../ldns-snap-$(DATE)/)
 		(cd .. ; cp -r $(basesrcdir)/ ldns-snap-$(DATE)/)
 		(cd .. ; tar --verbose  --exclude ".svn" --create --file ldns-snap-$(DATE).tar.gz --gzip ldns-snap-$(DATE)/)
@@ -139,7 +139,6 @@ libclean:
 	rm -rf .libs
 	rm -rf libtool
 
-
 test7: run-test7
 	./run-test7
 test11: run-test11
diff --git a/README b/README
new file mode 100644
index 00000000..ab8c86c5
--- /dev/null
+++ b/README
@@ -0,0 +1,2 @@
+Some general readme information would be nice. Most up to date is 
+website: www.nlnetlabs.nl/ldns/
diff --git a/README-snapshots b/README-snapshots
index 1b1c824b..4b4467bf 100644
--- a/README-snapshots
+++ b/README-snapshots
@@ -8,6 +8,4 @@ INSTALLATION
 2. cd ldns-snap-<DATE>
 3. ./configure
 4. gmake (it needs gnu make to compile)
-
-After this some test executables are created; run-test[1-8]. These
-are used in development, but can also be used as a basis for development.
+(5. gmake mx chaos [two example programs included]
diff --git a/SHOWSTOPPERS b/SHOWSTOPPERS
deleted file mode 100644
index 987a583e..00000000
--- a/SHOWSTOPPERS
+++ /dev/null
@@ -1,6 +0,0 @@
-::0 is printed as ::
-	any ip6 addr with closing 0 is not printed correctly
-
----
-
-XMALLOC return code checking (bail out?!!?) extra function
diff --git a/chaos.c b/chaos.c
index 96f513a7..a9a97fac 100644
--- a/chaos.c
+++ b/chaos.c
@@ -1,6 +1,9 @@
 /*
  * chaos is a small programs that prints some information
  * about a nameserver
+ * (c) NLnet Labs, 2005
+ *
+ * Licensed under the GPL version 2
  */
 
 #include <stdio.h>
diff --git a/doc/chaos.1 b/doc/chaos.1
new file mode 100644
index 00000000..2046c19b
--- /dev/null
+++ b/doc/chaos.1
@@ -0,0 +1,26 @@
+.TH chaos 1 "27 Apr 2005"
+.SH NAME
+chaos \- give some information about a nameserver
+.SH SYNOPSIS
+.B chaos
+.IR NAMESERVER
+
+.SH DESCRIPTION
+\fBchaos\fR retrieves all the addresses of the nameserver and then queries
+each address for its \fIversion.bind\fR and \fIhostname.bind\fR.
+.PP
+\fBchaos\fR is a bit more complex than \fBmx\fR.
+
+.SH OPTIONS
+\fBchaos\fR has no options.
+
+.SH AUTHOR
+Written by the ldns team as an example for ldns usage.
+
+.SH REPORTING BUGS
+Report bugs to <ldns-team@nlnetlabs.nl>. 
+
+.SH COPYRIGHT
+Copyright (C) 2005 NLnet Labs. This is free software. There is NO
+warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
+PURPOSE.
diff --git a/doc/mx.1 b/doc/mx.1
new file mode 100644
index 00000000..8ef1a7ab
--- /dev/null
+++ b/doc/mx.1
@@ -0,0 +1,23 @@
+.TH mx 1 "27 Apr 2005"
+.SH NAME
+mx \- print out the mx record(s) for a domain
+.SH SYNOPSIS
+.B mx
+.IR DOMAIN 
+
+.SH DESCRIPTION
+\fBmx\fR is used to print out mx information of a domain.
+
+.SH OPTIONS
+\fBmx\fR has no options.
+
+.SH AUTHOR
+Written by the ldns team as an example for ldns usage.
+
+.SH REPORTING BUGS
+Report bugs to <ldns-team@nlnetlabs.nl>. 
+
+.SH COPYRIGHT
+Copyright (C) 2005 NLnet Labs. This is free software. There is NO
+warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
+PURPOSE.
diff --git a/mx.c b/mx.c
index 65731947..e9a764e3 100644
--- a/mx.c
+++ b/mx.c
@@ -1,6 +1,8 @@
 /*
  * mx is a small programs that prints out the mx records
  * for a particulary domain
+ * (c) NLnet Labs, 2005
+ * Licensed under the GPL version 2
  */
 
 #include <stdio.h>