[dhcp-agent-commits] dhcp-agent/doc dhcp-client.texi,1.1,1.2

[<act...@us...>]

Update of /cvsroot/dhcp-agent/dhcp-agent/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv12525/doc

Modified Files:
	dhcp-client.texi 
Log Message:
prettied up client manual

Index: dhcp-client.texi
===================================================================
RCS file: /cvsroot/dhcp-agent/dhcp-agent/doc/dhcp-client.texi,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** dhcp-client.texi	18 May 2003 03:18:10 -0000	1.1
--- dhcp-client.texi	27 Jun 2003 04:05:40 -0000	1.2
***************
*** 2,6 ****
  @node dhcp-client
  @chapter dhcp-client
- @cindex dhcp-client
  
  dhcp-client is a highly configurable and extendable DHCP client. Out
--- 2,5 ----
***************
*** 68,71 ****
--- 67,75 ----
  configuration it had done before.
  
+ Although you can run the client in the foreground, if you do not, the
+ client will send the rest of its messages to syslogd. Currently it
+ logs to the daemon service [ FIXME: in the future the syslog service
+ will be configurable ].
+ 
  @section Client Configuration
  
***************
*** 147,152 ****
  quoted strings will result in an error unless preceeded by the '\'
  character. There should be no need to put newlines in quoted strings
! and expect them to be evaluated. If you want newlines to be evaluated
! you need to convince the author that they should be :-)
  
  The '\' character can be used to escape double quotes too.
--- 151,157 ----
  quoted strings will result in an error unless preceeded by the '\'
  character. There should be no need to put newlines in quoted strings
! and expect them to be evaluated without the backslash (much like a
! Makefile). If you want newlines to be silently ignored you need to
! convince the author that they should be :-)
  
  The '\' character can be used to escape double quotes too.
***************
*** 158,175 ****
  The following directives affect DHCP option handling by the client
  
- @itemize bullet
  
! @item 
  request : The ``request'' directive instructs the client to request a
  set of dhcp options. The request directive accepts a list of strings
  which name the options to be requested:
  
  @example
  request subnet-mask, ip-address-lease-time, renewal-time,
! rebinding-time, interface-mtu, domain-name, domain-name-servers;
  @end example
  
! @item
! require : the ``require'' directive instructs the client to require a
  set of dhcp options to be passed before accepting the lease. This is
  useful to make sure you receive a minimum of desired options. If these
--- 163,183 ----
  The following directives affect DHCP option handling by the client
  
  
! @deffn {Client Configuration Directive} request
  request : The ``request'' directive instructs the client to request a
  set of dhcp options. The request directive accepts a list of strings
  which name the options to be requested:
  
+ 
  @example
  request subnet-mask, ip-address-lease-time, renewal-time,
!         rebinding-time, interface-mtu, domain-name, domain-name-servers;
  @end example
  
! @end deffn
! 
! @deffn {Client Configuration Directive} require
! 
! The ``require'' directive instructs the client to require a
  set of dhcp options to be passed before accepting the lease. This is
  useful to make sure you receive a minimum of desired options. If these
***************
*** 181,191 ****
  @end example
  
! @item
! configure : the ``configure'' directive instructs the client to only
  configure a set of dhcp options. This is useful if the server is
  passing you options you would rather not configure but implicitly
  claim to configure by accepting the lease. This directive does not
! define how options are configured [TODO write up extending the client
! with guile].
  
  @example
--- 189,202 ----
  @end example
  
! @end deffn
! 
! @deffn {Client Configuration Directive} configure
! 
! The ``configure'' directive instructs the client to only
  configure a set of dhcp options. This is useful if the server is
  passing you options you would rather not configure but implicitly
  claim to configure by accepting the lease. This directive does not
! define how options are configured. In order to define how
! configuration is done see ``Writing Client Extensions,'' for more info.
  
  @example
***************
*** 194,198 ****
  @end example
  
! @item
  
  append : the ``append'' directive instructs the client to append a
--- 205,212 ----
  @end example
  
! @end deffn
! 
! 
! @deffn {Client Configuration Directive} configure
  
  append : the ``append'' directive instructs the client to append a
***************
*** 207,213 ****
  @end example
  
! @item
  
! prepend : the ``prepend'' directive works the same as the append
  directive only the values are placed at the beginning of the list or
  string. You should not use prepend on single datum options and should
--- 221,229 ----
  @end example
  
! @end deffn
  
! @deffn {Client Configuration Directive} prepend
! 
! The ``prepend'' directive works the same as the append
  directive only the values are placed at the beginning of the list or
  string. You should not use prepend on single datum options and should
***************
*** 218,222 ****
  @end example
  
! @item
  
  override : the ``override'' directive instructs the client to
--- 234,240 ----
  @end example
  
! @end deffn
! 
! @deffn {Client Configuration Directive} override
  
  override : the ``override'' directive instructs the client to
***************
*** 230,240 ****
  @end example
  
! @end itemize
  
  @subheading Variable Settings
  
! @itemize
  
- @item
  set : the ``set'' directive instructs the client to set a variable to
  a defined value.
--- 248,257 ----
  @end example
  
! @end deffn
  
  @subheading Variable Settings
  
! @deffn {Client Configuration Directive} set
  
  set : the ``set'' directive instructs the client to set a variable to
  a defined value.
***************
*** 244,248 ****
  @end example
  
