mirror of https://github.com/getdnsapi/getdns.git
Fix and add check for manpage-has-bad-whatis-entry
Also remove obsolete getdns_free_sync_request_memory function Also list all authors in libgetdns manpage
This commit is contained in:
parent
46557a93dc
commit
cdf0921ced
|
@ -47,7 +47,7 @@ EDITS=-e 's/@''version@/$(version)/g'
|
||||||
DOXYGEN = @DOXYGEN@
|
DOXYGEN = @DOXYGEN@
|
||||||
|
|
||||||
DOCDIRS = html latex man
|
DOCDIRS = html latex man
|
||||||
MANPAGES3 = libgetdns.3 getdns_address.3 getdns_cancel_callback.3 getdns_context.3 getdns_context_set.3 getdns_context_set_context_update_callback.3 getdns_convert.3 getdns_dict.3 getdns_dict_get.3 getdns_dict_set.3 getdns_display_ip_address.3 getdns_free_sync_request_memory.3 getdns_general.3 getdns_hostname.3 getdns_list.3 getdns_list_get.3 getdns_list_set.3 getdns_pretty_print_dict.3 getdns_root_trust_anchor.3 getdns_service.3 getdns_validate_dnssec.3
|
MANPAGES3 = libgetdns.3 getdns_address.3 getdns_cancel_callback.3 getdns_context.3 getdns_context_set.3 getdns_context_set_context_update_callback.3 getdns_convert.3 getdns_dict.3 getdns_dict_get.3 getdns_dict_set.3 getdns_display_ip_address.3 getdns_general.3 getdns_hostname.3 getdns_list.3 getdns_list_get.3 getdns_list_set.3 getdns_pretty_print_dict.3 getdns_root_trust_anchor.3 getdns_service.3 getdns_validate_dnssec.3
|
||||||
|
|
||||||
default: all
|
default: all
|
||||||
|
|
||||||
|
@ -68,7 +68,7 @@ install: $(MANPAGES3)
|
||||||
for x in $(MANPAGES3); do echo $(INSTALL) -m 644 $$x $(DESTDIR)$(mandir)/man3; $(INSTALL) -m 644 $$x $(DESTDIR)$(mandir)/man3; for altpg in $$($(srcdir)/manpgaltnames $$x); do cp $$x $$altpg; echo $(INSTALL) -m 644 $$altpg $(DESTDIR)$(mandir)/man3; $(INSTALL) -m 644 $$altpg $(DESTDIR)$(mandir)/man3; done; done
|
for x in $(MANPAGES3); do echo $(INSTALL) -m 644 $$x $(DESTDIR)$(mandir)/man3; $(INSTALL) -m 644 $$x $(DESTDIR)$(mandir)/man3; for altpg in $$($(srcdir)/manpgaltnames $$x); do cp $$x $$altpg; echo $(INSTALL) -m 644 $$altpg $(DESTDIR)$(mandir)/man3; $(INSTALL) -m 644 $$altpg $(DESTDIR)$(mandir)/man3; done; done
|
||||||
|
|
||||||
check: $(MANPAGES3)
|
check: $(MANPAGES3)
|
||||||
for x in $(MANPAGES3); do LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z $$x 2>&1 >/dev/null | awk "-vpage=$$x" '{printf("%s: ", page);print}'; done
|
for x in $(MANPAGES3); do LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z $$x 2>&1 >/dev/null | awk "-vpage=$$x" '{printf("%s: ", page);print}'; if ! lexgrog $$x >/dev/null 2>&1 ; then echo $$x: manpage-has-bad-whatis-entry; fi; done
|
||||||
|
|
||||||
uninstall:
|
uninstall:
|
||||||
for x in $(MANPAGES3); do echo rm -f $(DESTDIR)$(mandir)/man3/$$x; rm -f $(DESTDIR)$(mandir)/man3/$$x; for altpg in $$($(srcdir)/manpgaltnames $$x); do echo rm -f $(DESTDIR)$(mandir)/man3/$$altpg; rm -f $(DESTDIR)$(mandir)/man3/$$altpg; done; done
|
for x in $(MANPAGES3); do echo rm -f $(DESTDIR)$(mandir)/man3/$$x; rm -f $(DESTDIR)$(mandir)/man3/$$x; for altpg in $$($(srcdir)/manpgaltnames $$x); do echo rm -f $(DESTDIR)$(mandir)/man3/$$altpg; rm -f $(DESTDIR)$(mandir)/man3/$$altpg; done; done
|
||||||
|
|
|
@ -30,6 +30,7 @@
|
||||||
.SH NAME
|
.SH NAME
|
||||||
.B getdns_address,
|
.B getdns_address,
|
||||||
.B getdns_address_sync
|
.B getdns_address_sync
|
||||||
|
-- get ip address(es) for a name
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -29,6 +29,7 @@
|
||||||
.TH getdns_cancel_callback 3 "@date@" "getdns @version@" getdns
|
.TH getdns_cancel_callback 3 "@date@" "getdns @version@" getdns
|
||||||
.SH NAME
|
.SH NAME
|
||||||
.B getdns_cancel_callback
|
.B getdns_cancel_callback
|
||||||
|
-- cancel an outstanding asyn getdns request
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -29,6 +29,7 @@
|
||||||
.TH getdns_context_set_context_update_callback 3 "@date@" "getdns @version@" getdns
|
.TH getdns_context_set_context_update_callback 3 "@date@" "getdns @version@" getdns
|
||||||
.SH NAME
|
.SH NAME
|
||||||
.B getdns_context_set_context_update_callback
|
.B getdns_context_set_context_update_callback
|
||||||
|
-- get informed on getdns context updates
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -31,6 +31,7 @@
|
||||||
.B getdns_convert,
|
.B getdns_convert,
|
||||||
.B getdns_convert_dns_name_to_fqdn,
|
.B getdns_convert_dns_name_to_fqdn,
|
||||||
.B getdns_convert_fqdn_to_dns_name
|
.B getdns_convert_fqdn_to_dns_name
|
||||||
|
-- convert dname between presentation- and wire-format
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -33,6 +33,7 @@
|
||||||
.B getdns_dict_create_with_extended_memory_functions,
|
.B getdns_dict_create_with_extended_memory_functions,
|
||||||
.B getdns_dict_create_with_memory_functions,
|
.B getdns_dict_create_with_memory_functions,
|
||||||
.B getdns_dict_destroy
|
.B getdns_dict_destroy
|
||||||
|
-- getdns dict create and destroy routines
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -35,6 +35,7 @@
|
||||||
.B getdns_dict_get_int,
|
.B getdns_dict_get_int,
|
||||||
.B getdns_dict_get_list,
|
.B getdns_dict_get_list,
|
||||||
.B getdns_dict_get_names
|
.B getdns_dict_get_names
|
||||||
|
-- get value by name from a getdns dict
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -33,6 +33,7 @@
|
||||||
.B getdns_dict_set_dict,
|
.B getdns_dict_set_dict,
|
||||||
.B getdns_dict_set_int,
|
.B getdns_dict_set_int,
|
||||||
.B getdns_dict_set_list,
|
.B getdns_dict_set_list,
|
||||||
|
-- set a value by name in a getdns dict
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -29,6 +29,7 @@
|
||||||
.TH getdns_display_ip_address 3 "@date@" "getdns @version@" getdns
|
.TH getdns_display_ip_address 3 "@date@" "getdns @version@" getdns
|
||||||
.SH NAME
|
.SH NAME
|
||||||
.B getdns_display_ip_address
|
.B getdns_display_ip_address
|
||||||
|
-- convert an getdns ip address to string
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -1,75 +0,0 @@
|
||||||
.\" The "BSD-New" License
|
|
||||||
.\"
|
|
||||||
.\" Copyright (c) 2013, NLNet Labs, Verisign, Inc.
|
|
||||||
.\" 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.
|
|
||||||
.\" * Neither the names of the copyright holders nor the
|
|
||||||
.\" names of its contributors may 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 Verisign, Inc. 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.
|
|
||||||
.\"
|
|
||||||
|
|
||||||
.TH getdns_free_sync_request_memory 3 "@date@" "getdns @version@" getdns
|
|
||||||
.SH NAME
|
|
||||||
.B getdns_free_sync_request_memory
|
|
||||||
|
|
||||||
.SH LIBRARY
|
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
|
||||||
|
|
||||||
.SH SYNOPSIS
|
|
||||||
#include <getdns.h>
|
|
||||||
|
|
||||||
getdns_return_t
|
|
||||||
.br
|
|
||||||
.B getdns_free_sync_request_memory
|
|
||||||
(getdns_dict *response)
|
|
||||||
|
|
||||||
.SH DESCRIPTION
|
|
||||||
|
|
||||||
.LP
|
|
||||||
This function is used to free memory allocated within one of the synchronous functions.
|
|
||||||
|
|
||||||
.HP 3
|
|
||||||
.I response
|
|
||||||
A previously allocated response object.
|
|
||||||
|
|
||||||
.HP
|
|
||||||
.SH "RETURN VALUES"
|
|
||||||
|
|
||||||
Upon successful completion the function returns
|
|
||||||
.B GETDNS_RETURN_GOOD
|
|
||||||
|
|
||||||
.SH EXAMPLES
|
|
||||||
|
|
||||||
TBD
|
|
||||||
|
|
||||||
.SH FILES
|
|
||||||
.br
|
|
||||||
/etc/hosts
|
|
||||||
.br
|
|
||||||
/etc/resolv.conf
|
|
||||||
|
|
||||||
.SH SEE ALSO
|
|
||||||
.BR libgetdns (3),
|
|
||||||
.BR getdns_address_sync (3),
|
|
||||||
.BR getdns_general_sync (3),
|
|
||||||
.BR getdns_hostname_sync (3),
|
|
||||||
.BR getdns_service_sync (3)
|
|
||||||
|
|
|
@ -30,6 +30,7 @@
|
||||||
.SH NAME
|
.SH NAME
|
||||||
.B getdns_general,
|
.B getdns_general,
|
||||||
.B getdns_general_sync
|
.B getdns_general_sync
|
||||||
|
-- do a getdns DNS lookup
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -30,6 +30,7 @@
|
||||||
.SH NAME
|
.SH NAME
|
||||||
.B getdns_hostname,
|
.B getdns_hostname,
|
||||||
.B getdns_hostname_sync
|
.B getdns_hostname_sync
|
||||||
|
-- get hostname by address
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -33,6 +33,7 @@
|
||||||
.B getdns_list_create_with_extended_memory_functions,
|
.B getdns_list_create_with_extended_memory_functions,
|
||||||
.B getdns_list_create_with_memory_functions,
|
.B getdns_list_create_with_memory_functions,
|
||||||
.B getdns_list_destroy
|
.B getdns_list_destroy
|
||||||
|
-- getdns list create and destroy routines
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -35,6 +35,7 @@
|
||||||
.B getdns_list_get_length,
|
.B getdns_list_get_length,
|
||||||
.B getdns_list_get_list,
|
.B getdns_list_get_list,
|
||||||
.B getdns_list_get_int
|
.B getdns_list_get_int
|
||||||
|
-- get a value by index from a getdns list
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -33,6 +33,7 @@
|
||||||
.B getdns_list_set_dict,
|
.B getdns_list_set_dict,
|
||||||
.B getdns_list_set_int,
|
.B getdns_list_set_int,
|
||||||
.B getdns_list_set_list,
|
.B getdns_list_set_list,
|
||||||
|
-- set a value by index from a getdns list
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -29,6 +29,7 @@
|
||||||
.TH getdns_pretty_print_dict 3 "@date@" "getdns @version@" getdns
|
.TH getdns_pretty_print_dict 3 "@date@" "getdns @version@" getdns
|
||||||
.SH NAME
|
.SH NAME
|
||||||
.B getdns_pretty_print_dict
|
.B getdns_pretty_print_dict
|
||||||
|
-- return a string representation of a getdns dict
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -29,6 +29,7 @@
|
||||||
.TH getdns_root_trust_anchor 3 "@date@" "getdns @version@" getdns
|
.TH getdns_root_trust_anchor 3 "@date@" "getdns @version@" getdns
|
||||||
.SH NAME
|
.SH NAME
|
||||||
.B getdns_root_trust_anchor
|
.B getdns_root_trust_anchor
|
||||||
|
-- return the getdns list of default root trust anchors
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -30,6 +30,7 @@
|
||||||
.SH NAME
|
.SH NAME
|
||||||
.B getdns_service,
|
.B getdns_service,
|
||||||
.B getdns_service_sync
|
.B getdns_service_sync
|
||||||
|
-- getdns lookup of a service
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -29,6 +29,7 @@
|
||||||
.TH getdns_validate_dnssec 3 "@date@" "getdns @version@" getdns
|
.TH getdns_validate_dnssec 3 "@date@" "getdns @version@" getdns
|
||||||
.SH NAME
|
.SH NAME
|
||||||
.B getdns_validate_dnssec
|
.B getdns_validate_dnssec
|
||||||
|
-- DNSSEC validate a given getdns record
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
|
@ -29,6 +29,8 @@
|
||||||
.TH libgetdns 3 "@date@" "getdns @version@" getdns
|
.TH libgetdns 3 "@date@" "getdns @version@" getdns
|
||||||
.SH NAME
|
.SH NAME
|
||||||
libgetdns
|
libgetdns
|
||||||
|
-- an implementation of a modern asynchronous DNS API by and for application developers
|
||||||
|
|
||||||
.SH LIBRARY
|
.SH LIBRARY
|
||||||
DNS Resolver library (libgetdns, -lgetdns)
|
DNS Resolver library (libgetdns, -lgetdns)
|
||||||
|
|
||||||
|
@ -699,14 +701,26 @@ The getdns API was documented by Paul Hoffman. This implementation of the getdn
|
||||||
.LP
|
.LP
|
||||||
.RS 3
|
.RS 3
|
||||||
.br
|
.br
|
||||||
Carig Despeaux, Verisign Inc.
|
Craig Despeaux, Verisign Inc.
|
||||||
|
.br
|
||||||
|
John Dickinson, Sinodun
|
||||||
|
.br
|
||||||
|
Sara Dickinson, Sinodun
|
||||||
.br
|
.br
|
||||||
Neel Goyal, Verisign Inc.
|
Neel Goyal, Verisign Inc.
|
||||||
.br
|
.br
|
||||||
Melinda Shore, No Mountain Software, LLC
|
Shumon Huque, Verisign Labs
|
||||||
|
.br
|
||||||
|
Olaf Kolkman, NLnet Labs
|
||||||
|
.br
|
||||||
|
Allison Mankin, Verisign Inc. - Verisign Labs.
|
||||||
|
.br
|
||||||
|
Melinda Shore, No Mountain Software LLC
|
||||||
.br
|
.br
|
||||||
Willem Toorop, NLnet Labs
|
Willem Toorop, NLnet Labs
|
||||||
.br
|
.br
|
||||||
|
Gowri Visweswaran, Verisign Labs
|
||||||
|
.br
|
||||||
Wouter Wijngaards, NLnet Labs
|
Wouter Wijngaards, NLnet Labs
|
||||||
.br
|
.br
|
||||||
Glen Wiley, Verisign Inc.
|
Glen Wiley, Verisign Inc.
|
||||||
|
|
Loading…
Reference in New Issue