diff options
| author | Tobias Klauser <tklauser@distanz.ch> | 2016-09-12 17:09:19 +0200 |
|---|---|---|
| committer | Tobias Klauser <tklauser@distanz.ch> | 2016-09-12 17:20:12 +0200 |
| commit | ab55a68c191bb720dc8e37b9a41248761e7f5cad (patch) | |
| tree | 4a3034686c56121dcbb84bc5ab294bc0bc631fc0 | |
| parent | 0abe253f93ea00ae455667b8ab7fe3d5d19a1e8a (diff) | |
README: Convert to markdown
Convert the README file to markdown syntax so we get the nice rendering
on GitHub.
Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
| -rw-r--r-- | README.md (renamed from README) | 53 |
1 files changed, 29 insertions, 24 deletions
@@ -1,43 +1,51 @@ -llmnrd - Link-Local Multicast Resolution Daemon -=============================================== +# llmnrd - Link-Local Multicast Resolution Daemon llmnrd is a daemon implementing the Link-Local Multicast Name Resolution (LLMNR) -protocol according to RFC 4795. It currently only supports Linux, as it uses the -netlink kernel interface. +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 +``` +$ 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 +``` +$ 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- +``` +$ 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 +``` +$ 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 @@ -47,8 +55,11 @@ 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> @@ -63,14 +74,8 @@ otherwise helped in the development of llmnrd: 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 - https://bitbucket.org/kazssym/xllmnrd/ +* [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/)) |