Sync usage with man page.
[netbsd-mini2440.git] / external / bsd / dhcpcd / dist / README
blob27254697cd58ec50fa607476d92c0cf73e6967ed
1 dhcpcd - DHCP client daemon
2 Copyright (c) 2006-2009 Roy Marples <roy@marples.name>
5 Installation
6 ------------
7 Then just make; make install
8 man dhcpcd for command line options
9 man dhcpcd.conf for configuration options
10 man dhcpcd-run-hooks to learn how to hook scripts into dhcpcd events
13 Notes
14 -----
15 If you're cross compiling you may need to set the below knobs to avoid
16 automatic tests.
17 OS=BSD | Linux
19 If you're building for an MMU-less system where fork() does not work, you
20 should add -DTHERE_IS_NO_FORK to your CPPFLAGS.
21 This also puts the --no-background flag on and stops the --background flag
22 from working.
24 You can change the default dir with these knobs.
25 For example, to satisfy FHS compliance you would do this:-
26 LIBEXECDIR=/lib/dhcpcd
27 DBDIR=/var/lib/dhcpcd
29 We now default to using -std=c99. For 64-bit linux, this always works, but
30 for 32-bit linux it requires either gnu99 or a patch to asm/types.h.
31 Most distros patch linux headers so this should work fine.
32 linux-2.6.24 finally ships with a working 32-bit header.
33 If your linux headers are older, or your distro hasn't patched them you can
34 set CSTD=gnu99 to work around this.
36 Some BSD systems do not allow the manipulation of automatically added subnet
37 routes. You can find discussion here:
38     http://mail-index.netbsd.org/tech-net/2008/12/03/msg000896.html
39 BSD systems where this has been fixed are:
40     NetBSD-5.0
43 Hooks
44 -----
45 Not all the hooks in dhcpcd-hooks are installed by default.
46 By default we install 01-test, 10-mtu, 20-resolv.conf,
47 29-lookup-hostname and 30-hostname.
48 The default dhcpcd.conf does disable the lookup-hostname hook by default.
49 To add more simply add them in the HOOKSCRIPTS variable.
50 make HOOKSCRIPTS=50-ntp install
53 Compatibility
54 -------------
55 dhcpcd-5.0 is only fully command line compatible with dhcpcd-4.0
56 For compatibility with older versions, use dhcpcd-4.0
58 dhcpcd no longer sends a default ClientID for ethernet interfaces.
59 This is so we can re-use the address the kernel DHCP client found.
60 To retain the old behaviour of sending a default ClientID based on the
61 hardware address for interface, simply add the keyword clientid to dhcpcd.conf.
64 ChangeLog
65 ---------
66 We no longer supply a ChangeLog.
67 However, you're more than welcome to read the commit log at
68 http://roy.marples.name/projects/dhcpcd/log/