! @item
  
  enable: the ``enable'' directive instructs the client to set a boolean
--- 261,267 ----
  @end example
  
! @end deffn
! 
! @deffn {Client Configuration Directive} enable
  
  enable: the ``enable'' directive instructs the client to set a boolean
***************
*** 254,258 ****
  @end example
  
! @end itemize
  
  @subheading Configurable Variables
--- 273,277 ----
  @end example
  
! @end deffn
  
  @subheading Configurable Variables
***************
*** 261,275 ****
  values passed to the server, and control some of its behaviour.
  
! @itemize
! 
! @item
  
! hostname : the ``hostname'' variable can be set to a string which is
! passed as the hostname DHCP option to the server. This allows servers
! to pass configuration based on a hostname passed by the client. It
! will also instruct the client to set the hostname to that
! variable. If you want to pass a hostname to the server you should set
! this variable and not use the ``override'' directive because the
! ``override'' directive only affects system configuration.
  
  @example
--- 280,292 ----
  values passed to the server, and control some of its behaviour.
  
! @defvr {Client Configuration Variable} hostname
  
! The ``hostname'' variable can be set to a string which is passed as
! the hostname DHCP option to the server. This allows servers to pass
! configuration based on a hostname passed by the client. It will also
! instruct the client to set the hostname to that variable. If you want
! to pass a hostname to the server you should set this variable and not
! use the ``override'' directive because the ``override'' directive only
! affects system configuration.
  
  @example
***************
*** 277,284 ****
  @end example
  
! @item
! dhcp-discovery-retries: the ``dhcp-discovery-retries'' variable
! can be set to an integer value which instructs the client on how many
! times it should retry a DHCP discover before it gives up.
  
  @example
--- 294,305 ----
  @end example
  
! 
! @end defvr
! 
! @defvr {Client Configuration Variable} dhcp-discovery-retries 
! 
! The ``dhcp-discovery-retries'' variable can be set to an integer value
! which instructs the client on how many times it should retry a DHCP
! discover before it gives up.
  
  @example
***************
*** 286,294 ****
  @end example
  
! @item
! icmp-retries: the ``icmp-retries'' variable
! can be set to an integer value which instructs the client on how many
! times it should retry an ICMP operation. This affects operations such
! as router latency discovery, ICMP netmask discovery etc.
  
  @example
--- 307,318 ----
  @end example
  
! @end defvr
! 
! @defvr {Client Configuration Variable} icmp-retries 
! 
! The ``icmp-retries'' variable can be set to an integer value which
! instructs the client on how many times it should retry an ICMP
! operation. This affects operations such as router latency discovery,
! ICMP netmask discovery etc.
  
  @example
***************
*** 296,305 ****
  @end example
  
! @item
! default-interface-mtu: the ``default-interface-mtu'' variable can be
! set to an integer value which instructs the client on what it's
! default interface MTU should be. This MTU is used during the initial
! DHCP discovery messages, and later used to configure the interface MTU
! if no MTU was specified by the DHCP server.
  
  @example
--- 320,332 ----
  @end example
  
! @end defvr
! 
! @defvr {Client Configuration Variable} default-interface-mtu
! 
! The ``default-interface-mtu'' variable can be set to an integer value
! which instructs the client on what it's default interface MTU should
! be. This MTU is used during the initial DHCP discovery messages, and
! later used to configure the interface MTU if no MTU was specified by
! the DHCP server.
  
  @example
***************
*** 307,315 ****
  @end example
  
! @item
! default-subnet-mask: the ``default-subnet-mask'' variable can be set
! to a netmask value to specify a default subnet mask in case none is
! provided by the DHCP operation. Unlike the ``override'' directive this
! provides a fallback in case no subnet-mask is provided by the server.
  
  @example
--- 334,345 ----
  @end example
  
! @end defvr
! 
! @defvr {Client Configuration Variable} default-subnet-mask
! 
! The ``default-subnet-mask'' variable can be set to a netmask value to
! specify a default subnet mask in case none is provided by the DHCP
! operation. Unlike the ``override'' directive this provides a fallback
! in case no subnet-mask is provided by the server.
  
  @example
***************
*** 317,328 ****
  @end example
  
! @item
! do-measure-router-latency: the ``do-measure-router-latency'' variable
! can be set to a boolean value to indicate whether or not the client
! should attempt to send ICMP ECHO requests to routers passed by the
! DHCP server and determine which is one has the least latency to become
! the default route. Disabling this variable stops this operation from
! taking place, and the first router is used as the default route. This
! is useful if the routers cannot be reached by ICMP ECHO requests.
  
  @example
--- 347,361 ----
  @end example
  
! @end defvr
! 
! @defvr {Client Configuration Variable} do-measure-router-latency
! 
! The ``do-measure-router-latency'' variable can be set to a boolean
! value to indicate whether or not the client should attempt to send
! ICMP ECHO requests to routers passed by the DHCP server and determine
! which is one has the least latency to become the default
! route. Disabling this variable stops this operation from taking place,
! and the first router is used as the default route. This is useful if
! the routers cannot be reached by ICMP ECHO requests.
  
  @example
***************
*** 330,334 ****
  @end example
  
! @end itemize
  
  @section Writing Client Extensions
--- 363,367 ----
  @end example
  
! @end defvr
  
  @section Writing Client Extensions
***************
*** 342,344 ****
  
  [ TODO ]
- 
--- 375,376 ----