blob: dd992949ade858baa4210da0abf36adccb943fec [file] [log] [blame]
Russ Dill61fb4892002-10-14 21:41:28 +00001udhcp server/client package readme
2-------------------------
3
4The udhcp server/client package is primarily geared towards embedded
5systems. It does however, strive to be fully functional, and RFC
6compliant.
7
Russ Dill61fb4892002-10-14 21:41:28 +00008
9compile time options
10-------------------
11
12The Makefile contains three of the compile time options:
Eric Andersenc7bda1c2004-03-15 08:29:22 +000013
Russ Dill4e864a32003-12-18 22:25:38 +000014 UDHCP_DEBUG: If UDHCP_DEBUG is defined, udhcpd will output extra
15 debugging output, compile with -g, and not fork to the background when
16 run.
17 UDHCP_SYSLOG: If UDHCP_SYSLOG is defined, udhcpd will log all its
18 messages syslog, otherwise, it will attempt to log them to stdout.
Eric Andersenc7bda1c2004-03-15 08:29:22 +000019
Russ Dill61fb4892002-10-14 21:41:28 +000020 COMBINED_BINARY: If COMBINED_BINARY is define, one binary, udhcpd,
21 is created. If called as udhcpd, the dhcp server will be started.
22 If called as udhcpc, the dhcp client will be started.
Eric Andersenc7bda1c2004-03-15 08:29:22 +000023
Russ Dill4e864a32003-12-18 22:25:38 +000024dhcpd.h contains the other three compile time options:
Eric Andersenc7bda1c2004-03-15 08:29:22 +000025
Russ Dill61fb4892002-10-14 21:41:28 +000026 LEASE_TIME: The default lease time if not specified in the config
27 file.
Russ Dill4e864a32003-12-18 22:25:38 +000028
29 LEASES_FILE: The default file for storing leases.
Eric Andersenc7bda1c2004-03-15 08:29:22 +000030
Russ Dill61fb4892002-10-14 21:41:28 +000031 DHCPD_CONFIG_FILE: The defualt config file to use.
Eric Andersenc7bda1c2004-03-15 08:29:22 +000032
Russ Dill61fb4892002-10-14 21:41:28 +000033options.c contains a set of dhcp options for the client:
34
35 name[10]: The name of the option as it will appear in scripts
Eric Andersenc7bda1c2004-03-15 08:29:22 +000036
Russ Dill61fb4892002-10-14 21:41:28 +000037 flags: The type of option, as well as if it will be requested
38 by the client (OPTION_REQ)
39
40 code: The DHCP code for this option
41
Russ Dillf5ecd432002-10-31 19:21:27 +000042
Russ Dill61fb4892002-10-14 21:41:28 +000043busybox drop-in
44--------------
45udhcp is now a drop-in component for busybox (http://busybox.net).
46To update busybox to the latest revision, simply do a:
47
Eric Andersenc7bda1c2004-03-15 08:29:22 +000048cp *.[ch] README AUTHORS COPYING ChangeLog TODO \
Russ Dill61fb4892002-10-14 21:41:28 +000049 <busybox_source>/networking/udhcp
50
51The only two files udhcp does not provide are config.in and
52Makefile.in, so these may need to be updated from time to time.
Russ Dillf5ecd432002-10-31 19:21:27 +000053