xref: /aosp_15_r20/external/mdnsresponder/mDNSShared/mDNSResponder.8 (revision 48a54d368dc4fa860885eef7b70b6c53499e7c25)
1*48a54d36SAndroid Build Coastguard Worker.\" -*- tab-width: 4 -*-
2*48a54d36SAndroid Build Coastguard Worker.\"
3*48a54d36SAndroid Build Coastguard Worker.\" Copyright (c) 2003-2004 Apple Computer, Inc. All Rights Reserved.
4*48a54d36SAndroid Build Coastguard Worker.\"
5*48a54d36SAndroid Build Coastguard Worker.\" Licensed under the Apache License, Version 2.0 (the "License");
6*48a54d36SAndroid Build Coastguard Worker.\" you may not use this file except in compliance with the License.
7*48a54d36SAndroid Build Coastguard Worker.\" You may obtain a copy of the License at
8*48a54d36SAndroid Build Coastguard Worker.\"
9*48a54d36SAndroid Build Coastguard Worker.\"     http://www.apache.org/licenses/LICENSE-2.0
10*48a54d36SAndroid Build Coastguard Worker.\"
11*48a54d36SAndroid Build Coastguard Worker.\" Unless required by applicable law or agreed to in writing, software
12*48a54d36SAndroid Build Coastguard Worker.\" distributed under the License is distributed on an "AS IS" BASIS,
13*48a54d36SAndroid Build Coastguard Worker.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14*48a54d36SAndroid Build Coastguard Worker.\" See the License for the specific language governing permissions and
15*48a54d36SAndroid Build Coastguard Worker.\" limitations under the License.
16*48a54d36SAndroid Build Coastguard Worker.\"
17*48a54d36SAndroid Build Coastguard Worker.Dd April 2004              \" Date
18*48a54d36SAndroid Build Coastguard Worker.Dt mDNSResponder 8         \" Document Title
19*48a54d36SAndroid Build Coastguard Worker.Os Darwin                  \" Operating System
20*48a54d36SAndroid Build Coastguard Worker.\"
21*48a54d36SAndroid Build Coastguard Worker.Sh NAME
22*48a54d36SAndroid Build Coastguard Worker.Nm mDNSResponder
23*48a54d36SAndroid Build Coastguard Worker.Nd Multicast and Unicast DNS daemon    \" Name Description for whatis database
24*48a54d36SAndroid Build Coastguard Worker.\"
25*48a54d36SAndroid Build Coastguard Worker.Sh SYNOPSIS
26*48a54d36SAndroid Build Coastguard Worker.Nm
27*48a54d36SAndroid Build Coastguard Worker.\"
28*48a54d36SAndroid Build Coastguard Worker.Sh DESCRIPTION
29*48a54d36SAndroid Build Coastguard Worker.Nm
30*48a54d36SAndroid Build Coastguard Worker(also known as
31*48a54d36SAndroid Build Coastguard Worker.Nm mdnsd
32*48a54d36SAndroid Build Coastguard Workeron some systems)
33*48a54d36SAndroid Build Coastguard Workeris a daemon invoked at boot time to implement Multicast DNS and DNS Service Discovery. On
34*48a54d36SAndroid Build Coastguard WorkerMac OS X 10.6 (Snow Leopard),
35*48a54d36SAndroid Build Coastguard Worker.Nm
36*48a54d36SAndroid Build Coastguard Workeris also the system-wide Unicast DNS Resolver.
37*48a54d36SAndroid Build Coastguard Worker.Pp
38*48a54d36SAndroid Build Coastguard Worker.Nm
39*48a54d36SAndroid Build Coastguard Workerlistens on UDP port 5353 for Multicast DNS Query packets.
40*48a54d36SAndroid Build Coastguard WorkerWhen it receives a query for which it knows an answer,
41*48a54d36SAndroid Build Coastguard Worker.Nm
42*48a54d36SAndroid Build Coastguard Workerissues the appropriate Multicast DNS Reply packet.
43*48a54d36SAndroid Build Coastguard Worker.Pp
44*48a54d36SAndroid Build Coastguard Worker.Nm
45*48a54d36SAndroid Build Coastguard Workeralso performs Unicast and Multicast DNS Queries on behalf of client processes, and
46*48a54d36SAndroid Build Coastguard Workermaintains a cache of the replies.
47*48a54d36SAndroid Build Coastguard Worker.Pp
48*48a54d36SAndroid Build Coastguard Worker.Nm
49*48a54d36SAndroid Build Coastguard Workerhas no user-specifiable command-line argument, and users should not run
50*48a54d36SAndroid Build Coastguard Worker.Nm
51*48a54d36SAndroid Build Coastguard Workermanually.
52*48a54d36SAndroid Build Coastguard Worker.Pp
53*48a54d36SAndroid Build Coastguard Worker.Ss LOGGING
54*48a54d36SAndroid Build Coastguard WorkerThere are several methods with which to examine
55*48a54d36SAndroid Build Coastguard Worker.Nm Ns 's internal state for debugging and diagnostic purposes. The syslog(1)
56*48a54d36SAndroid Build Coastguard Workerlogging levels map as follows:
57*48a54d36SAndroid Build Coastguard Worker.Pp
58*48a54d36SAndroid Build Coastguard Worker.Dl Error - Error messages
59*48a54d36SAndroid Build Coastguard Worker.Dl Warning - Client-initiated operations
60*48a54d36SAndroid Build Coastguard Worker.Dl Notice - Sleep proxy operations
61*48a54d36SAndroid Build Coastguard Worker.Dl Info - Informational messages
62*48a54d36SAndroid Build Coastguard Worker.Pp
63*48a54d36SAndroid Build Coastguard WorkerBy default, only log level Error is logged.
64*48a54d36SAndroid Build Coastguard Worker.Pp
65*48a54d36SAndroid Build Coastguard WorkerA SIGUSR1 signal toggles additional logging, with Warning and Notice
66*48a54d36SAndroid Build Coastguard Workerenabled by default:
67*48a54d36SAndroid Build Coastguard Worker.Pp
68*48a54d36SAndroid Build Coastguard Worker.Dl % sudo killall -USR1 mDNSResponder
69*48a54d36SAndroid Build Coastguard Worker.Pp
70*48a54d36SAndroid Build Coastguard WorkerOnce this logging is enabled, users can additionally use syslog(1)
71*48a54d36SAndroid Build Coastguard Workerto change the log filter for the process. For example, to enable log levels Emergency - Debug:
72*48a54d36SAndroid Build Coastguard Worker.Pp
73*48a54d36SAndroid Build Coastguard Worker.Dl % sudo syslog -c mDNSResponder -d
74*48a54d36SAndroid Build Coastguard Worker.Pp
75*48a54d36SAndroid Build Coastguard WorkerA SIGUSR2 signal toggles packet logging:
76*48a54d36SAndroid Build Coastguard Worker.Pp
77*48a54d36SAndroid Build Coastguard Worker.Dl % sudo killall -USR2 mDNSResponder
78*48a54d36SAndroid Build Coastguard Worker.Pp
79*48a54d36SAndroid Build Coastguard WorkerA SIGINFO signal will dump a snapshot summary of the internal state to
80*48a54d36SAndroid Build Coastguard Worker.Pa /var/log/system.log Ns :
81*48a54d36SAndroid Build Coastguard Worker.Pp
82*48a54d36SAndroid Build Coastguard Worker.Dl % sudo killall -INFO mDNSResponder
83*48a54d36SAndroid Build Coastguard Worker.Sh FILES
84*48a54d36SAndroid Build Coastguard Worker.Pa /usr/sbin/mDNSResponder \" Pathname
85*48a54d36SAndroid Build Coastguard Worker.\"
86*48a54d36SAndroid Build Coastguard Worker.Sh SEE ALSO
87*48a54d36SAndroid Build Coastguard Worker.Xr mDNS 1
88*48a54d36SAndroid Build Coastguard Worker.Pp
89*48a54d36SAndroid Build Coastguard WorkerFor information on Multicast DNS, see
90*48a54d36SAndroid Build Coastguard Worker.Pa http://www.multicastdns.org/
91*48a54d36SAndroid Build Coastguard Worker.Pp
92*48a54d36SAndroid Build Coastguard WorkerFor information on DNS Service Discovery, see
93*48a54d36SAndroid Build Coastguard Worker.Pa http://www.dns-sd.org/
94*48a54d36SAndroid Build Coastguard Worker.Pp
95*48a54d36SAndroid Build Coastguard WorkerFor information on how to use the Multicast DNS and the
96*48a54d36SAndroid Build Coastguard WorkerDNS Service Discovery APIs on Mac OS X and other platforms, see
97*48a54d36SAndroid Build Coastguard Worker.Pa http://developer.apple.com/bonjour/
98*48a54d36SAndroid Build Coastguard Worker.Pp
99*48a54d36SAndroid Build Coastguard WorkerFor the source code to
100*48a54d36SAndroid Build Coastguard Worker.Nm , see
101*48a54d36SAndroid Build Coastguard Worker.Pa http://developer.apple.com/darwin/projects/bonjour/
102*48a54d36SAndroid Build Coastguard Worker.\"
103*48a54d36SAndroid Build Coastguard Worker.Sh BUGS
104*48a54d36SAndroid Build Coastguard Worker.Nm
105*48a54d36SAndroid Build Coastguard Workerbugs are tracked in Apple Radar component "mDNSResponder".
106*48a54d36SAndroid Build Coastguard Worker.\"
107*48a54d36SAndroid Build Coastguard Worker.Sh HISTORY
108*48a54d36SAndroid Build Coastguard WorkerThe
109*48a54d36SAndroid Build Coastguard Worker.Nm
110*48a54d36SAndroid Build Coastguard Workerdaemon first appeared in Mac OS X 10.2 (Jaguar).
111*48a54d36SAndroid Build Coastguard Worker.Pp
112*48a54d36SAndroid Build Coastguard WorkerAlso available from the Darwin open source repository
113*48a54d36SAndroid Build Coastguard Worker(though not officially supported by Apple) are
114*48a54d36SAndroid Build Coastguard Worker.Nm
115*48a54d36SAndroid Build Coastguard Workerdaemons for other platforms, including Mac OS 9, Microsoft Windows,
116*48a54d36SAndroid Build Coastguard WorkerLinux, FreeBSD, NetBSD, Solaris, and other POSIX systems.
117