From 2a312bee887b51bc70483d2ec7d4d37e88dd8371 Mon Sep 17 00:00:00 2001 From: Willem Toorop Date: Thu, 22 Sep 2011 12:49:36 +0000 Subject: [PATCH] A man page for ldns-config (make PW happy :) + documentation of the '-b' option in the ldns-sign-zone manpage. --- Makefile.in | 12 +++++++++-- examples/ldns-signzone.1 | 10 ++++++++++ packaging/ldns-config.1 | 43 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 63 insertions(+), 2 deletions(-) create mode 100644 packaging/ldns-config.1 diff --git a/Makefile.in b/Makefile.in index d0234aa0..f05aa4f5 100644 --- a/Makefile.in +++ b/Makefile.in @@ -199,8 +199,8 @@ destclean: uninstall install-config: if [ $(INSTALL_LDNS_CONFIG) = "yes" ] ; then \ - $(INSTALL) -d $(DESTDIR)$(bindir); \ - $(INSTALL) -c -m 755 packaging/ldns-config $(DESTDIR)$(bindir)/; \ + $(INSTALL) -d $(DESTDIR)$(bindir) \ + $(INSTALL) -c -m 755 packaging/ldns-config $(DESTDIR)$(bindir)/ \ fi uninstall-config: @@ -214,11 +214,19 @@ install-manpages: manpages for f in doc/man/man3/*; do \ ${INSTALL} -c -m 444 $$f $(DESTDIR)$(mandir)/man3/; \ done + if [ $(INSTALL_LDNS_CONFIG) = "yes" ] ; then \ + ${INSTALL} -d $(DESTDIR)$(mandir)/man1 \ + ${INSTALL} -c -m 444 packaging/ldns-config.1 $(DESTDIR)$(mandir)/man1/ \ + fi uninstall-manpages: for i in `cat doc/ldns_manpages`; do \ rm -f $(DESTDIR)$(mandir)/man3/$$i.3 ; done rmdir -p $(DESTDIR)$(mandir)/man3 || echo "ok, dir already gone" + if [ $(INSTALL_LDNS_CONFIG) = "yes" ] ; then \ + rm -f $(DESTDIR)$(mandir)/man1/ldns-config.1 \ + [ ! -d $(DESTDIR)$(mandir)/man1 ] || rmdir -p $(DESTDIR)$(mandir)/man1 || echo "ok, dir already gone"; \ + fi install-h: lib $(INSTALL) -m 755 -d $(DESTDIR)$(includedir)/ldns diff --git a/examples/ldns-signzone.1 b/examples/ldns-signzone.1 index 0ac7c809..28a5f339 100644 --- a/examples/ldns-signzone.1 +++ b/examples/ldns-signzone.1 @@ -30,6 +30,16 @@ they are either already present in the zone, or specified in a .key file, and have the KSK bit set. .SH OPTIONS +.TP +\fB-b\fR +Augments the zone and the RR's with extra comment texts for a more readable +layout, easier to debug. DS records will have a bubblebabble version of +the data in the comment text, NSEC3 records will have the original NSEC3 +in the comment text. + +Without this option, only DNSKEY RR's will have their Key Tag annotated in +the comment text. + .TP \fB-d\fR Normally, if the DNSKEY RR for a key that is used to sign the zone is diff --git a/packaging/ldns-config.1 b/packaging/ldns-config.1 new file mode 100644 index 00000000..7638544a --- /dev/null +++ b/packaging/ldns-config.1 @@ -0,0 +1,43 @@ +.TH ldns-config 1 "22 Sep 2011" +.SH NAME +ldns-config \- show compiler and linker flags for ldns usage. +.SH SYNOPSIS +.B ldns-config +[ +.IR OPTIONS +] + +.SH DESCRIPTION +When writing programs using ldns, you have to tell the compiler +where to look for include files and what libraries from which location +to link to. \fBldns-config\fR can be used to find out what flags to use +with the C compiler and the linker for that. + +.SH OPTIONS +.TP +\fB--cflags\fR +Show the C compiler flags need to compile with ldns + +.TP +\fB--libs\fR +Show the flags to be used to link with ldns + +.TP +\fB--version\fR +Shows the version of the installed ldns library + +.TP +\fB--help\fR +Show \fBldns-config\fR usage description + +.SH AUTHOR +Written by the ldns team. + +.SH REPORTING BUGS +Report bugs to . + +.SH COPYRIGHT +Copyright (C) 2011 NLnet Labs. This is free software. There is NO +warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR +PURPOSE. + -- 2.47.3