Sync usage with man page.
[netbsd-mini2440.git] / external / bsd / libbind / dist / README
blob2b3f7b593180d623eacccddeb49f64234dac85d0
1 Introduction
3         ISC's libbind provides the standard resolver library,
4         along with header files and documentation, for communicating
5         with domain name servers, retrieving network host entries
6         from /etc/hosts or via DNS, converting CIDR network addresses,
7         perform Hesiod information lookups, retrieve network entries
8         from /etc/networks, implement TSIG transaction/request
9         security of DNS messages, perform name-to-address and
10         address-to-name translations, utilize /etc/resolv.conf
11         for resolver configuration.
13         It contains many of the same historical functions and headers
14         included with many Unix operating systems.
16         Originally written for BIND 8, it was included in BIND 9 as
17         optionally-compiled code through release 9.5.  It has been
18         removed from subsequent releases of BIND 9 and is now
19         provided as a separate package.
21 Building
23         The libbind library requires a system with an ANSI C compiler
24         and basic POSIX support.
26         To build, just
28                 ./configure
29                 make
31         Several environment variables that can be set before running
32         configure will affect compilation:
34             CC
35                 The C compiler to use.  configure tries to figure
36                 out the right one for supported systems.
38             CFLAGS
39                 C compiler flags.  Defaults to include -g and/or -O2
40                 as supported by the compiler.  
42             STD_CINCLUDES
43                 System header file directories.  Can be used to specify
44                 where add-on thread or IPv6 support is, for example.
45                 Defaults to empty string.
47             STD_CDEFINES
48                 Any additional preprocessor symbols you want defined.
49                 Defaults to empty string.
51                 Possible settings:
52                 Change the default syslog facility of named/lwresd.
53                   -DISC_FACILITY=LOG_LOCAL0     
54                 Enable DNSSEC signature chasing support in dig.
55                   -DDIG_SIGCHASE=1 (sets -DDIG_SIGCHASE_TD=1 and
56                                     -DDIG_SIGCHASE_BU=1)
57                 Disable dropping queries from particular well known ports.
58                   -DNS_CLIENT_DROPPORT=0
59                 Sibling glue checking in named-checkzone is enabled by default.
60                 To disable the default check set.  -DCHECK_SIBLING=0
61                 named-checkzone checks out-of-zone addresses by default.
62                 To disable this default set.  -DCHECK_LOCAL=0
63                 Enable workaround for Solaris kernel bug about /dev/poll
64                   -DISC_SOCKET_USE_POLLWATCH=1
65                   The watch timeout is also configurable, e.g.,
66                   -DISC_SOCKET_POLLWATCH_TIMEOUT=20
68             LDFLAGS
69                 Linker flags. Defaults to empty string.
71         The following need to be set when cross compiling.
73             BUILD_CC
74                 The native C compiler.
75             BUILD_CFLAGS (optional)
76             BUILD_CPPFLAGS (optional)
77                 Possible Settings:
78                 -DNEED_OPTARG=1         (optarg is not declared in <unistd.h>)
79             BUILD_LDFLAGS (optional)
80             BUILD_LIBS (optional)
82         "make install" will install the library.  By default, installation
83         is into /usr/local, but this can be changed with the "--prefix"
84         option when running "configure".
86         To see additional configure options, run "configure --help".
88         If you need to re-run configure please run "make distclean" first.
89         This will ensure that all the option changes take.
91 Notes on Usage
93         - Installing both libbind and BIND 9 on the same system
94           will produce two incompatible header files with similar
95           names: $PREFIX/include/isc/list.h (from BIND 9) and
96           $PREFIX/include/bind/isc/list.h (from libbind).  When
97           compiling code against libbind, be sure to set -I flags
98           appropriately.
100 Documentation
102         Man pages for libbind routines, in *roff and plaintext format,
103         are included with the release.
105 Bug Reports and Mailing Lists
107         Bugs reports should be sent to
109                 libbind-bugs@isc.org
111         Discussions of libbind can be send to the BIND Users mailing
112         list.  To subscribe, send mail to:
114                 bind-users-subscribe@isc.org
116         Archives of that list can be found at:
118                 https://lists.isc.org/pipermail/bind-users/
120         If you're planning on making changes to the libbind source
121         code, you might want to join the BIND Workers mailing list.
122         To subscribe, send mail to:
124                 bind-workers-subscribe@isc.org