/contrib/bind9/bin/named/lwresd.8

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 223 lines · 223 code · 0 blank · 0 comment · 0 complexity · 1d76bdac178dd51af4e4245739c106d1 MD5 · raw file

  1. .\" Copyright (C) 2004, 2005, 2007-2009 Internet Systems Consortium, Inc. ("ISC")
  2. .\" Copyright (C) 2000, 2001 Internet Software Consortium.
  3. .\"
  4. .\" Permission to use, copy, modify, and/or distribute this software for any
  5. .\" purpose with or without fee is hereby granted, provided that the above
  6. .\" copyright notice and this permission notice appear in all copies.
  7. .\"
  8. .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  9. .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10. .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11. .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12. .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13. .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14. .\" PERFORMANCE OF THIS SOFTWARE.
  15. .\"
  16. .\" $Id$
  17. .\"
  18. .hy 0
  19. .ad l
  20. .\" Title: lwresd
  21. .\" Author:
  22. .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  23. .\" Date: June 30, 2000
  24. .\" Manual: BIND9
  25. .\" Source: BIND9
  26. .\"
  27. .TH "LWRESD" "8" "June 30, 2000" "BIND9" "BIND9"
  28. .\" disable hyphenation
  29. .nh
  30. .\" disable justification (adjust text to left margin only)
  31. .ad l
  32. .SH "NAME"
  33. lwresd \- lightweight resolver daemon
  34. .SH "SYNOPSIS"
  35. .HP 7
  36. \fBlwresd\fR [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-C\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-d\ \fR\fB\fIdebug\-level\fR\fR] [\fB\-f\fR] [\fB\-g\fR] [\fB\-i\ \fR\fB\fIpid\-file\fR\fR] [\fB\-m\ \fR\fB\fIflag\fR\fR] [\fB\-n\ \fR\fB\fI#cpus\fR\fR] [\fB\-P\ \fR\fB\fIport\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-s\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\fR] [\fB\-4\fR] [\fB\-6\fR]
  37. .SH "DESCRIPTION"
  38. .PP
  39. \fBlwresd\fR
  40. is the daemon providing name lookup services to clients that use the BIND 9 lightweight resolver library. It is essentially a stripped\-down, caching\-only name server that answers queries using the BIND 9 lightweight resolver protocol rather than the DNS protocol.
  41. .PP
  42. \fBlwresd\fR
  43. listens for resolver queries on a UDP port on the IPv4 loopback interface, 127.0.0.1. This means that
  44. \fBlwresd\fR
  45. can only be used by processes running on the local machine. By default, UDP port number 921 is used for lightweight resolver requests and responses.
  46. .PP
  47. Incoming lightweight resolver requests are decoded by the server which then resolves them using the DNS protocol. When the DNS lookup completes,
  48. \fBlwresd\fR
  49. encodes the answers in the lightweight resolver format and returns them to the client that made the request.
  50. .PP
  51. If
  52. \fI/etc/resolv.conf\fR
  53. contains any
  54. \fBnameserver\fR
  55. entries,
  56. \fBlwresd\fR
  57. sends recursive DNS queries to those servers. This is similar to the use of forwarders in a caching name server. If no
  58. \fBnameserver\fR
  59. entries are present, or if forwarding fails,
  60. \fBlwresd\fR
  61. resolves the queries autonomously starting at the root name servers, using a built\-in list of root server hints.
  62. .SH "OPTIONS"
  63. .PP
  64. \-4
  65. .RS 4
  66. Use IPv4 only even if the host machine is capable of IPv6.
  67. \fB\-4\fR
  68. and
  69. \fB\-6\fR
  70. are mutually exclusive.
  71. .RE
  72. .PP
  73. \-6
  74. .RS 4
  75. Use IPv6 only even if the host machine is capable of IPv4.
  76. \fB\-4\fR
  77. and
  78. \fB\-6\fR
  79. are mutually exclusive.
  80. .RE
  81. .PP
  82. \-c \fIconfig\-file\fR
  83. .RS 4
  84. Use
  85. \fIconfig\-file\fR
  86. as the configuration file instead of the default,
  87. \fI/etc/lwresd.conf\fR.
  88. \fB\-c\fR
  89. can not be used with
  90. \fB\-C\fR.
  91. .RE
  92. .PP
  93. \-C \fIconfig\-file\fR
  94. .RS 4
  95. Use
  96. \fIconfig\-file\fR
  97. as the configuration file instead of the default,
  98. \fI/etc/resolv.conf\fR.
  99. \fB\-C\fR
  100. can not be used with
  101. \fB\-c\fR.
  102. .RE
  103. .PP
  104. \-d \fIdebug\-level\fR
  105. .RS 4
  106. Set the daemon's debug level to
  107. \fIdebug\-level\fR. Debugging traces from
  108. \fBlwresd\fR
  109. become more verbose as the debug level increases.
  110. .RE
  111. .PP
  112. \-f
  113. .RS 4
  114. Run the server in the foreground (i.e. do not daemonize).
  115. .RE
  116. .PP
  117. \-g
  118. .RS 4
  119. Run the server in the foreground and force all logging to
  120. \fIstderr\fR.
  121. .RE
  122. .PP
  123. \-i \fIpid\-file\fR
  124. .RS 4
  125. Use
  126. \fIpid\-file\fR
  127. as the PID file instead of the default,
  128. \fI/var/run/lwresd/lwresd.pid\fR.
  129. .RE
  130. .PP
  131. \-m \fIflag\fR
  132. .RS 4
  133. Turn on memory usage debugging flags. Possible flags are
  134. \fIusage\fR,
  135. \fItrace\fR,
  136. \fIrecord\fR,
  137. \fIsize\fR, and
  138. \fImctx\fR. These correspond to the ISC_MEM_DEBUGXXXX flags described in
  139. \fI<isc/mem.h>\fR.
  140. .RE
  141. .PP
  142. \-n \fI#cpus\fR
  143. .RS 4
  144. Create
  145. \fI#cpus\fR
  146. worker threads to take advantage of multiple CPUs. If not specified,
  147. \fBlwresd\fR
  148. will try to determine the number of CPUs present and create one thread per CPU. If it is unable to determine the number of CPUs, a single worker thread will be created.
  149. .RE
  150. .PP
  151. \-P \fIport\fR
  152. .RS 4
  153. Listen for lightweight resolver queries on port
  154. \fIport\fR. If not specified, the default is port 921.
  155. .RE
  156. .PP
  157. \-p \fIport\fR
  158. .RS 4
  159. Send DNS lookups to port
  160. \fIport\fR. If not specified, the default is port 53. This provides a way of testing the lightweight resolver daemon with a name server that listens for queries on a non\-standard port number.
  161. .RE
  162. .PP
  163. \-s
  164. .RS 4
  165. Write memory usage statistics to
  166. \fIstdout\fR
  167. on exit.
  168. .RS
  169. .B "Note:"
  170. This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release.
  171. .RE
  172. .RE
  173. .PP
  174. \-t \fIdirectory\fR
  175. .RS 4
  176. Chroot to
  177. \fIdirectory\fR
  178. after processing the command line arguments, but before reading the configuration file.
  179. .RS
  180. .B "Warning:"
  181. This option should be used in conjunction with the
  182. \fB\-u\fR
  183. option, as chrooting a process running as root doesn't enhance security on most systems; the way
  184. \fBchroot(2)\fR
  185. is defined allows a process with root privileges to escape a chroot jail.
  186. .RE
  187. .RE
  188. .PP
  189. \-u \fIuser\fR
  190. .RS 4
  191. Setuid to
  192. \fIuser\fR
  193. after completing privileged operations, such as creating sockets that listen on privileged ports.
  194. .RE
  195. .PP
  196. \-v
  197. .RS 4
  198. Report the version number and exit.
  199. .RE
  200. .SH "FILES"
  201. .PP
  202. \fI/etc/resolv.conf\fR
  203. .RS 4
  204. The default configuration file.
  205. .RE
  206. .PP
  207. \fI/var/run/lwresd.pid\fR
  208. .RS 4
  209. The default process\-id file.
  210. .RE
  211. .SH "SEE ALSO"
  212. .PP
  213. \fBnamed\fR(8),
  214. \fBlwres\fR(3),
  215. \fBresolver\fR(5).
  216. .SH "AUTHOR"
  217. .PP
  218. Internet Systems Consortium
  219. .SH "COPYRIGHT"
  220. Copyright \(co 2004, 2005, 2007\-2009 Internet Systems Consortium, Inc. ("ISC")
  221. .br
  222. Copyright \(co 2000, 2001 Internet Software Consortium.
  223. .br