diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..749374c --- /dev/null +++ b/README.md @@ -0,0 +1,81 @@ +# llmnrd - Link-Local Multicast Resolution Daemon + +llmnrd is a daemon implementing the Link-Local Multicast Name Resolution (LLMNR) +protocol according to [RFC 4795](https://tools.ietf.org/html/rfc4795). It +currently only supports Linux, as it uses the +[netlink kernel interface](http://man7.org/linux/man-pages/man7/netlink.7.html). + +llmnrd will respond to name resolution queries sent by Windows clients in +networks where no DNS server is available. It supports both IPv4 and IPv6. + +Installation +============ + +To build and install llmnrd use the following commands: + +``` +$ make +$ sudo make install +``` + +By default, the llmnrd binary will be installed to /usr/local/sbin. To install +the binary to a different installation path, use: + +``` +$ make +$ sudo make prefix=<path> install +``` + +Cross-Compilation +================= + +To cross-compile llmnrd for a different architecture, use the CROSS_COMPILE make +variable. To e.g. build it using the arm-linux-gnueabihf toolchain use: + +``` +$ make CROSS_COMPILE=arm-linux-gnueabihf- +``` + +When cross-compiling, you usually don't want to install the generated binary to +your root filesystem, but to the sysroot of a cross-compiled system. Use the +DESTDIR variable to change the installation destination path, e.g. + +``` +$ make DESTDIR=$HOME/sysroot/ prefix=/usr install +``` + +License +======= + +llmnrd is free software: you can redistribute it and/or modify it under the +terms of the GNU General Public License as published by the Free Software +Foundation, version 2 of the License. + +llmnrd is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +PARTICULAR PURPOSE. See the GNU General Public License for more details. + +Please see the [COPYING](https://github.com/tklauser/llmnrd/blob/master/COPYING) +file for the full license text. + +Authors +======= + +llmnrd is authored and maintained by Tobias Klauser <tklauser@distanz.ch> + +The following people contributed patches and ideas, found and reported bugs or +otherwise helped in the development of llmnrd: + +* Martin Hauke +* Michael Evertz (@dvl-mevertz) +* Schimmelreiter (@Schimmelreiter) +* SviMik (@svimik) + +Thanks a lot! + +References +========== + +* [RFC 4795](https://tools.ietf.org/html/rfc4795) +* [Microsoft TechNet article about LLMNR](https://technet.microsoft.com/en-us/library/bb878128.aspx) +* [xllmnrd: An IPv6-only LLMNR responder daemon](http://www.vx68k.org/xllmnrd) ([Repository](https://bitbucket.org/kazssym/xllmnrd/)) |