README.md
1mdnsd - embeddable Multicast DNS Daemon
2=======================================
3
4[](https://www.ohloh.net/p/mdnsd_pro)
5[](https://travis-ci.org/Pro/mdnsd)
6[](https://ci.appveyor.com/project/Pro/mdnsd)
7
8This package is intended for software developers and integrators, there
9isn't really anything here for an end user. The project license is the
10modified 3-clause BSD, https://en.wikipedia.org/wiki/BSD_licenses
11
12You should be able to just type make and it will build the included
13example apps. Otherwise, check out `mdnsd.h` to get started, the API is
14as simple as I could make it, but I hope to find some easier/better ways
15to improve it in the future. Also included are some other utilities,
16`sdtxt.*` for service discovery TXT record parsing/generation, and
17`xht.*` for simple fast hashtables, and `1035.*` which mdnsd uses for
18standalone DNS parsing.
19
20**Differences to the base repo (https://github.com/troglobit/mdnsd)**:
21* Use CMake for the build
22* Strict compilation flags for better portability
23* Support of Linux, MinGW, **OS X** and **Windows**
24* Continuous Integration
25
26Build & Install
27---------------
28
29The software is built for and developed on GNU/Linux systems, but should
30work on any UNIX like system.
31
32The GNU configure and build system is used, simply call the configure
33script to generate a Makefile. If you are using the GitHub sources you
34first need to call `./autogen.sh` to generate the configure script.
35
36 ./configure
37 make all
38 make install
39
40
41Running
42-------
43
44To test the included example applications you need to first start the
45`mdnsd` daemon before calling `mquery`:
46
47 ./mdnsd _name._service 192.168.1.2 80 &
48 ./mquery 12 _http._tcp.local.
49
50
51Origin & References
52-------------------
53
54This MDNS-SD implementation was developed by [Jeremie Miller][jeremie]
55in 2003, originally [announced on the rendezvous-dev][announced] mailing
56list. It has many forks and has been used by many other applications
57over the years.
58
59This GitHub project is an attempt to clean it up, develop it further,
60and maintain it for the long haul.
61
62
63[jeremie]: https://github.com/quartzjer
64[announced]: http://lists.apple.com/archives/rendezvous-dev/2003/Feb/msg00062.html
65[Travis]: https://travis-ci.org/troglobit/mdnsd
66[Travis Status]: https://travis-ci.org/troglobit/mdnsd.png?branch=master
67
){kind=link}
){kind=link}
