From 140c2b4a501af1b2e1b60ddf1094cc0c1060e75b Mon Sep 17 00:00:00 2001 From: Tobias Klauser Date: Tue, 7 Mar 2017 17:18:33 +0100 Subject: 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 --- doc/llmnr-query.1 | 40 ++++++++++++++++++++++++++++++++++++++++ doc/llmnrd.8 | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 doc/llmnr-query.1 create mode 100644 doc/llmnrd.8 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 , --count +Number of queries to send (default: 1). +.TP +.B -d , --id +Set LLMNR transaction id (default: 0). +.TP +.B -i , --interval +Set interval between queries in milliseconds (default: 500). +.TP +.B -I , --interface +Send multicast query over specified interface, e.g. eth0, wlan0. +.TP +.B -t , --timeout +Set time to wait for reply in milliseconds (default: 1000). +.TP +.B -T , --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 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 , --hostname +Manually set hostname to respond with. By default the system hostname is used. +.TP +.B -i , --interface +Bind socket to a specific interface, e.g. eth0, wlan0. +.TP +.B -p , --port +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 -- cgit v1.2.3-54-g00ecf