summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTobias Klauser <tklauser@distanz.ch>2016-12-22 14:24:04 +0100
committerTobias Klauser <tklauser@distanz.ch>2016-12-22 14:36:42 +0100
commit0a2f068a48e85f3f0e7b4cb29036e003e51cfa88 (patch)
tree90f179814f8318003529636414a0a9a3828ba3da /README.md
parent0cc15619becf8fb57d34989f52693619d5deaaa8 (diff)
README.md: Add basic usage information
Add a small section about basic usage of llmnrd/llmnr-query. Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 30 insertions, 3 deletions
diff --git a/README.md b/README.md
index 47c25bc..e3bc275 100644
--- a/README.md
+++ b/README.md
@@ -32,8 +32,8 @@ $ 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:
+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-
@@ -41,12 +41,39 @@ $ 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.
+`DESTDIR` variable to change the installation destination path, e.g.
```
$ make DESTDIR=$HOME/sysroot/ prefix=/usr install
```
+Usage
+=====
+
+To run llmnrd in the default mode (listening on UDP port 5355):
+
+```
+$ llmnrd
+```
+
+By default, LLMNR name resolution is only possible over IPv4. To additionally
+enable LLMNR name resolution over IPv6 use:
+
+```
+$ llmnrd -6
+```
+
+Use `llmnrd --help` to show additional usage information.
+
+Additionally, the `llmnr-query` utility is shipped together with llmnrd and
+can be used to send customized LLMNR queries:
+
+```
+$ llmnr-query <hostname>
+```
+
+Use `llmnr-query --help` to show additional usage information.
+
License
=======