From: Nicolas C <nchaigne@capgemini.fr>
Date: Sat, 24 Feb 2018 19:54:18 +0000 (+0100)
Subject: dhcpclient documentation
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F2183%2Fhead;p=thirdparty%2Ffreeradius-server.git

dhcpclient documentation

Some updates to dhcpclient man page
---

diff --git a/man/man1/dhcpclient.1 b/man/man1/dhcpclient.1
index d6a538ea303..947635e7540 100644
--- a/man/man1/dhcpclient.1
+++ b/man/man1/dhcpclient.1
@@ -1,6 +1,6 @@
-.TH DHCPCLIENT 1 "19 September 2016" "" "FreeRADIUS Daemon"
+.TH DHCPCLIENT 1 "24 February 2018" "" "FreeRADIUS DHCP test client"
 .SH NAME
-dhcpclient - Send a DHCP request with provided RADIUS attributes and get the output response.
+dhcpclient - Send a DHCP request with provided DHCP attributes and get the output response.
 .SH SYNOPSIS
 .B dhcpclient
 .RB [ \-d
@@ -16,14 +16,14 @@ dhcpclient - Send a DHCP request with provided RADIUS attributes and get the out
 .IR timeout ]
 .RB [ \-v ]
 .RB [ \-x ]
-\fIserver[:port] {discover|request|decline|release|inform|auto}\fP
+\fIserver[:port] {discover|request|decline|release|inform|lease_query|auto}\fP
 .SH DESCRIPTION
 \fBdhcpclient\fP is a DHCP test client program. It can send arbitrary DHCP
 packets to the FreeRADIUS server running as DHCP server, then shows the reply.
-It can be used to test changes you made in the configuration of the radius server,
-or it can be used to monitor if a radius server is up.
+It can be used to test changes you made in the configuration of the DHCP server,
+or it can be used to monitor if a DHCP server is up.
 .PP
-\fBdhcpclient\fP reads radius attribute/value pairs from its standard
+\fBdhcpclient\fP reads DHCP attribute/value pairs from its standard
 input, or from a file specified on the command line. It then encodes
 these attribute/value pairs using the dictionary, and sends them
 to the local/remote server.
@@ -37,12 +37,9 @@ The directory that contains the user dictionary file. Defaults to
 .IP \-D\ \fIdictionary_directory\fP
 The directory that contains the main dictionary file. Defaults to
 \fI/usr/share/freeradius\fP.
-.IP \-f\ \fIfile[:file]\fP
+.IP \-f\ \fIfile\fP
 File to read the attribute/value pairs from. If this is not specified,
-they are read from stdin.  This option can be specified multiple
-times, in which case packets are sent in order by file, and within
-each file, by first packet to last packet.  A blank line separates
-logical packets within a file.
+they are read from stdin.
 .IP \-h
 Print usage help information.
 .IP \-i\ \fIinterface\fP
@@ -57,13 +54,10 @@ Print out program version information.
 Print out debugging information.
 .IP server[:port]
 The hostname or IP address of the remote server. Optionally a UDP port
-can be specified. If no UDP port is specified, it is looked up in
-\fI/etc/services\fP. The service name looked for is \fBradacct\fP for
-accounting packets, and \fBradius\fP for all other requests. If a
-service is not found in \fI/etc/services\fP, 1813 and 1812 are used
-respectively.
-.IP discover\ |\ request\ |\ decline\ |\ release\ |\ inform\ |\ auto
-DHCP options - use the type relevant for testing
+can be specified. If no UDP port is specified, 67 is used.
+.IP discover\ |\ request\ |\ decline\ |\ release\ |\ inform\ |\ lease_query\ |\ auto
+DHCP Message Type - use the type relevant for testing. If \fBauto\fP then the message
+type has to be provided in attribute/value pair \fBDHCP-Message-Type\fP.
 
 .SH SEE ALSO
 radiusd(8)
diff --git a/src/modules/proto_dhcpv4/dhcpclient.c b/src/modules/proto_dhcpv4/dhcpclient.c
index b1b77fb53f7..b54c486c137 100644
--- a/src/modules/proto_dhcpv4/dhcpclient.c
+++ b/src/modules/proto_dhcpv4/dhcpclient.c
@@ -1,5 +1,5 @@
 /*
- * dhcpclient.c	General radius packet debug tool.
+ * dhcpclient.c	DHCP test client.
  *
  * Version:	$Id$
  *