| blob | b2a01938db793518add1e70f650bb9e6fe1a6971 |
1 .\" $KAME: dhcp6c.8,v 1.36 2005/03/17 05:27:01 suz Exp $
2 .\"
3 .\" Copyright (C) 1998 and 1999 WIDE Project.
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the project nor the names of its contributors
15 .\" may be used to endorse or promote products derived from this software
16 .\" without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .Dd Sep 12, 1999
31 .Dt DHCP6C 8
32 .Os KAME
33 .Sh NAME
34 .Nm dhcp6c
35 .Nd DHCPv6 client daemon
36 .\"
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl c Ar configfile
40 .Op Fl Ddfi
41 .Op Fl T Ar LL|LLT
42 .Op Fl p Ar pid-file
43 .Ar interface
44 .Op Ar interfaces...
45 .\"
46 .Sh DESCRIPTION
47 .Nm
48 works as a DHCPv6 client and gets information from DHCPv6 servers
49 to configure the specified
50 .Ar interface .
51 Multiple
52 .Ar interfaces
53 can be specified separated by spaces or tabs,
54 in which case
55 .Nm
56 will work on all the interfaces simultaneously.
57 .Pp
58 The command line options are:
59 .Bl -tag -width indent
60 .\"
61 .It Fl c Ar configfile
62 Use
63 .Ar configfile
64 as the configuration file.
65 .It Fl d
66 Print debugging messages.
67 .It Fl D
68 Even more debugging information is printed.
69 .It Fl f
70 Foreground mode (useful when debugging).
71 Although
72 .Nm
73 usually prints warning, debugging, or error messages to
74 .Xr syslog 8 ,
75 it prints the messages to standard error if this option is
76 specified.
77 .It Fl i
78 Info-req mode. In this mode, stateless DHCPv6 is executed with the folllowing configuration, and the obtained info is written to stdout. After this output,
79 .Nm
80 is terminated. (suits for a use in shell-script etc).
81 .Bd -literal -offset
82 interface (interface given in the argument) {
83 information-only;
84 script (a script which displays the received information to stdout);
85 };
86 .Ed
87 .Pp
88 Since the configuration is internally generated, you cannot provide a configuration in this mode. If you want to have different actions for the stateless DHCPv6 information, you should write an appropriate configuration and invoke
89 .Nm
90 without this option.
91 .It Fl T Ar LL|LLT
92 Use
93 .Ar LL
94 or
95 .Ar LLT
96 to override default(LLT) DUID type generation
97 .It Fl p Ar pid-file
98 Use
99 .Ar pid-file
100 to dump the process ID of
101 .Nm .
102 .El
103 .Pp
104 The program will daemonize itself on invocation unless the
105 .Fl f
106 or
107 .Fl i
108 option is specified.
109 .Pp
110 Upon receipt of the
111 .Dv SIGHUP
112 or
113 .Dv SIGTERM
114 signals,
115 .Nm
116 will remove all stateful resources from the system.
117 In the former case the daemon will then reinvoke itself,
118 while it will stop running in the latter case.
119 In either case,
120 .Nm
121 will send DHCPv6 Release messages to release resources assigned from servers.
122 .\"
123 .Sh FILES
124 .Bl -tag -width /usr/local/etc/dhcp6c.conf -compact
125 .It Pa /var/run/dhcp6c.pid
126 is the default file that contains pid of the currently running
127 .Nm dhcp6c .
128 .It Pa /usr/local/etc/dhcp6c.conf
129 is the default configuration file.
130 .It Pa /var/db/dhcp6c_duid
131 is the file to store the client's DUID.
132 .El
133 .Sh Configuration Script
134 When
135 .Nm
136 receives a reply message,
137 it will invoke a supplementary configuration script specified in the
138 .Xr dhcp6c.conf 5
139 file.
140 The daemon will provide the script with configuration parameters as
141 environment variables,
142 which include:
143 .Pp
144 .Bl -tag -width Ds -compact
145 .It Ic REASON
146 The reason why the script is invoked.
147 As of this writing,
148 the value is always
149 \(dqNBI\(dq
150 and thus meaningless.
151 .It Ic new_domain_name_servers
152 A list of available DNS servers,
153 each of which is an IPv6 numeric address and is separated by a white
154 space character.
155 .It Ic new_domain_name
156 A list of DNS names,
157 which provides DNS name search path.
158 .It Ic new_ntp_servers
159 A list of available NTP servers,
160 each of which is an IPv6 numeric address and is separated by a white
161 space character.
162 .It Ic new_sip_servers
163 A list of available SIP server addresses,
164 each of which is an IPv6 numeric address and is separated by a white
165 space character.
166 .It Ic new_sip_name
167 A list of SIP server domain names.
168 .It Ic new_nis_servers
169 A list of available NIS server addresses,
170 each of which is an IPv6 numeric address and is separated by a white
171 space character.
172 .It Ic new_nis_name
173 A list of NIS domain names.
174 .It Ic new_nisp_servers
175 A list of available NIS+ server addresses,
176 each of which is an IPv6 numeric address and is separated by a white
177 space character.
178 .It Ic new_nisp_name
179 A list of NIS+ domain names.
180 .It Ic new_bcmcs_servers
181 A list of available BCMCS server addresses,
182 each of which is an IPv6 numeric address and is separated by a white
183 space character.
184 .It Ic new_bcmcs_name
185 A list of BCMCS server domain names.
186 .El
187 .Pp
188 Note that the daemon does not always provide all the parameters.
189 It sets an environment variable only when the corresponding
190 configuration parameter is provided by the DHCPv6 server.
191 .\"
192 .Sh SEE ALSO
193 .Xr daemon 3 ,
194 .Xr dhcp6c.conf 5 ,
195 .Xr dhcp6s 8
196 .Rs
197 .%A Ralph Droms, Editor
198 .%D 2003
199 .%T Dynamic Host Configuration Protocol for IPv6 (DHCPv6)
200 .%R RFC 3315
201 .Re
202 .\"
203 .Sh HISTORY
204 The
205 .Nm
206 command first appeared in WIDE/KAME IPv6 protocol stack kit.
207 .\"
208 .Sh BUGS
209 .Nm
210 is incomplete and violates DHCPv6 protocol spec, in several aspects.
211 In particular, temporary address assignment is intentionally omitted.
212 .Pp
213 Information Refresh Time Option is not recognied in Info-req mode, since
214 .Nm
215 terminates after it receives a REPLY message.