summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTobias Klauser <tklauser@distanz.ch>2017-03-07 17:18:33 +0100
committerTobias Klauser <tklauser@distanz.ch>2017-03-07 17:18:33 +0100
commit140c2b4a501af1b2e1b60ddf1094cc0c1060e75b (patch)
treed176e336bf31dfee7173aa00f26808609270f947 /doc
parent13ecd9d233c2db8add312c3d578c9cbd5e70f0a4 (diff)
doc: add manpages for llmnrd and llmnr-query
Add rudimentary manpages for llmnrd and llmnr-query describing their usage. Fixes #14 Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
Diffstat (limited to 'doc')
-rw-r--r--doc/llmnr-query.140
-rw-r--r--doc/llmnrd.838
2 files changed, 78 insertions, 0 deletions
diff --git a/doc/llmnr-query.1 b/doc/llmnr-query.1
new file mode 100644
index 0000000..f4a977b
--- /dev/null
+++ b/doc/llmnr-query.1
@@ -0,0 +1,40 @@
+.TH LLMNR-QUERY 1 "07 March 2017" llmnrd llmnrd
+.SH NAME
+llmnr-query \- LLMNR (RFC 4795) query tool
+.SH SYNOPSIS
+\fBllmnr-query\fR [\fIoptions\fR] \fIname\fR
+.SH DESCRIPTION
+Send LLMNR queries to the LLMNR multicast address (224.0.0.252 for IPv4,
+ff02:0:0:0:0:0:1:3 for IPv6). \fIname\fR specifies the hostname to query.
+.SH OPTIONS
+.TP
+.B -c <num>, --count <num>
+Number of queries to send (default: 1).
+.TP
+.B -d <num>, --id <num>
+Set LLMNR transaction id (default: 0).
+.TP
+.B -i <num>, --interval <num>
+Set interval between queries in milliseconds (default: 500).
+.TP
+.B -I <dev>, --interface <dev>
+Send multicast query over specified interface, e.g. eth0, wlan0.
+.TP
+.B -t <num>, --timeout <num>
+Set time to wait for reply in milliseconds (default: 1000).
+.TP
+.B -T <type>, --type <type>
+Set query type. Must be one of A, AAAA, ANY (default: ANY).
+.TP
+.B -6, --ipv6
+End queries over IPv6.
+.TP
+.B -h, --help
+Show usage information.
+.TP
+.B -V, --version
+Show llmnr-query version.
+.SH SEE ALSO
+.BR llmnrd(8)
+.SH AUTHOR
+Tobias Klauser <tklauser@distanz.ch>
diff --git a/doc/llmnrd.8 b/doc/llmnrd.8
new file mode 100644
index 0000000..1b31ceb
--- /dev/null
+++ b/doc/llmnrd.8
@@ -0,0 +1,38 @@
+.TH LLMNRD 8 "07 March 2017" llmnrd llmnrd
+.SH NAME
+llmnrd \- LLMNR (RFC 4795) responder daemon
+.SH SYNOPSIS
+\fBllmnrd\fR [\fIoptions\fR]
+.SH DESCRIPTION
+.B llmnrd
+is a user space daemon implementing the Link-Local Multicast Name Resolution
+(LLMNR) protocol according to RFC 4795. It will respond to name resolution
+queries sent by Windows clients in networks where no DNS server is available.
+Both IPv4 and IPv6 are supported.
+.SH OPTIONS
+.TP
+.B -H <name>, --hostname <name>
+Manually set hostname to respond with. By default the system hostname is used.
+.TP
+.B -i <dev>, --interface <dev>
+Bind socket to a specific interface, e.g. eth0, wlan0.
+.TP
+.B -p <num>, --port <num>
+Set port number to listen on. By default the port 5355 as specified in RFC 4795 is
+used.
+.TP
+.B -6, --ipv6
+Enable LLMNR name resolution over IPv6.
+.TP
+.B -d, --daemonize
+Run llmnrd as daemon in the background.
+.TP
+.B -h, --help
+Show usage information.
+.TP
+.B -V, --version
+Show llmnrd version.
+.SH SEE ALSO
+.BR llmnr-query(1)
+.SH AUTHOR
+Tobias Klauser <tklauser@distanz.ch>