1.\" -*- tab-width: 4 -*- 2.\" 3.\" Copyright (c) 2004 Apple Computer, Inc. All Rights Reserved. 4.\" 5.\" Licensed under the Apache License, Version 2.0 (the "License"); 6.\" you may not use this file except in compliance with the License. 7.\" You may obtain a copy of the License at 8.\" 9.\" http://www.apache.org/licenses/LICENSE-2.0 10.\" 11.\" Unless required by applicable law or agreed to in writing, software 12.\" distributed under the License is distributed on an "AS IS" BASIS, 13.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14.\" See the License for the specific language governing permissions and 15.\" limitations under the License. 16.\" 17.\" Copyright 2016 Toomas Soome <tsoome@me.com> 18.\" 19.Dd Jan 28, 2016 \" Date 20.Dt DNS-SD 1M \" Document Title 21.Os illumos \" Operating System 22.\" 23.Sh NAME 24.Nm dns-sd 25.Nd Multicast DNS (mDNS) & DNS Service Discovery (DNS-SD) Test Tool \" For whatis 26.\" 27.Sh SYNOPSIS 28.Nm 29.Op Fl E 30.Pp 31.Nm 32.Op Fl F 33.Pp 34.Nm 35.Op Fl R Ar name type domain port Op Ar key=value ... 36.Pp 37.Nm 38.Op Fl B Ar type domain 39.Pp 40.Nm 41.Op Fl L Ar name type domain 42.Pp 43.Nm 44.Op Fl P Ar name type domain port host IP Op Ar key=value ... 45.Pp 46.Nm 47.Op Fl q Ar name rrtype rrclass 48.Pp 49.Nm 50.Op Fl Z Ar type domain 51.Pp 52.Nm 53.Op Fl G Ns \ v4/v6/v4v6 Ar name 54.Pp 55.Nm 56.Op Fl V 57.\" 58.Sh DESCRIPTION 59The 60.Nm 61command is a network diagnostic tool, much like 62.Xr ping 8 63or 64.Xr traceroute 8 . 65However, unlike those tools, most of its functionality is not implemented in the 66.Nm 67executable itself, but in library code that is available to any application. 68The library API that 69.Nm 70uses is documented in 71.Pa /usr/include/dns_sd.h . 72The 73.Nm 74command replaces the older 75mDNS 76command. 77.Pp 78The 79.Nm 80command is primarily intended for interactive use. 81Because its command-line arguments and output format are subject to change, 82invoking it from a shell script will generally be fragile. Additionally, 83the asynchronous nature of DNS Service Discovery does 84not lend itself easily to script-oriented programming. For example, 85calls like "browse" never complete; the action of performing a "browse" 86sets in motion machinery to notify the client whenever instances of 87that service type appear or disappear from the network. These 88notifications continue to be delivered indefinitely, for minutes, 89hours, or even days, as services come and go, until the client 90explicitly terminates the call. This style of asynchronous interaction 91works best with applications that are either multi-threaded, or use a 92main event-handling loop to receive keystrokes, network data, and other 93asynchronous event notifications as they happen. 94.br 95If you wish to perform DNS Service Discovery operations from a 96scripting language, then the best way to do this is not to execute the 97.Nm 98command and then attempt to decipher the textual output, but instead to 99directly call the DNS-SD APIs using a binding for your chosen language. 100.br 101For example, if you are programming in Ruby, then you can 102directly call DNS-SD APIs using the dnssd package documented at 103.Pa <http://rubyforge.org/projects/dnssd/> . 104.br 105Similar bindings for other languages are also in development. 106.Bl -tag -width E 107.It Nm Fl E 108return a list of domains recommended for registering(advertising) services. 109.It Nm Fl F 110return a list of domains recommended for browsing services. 111.Pp 112Normally, on your home network, the only domain you are likely to see is "local". 113However if your network administrator has created Domain Enumeration records, 114then you may also see other recommended domains for registering and browsing. 115.It Nm Fl R Ar name type domain port Op Ar key=value ... 116register (advertise) a service in the specified 117.Ar domain 118with the given 119.Ar name 120and 121.Ar type 122as listening (on the current machine) on 123.Ar port. 124.Pp 125.Ar name 126can be arbitrary unicode text, containing any legal unicode characters 127(including dots, spaces, slashes, colons, etc. without restriction), 128up to 63 UTF-8 bytes long. 129.Ar type 130must be of the form "_app-proto._tcp" or "_app-proto._udp", where 131"app-proto" is an application protocol name registered at 132.Pa http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xml . 133.Pp 134.Ar domain 135is the domain in which to register the service. 136In current implementations, only the local multicast domain "local" is 137supported. In the future, registering will be supported in any arbitrary 138domain that has a working DNS Update server [RFC 2136]. The 139.Ar domain 140"." is a synonym for "pick a sensible default" which today 141means "local". 142.Pp 143.Ar port 144is a number from 0 to 65535, and is the TCP or UDP port number upon 145which the service is listening. 146.Pp 147Additional attributes of the service may optionally be described by 148key/value pairs, which are stored in the advertised service's DNS TXT 149record. Allowable keys and values are listed with the service 150registration at 151.Pa http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xml . 152.It Nm Fl B Ar type domain 153browse for instances of service 154.Ar type 155in 156.Ar domain . 157.Pp 158For valid 159.Ar type Ns s 160see 161.Pa http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xml . 162as described above. Omitting the 163.Ar domain 164or using "." means "pick a sensible default." 165.It Nm Fl L Ar name type domain 166look up and display the information necessary to contact and use the 167named service: the hostname of the machine where that service is 168available, the port number on which the service is listening, and (if 169present) TXT record attributes describing properties of the service. 170.Pp 171Note that in a typical application, browsing may only happen rarely, while lookup 172(or "resolving") happens every time the service is used. For example, a 173user browses the network to pick a default printer fairly rarely, but once 174a default printer has been picked, that named service is resolved to its 175current IP address and port number every time the user presses Cmd-P to 176print. 177.It Nm Fl P Ar name type domain port host IP Op Ar key=value ... 178create a proxy advertisement for a service running on(offered by) some other machine. 179The two new options are Host, a name for the device and IP, the address of it. 180.Pp 181The service for which you create a proxy advertisement does not necessarily have to be on your local network. 182You can set up a local proxy for a website on the Internet. 183.It Nm Fl q Ar name rrtype rrclass 184look up any DNS name, resource record type, and resource record class, 185not necessarily DNS-SD names and record types. 186If rrtype is not specified, it queries for the IPv4 address of the name, 187if rrclass is not specified, IN class is assumed. If the name is not a fully 188qualified domain name, then search domains may be appended. 189.It Nm Fl Z Ar type domain 190browse for service instances and display output in zone file format. 191.It Nm Fl G Ns \ v4/v6/v4v6 Ar name 192look up the IP address information of the name. 193If v4 is specified, the IPv4 address of the name is looked up, 194if v6 is specified the IPv6 address is looked up. If v4v6 is specified both the IPv4 and IPv6 195address is looked up. If the name is not a fully qualified domain name, 196then search domains may be appended. 197.It Nm Fl V 198return the version of the currently running daemon/system service. 199.El 200.Sh FILES 201.Pa /usr/bin/dns-sd \" Pathname 202.\" 203.Sh EXAMPLES 204To advertise the existence of LPR printing service on port 515 on this 205machine, such that it will be discovered by the Mac OS X printing software 206and other DNS-SD compatible printing clients, use: 207.Pp 208.Dl Nm Fl R Ns \ \&"My Test\&" _printer._tcp. \&. 515 pdl=application/postscript 209.Pp 210For this registration to be useful, you need to actually have LPR service 211available on port 515. Advertising a service that does not exist is not 212very useful, and will be confusing and annoying to other people on the 213network. 214.Pp 215Similarly, to advertise a web page being served by an HTTP 216server on port 80 on this machine, such that it will show up in the 217Bonjour list in Safari and other DNS-SD compatible Web clients, use: 218.Pp 219.Dl Nm Fl R Ns \ \&"My Test\&" _http._tcp \&. 80 path=/path-to-page.html 220.Pp 221To find the advertised web pages on the local network (the same list that 222Safari shows), use: 223.Pp 224.Dl Nm Fl B Ns \ _http._tcp 225.Pp 226While that command is running, in another window, try the 227.Nm Fl R 228example given above to advertise a web page, and you should see the 229"Add" event reported to the 230.Nm Fl B 231window. Now press Ctrl-C in the 232.Nm Fl R 233window and you should see the "Remove" event reported to the 234.Nm Fl B 235window. 236.Pp 237In the example below, the www.apple.com web page is advertised as a service called "apple", 238running on a target host called apple.local, which resolves to 17.149.160.49. 239.Pp 240.Dl Nm Fl P Ns \ apple _http._tcp \&"\&"\& 80 apple.local 17.149.160.49 241.Pp 242The Bonjour menu in the Safari web browser will now show "apple". 243The same IP address can be reached by entering apple.local in the web browser. 244In either case, the request will be resolved to the IP address and browser will show 245contents associated with www.apple.com. 246.Pp 247If a client wants to be notified of changes in server state, it can 248initiate a query for the service's particular record and leave it running. 249For example, to monitor the status of an iChat user you can use: 250.Pp 251.Dl Nm Fl q Ns \ someone@ex1._presence._tcp.local txt 252.Pp 253Everytime status of that user(someone) changes, you will see a new TXT record result reported. 254.Pp 255You can also query for a unicast name like www.apple.com and monitor its status. 256.Pp 257.Dl Nm Fl q Ns \ www.apple.com 258.Sh INTERFACE STABILITY 259.Sy Volatile . 260.Sh SEE ALSO 261.Xr mdnsd 1M , 262.Xr ping 1M , 263.Xr traceroute 1M , 264.Xr resolv.conf 4 265