diff options
Diffstat (limited to 'dhcpctl/dhcpctl.3')
| -rw-r--r-- | dhcpctl/dhcpctl.3 | 51 |
1 files changed, 25 insertions, 26 deletions
diff --git a/dhcpctl/dhcpctl.3 b/dhcpctl/dhcpctl.3 index 98d8294a..dcc08992 100644 --- a/dhcpctl/dhcpctl.3 +++ b/dhcpctl/dhcpctl.3 @@ -3,7 +3,7 @@ .\" Project: DHCP .\" File: dhcpctl.3 .\" RCSId: $Id: dhcpctl.3,v 1.9 2011/04/25 23:43:16 sar Exp $ -.\" +.\" .\" Copyright (c) 2011,2014 by Internet Systems Consortium, Inc. ("ISC") .\" Copyright (c) 2004,2009 by Internet Systems Consortium, Inc. ("ISC") .\" Copyright (c) 2000-2003 by Internet Software Consortium @@ -26,9 +26,9 @@ .\" Newmarket, NH 03857 USA .\" <info@isc.org> .\" https://www.isc.org/ -.\" +.\" .\" Description: dhcpctl man page. -.\" +.\" .\" .Dd Nov 15, 2000 .Dt DHCPCTL 3 @@ -207,8 +207,8 @@ with and manipulate a running ISC DHCP server. All functions return a value of The return values reflects the result of operations to local data structures. If an operation fails on the server for any reason, then the error result will be returned through the -second parameter of the -.Fn dhcpctl_wait_for_completion +second parameter of the +.Fn dhcpctl_wait_for_completion call. .\" .\" @@ -241,13 +241,13 @@ of the request as processed on the server is returned via the second parameter. .Bd -literal -offset indent s = dhcpctl_wait_for_completion(cxn, &wv); -if (s != ISC_R_SUCCESS) +if (s != ISC_R_SUCCESS) local_failure(s); else if (wv != ISC_R_SUCCESS) server_failure(wc); .Ed .Pp -The call to +The call to .Fn dhcpctl_wait_for_completion won't return until the remote message processing completes or the connection to the server is lost. @@ -290,7 +290,7 @@ The .Fn dhcpctl_set_boolean_value , and .Fn dhcpctl_set_int_value -functions all set a value on the object handle. +functions all set a value on the object handle. .\" .\" .\" @@ -319,7 +319,7 @@ handle. .\" .\" .Pp -The +The .Fn dhcpctl_set_callback function sets up a user-defined function to be called when an event completes on the given object handle. This is needed for asynchronous handling of @@ -327,23 +327,23 @@ events, versus the synchronous handling given by .Fn dhcpctl_wait_for_completion . When the function is called the first parameter is the object the event arrived for, the second is the status of the message that was processed, the -third is the same value as the second parameter given to +third is the same value as the second parameter given to .Fn dhcpctl_set_callback . .\" .\" .\" .Pp -The +The .Fn dhcpctl_new_authenticator creates a new authenticator object to be used for signing the messages -that cross over the network. The +that cross over the network. The .Dq name , .Dq algorithm , -and +and .Dq secret values must all match what the server uses and are defined in its configuration file. The created object is returned through the first parameter -and must be used as the 4th parameter to +and must be used as the 4th parameter to .Fn dhcpctl_connect . Note that the 'secret' value must not be base64 encoded, which is different from how the value appears in the dhcpd.conf file. @@ -352,11 +352,11 @@ from how the value appears in the dhcpd.conf file. .\" .Pp .Fn dhcpctl_new_object -creates a local handle for an object on the server. The +creates a local handle for an object on the server. The .Dq object_type -parameter is the ascii name of the type of object being accessed. e.g. +parameter is the ascii name of the type of object being accessed. e.g. .Qq lease . -This function only sets up local data structures, it does not queue any +This function only sets up local data structures, it does not queue any messages to be sent to the remote side, .Fn dhcpctl_open_object @@ -385,22 +385,22 @@ was also specified .\" .\" .Pp -The +The .Fn omapi_data_string_new function allocates a new .Ft dhcpctl_data_string -object. The data string will be large enough to hold +object. The data string will be large enough to hold .Dq length bytes of data. The -.Dq file +.Dq file and .Dq lineno arguments are the source file location the call is made from, typically by -using the +using the .Dv __FILE__ and .Dv __LINE__ -macros or the +macros or the .Dv MDL macro defined in . @@ -414,11 +414,11 @@ deallocates a data string created by The memory for the object won't be freed until the last reference is released. .Sh EXAMPLES -.Pp +.Pp The following program will connect to the DHCP server running on the local host and will get the details of the existing lease for IP address 10.0.0.101. It will then print out the time the lease is due to expire. Note -that most error checking has been omitted for brevity. +that most error checking has been omitted for brevity. .Bd -literal -offset indent #include <sys/time.h> #include <stdio.h> @@ -446,7 +446,7 @@ int main (int argc, char **argv) { dhcpctl_connect (&connection, "127.0.0.1", 7911, 0); - + dhcpctl_new_object (&lease, connection, "lease"); @@ -492,4 +492,3 @@ omapi(3), omshell(1), dhcpd(8), dhclient(8), dhcpd.conf(5), dhclient.conf(5). is maintained by ISC. To learn more about Internet Systems Consortium, see .B https://www.isc.org - |